DataPress logo
API Reference

Introduction

Version:  4.0
Updated:  14th July 2024

The DataPress API

DataPress' API is an interface for reading and updating the data catalogue using JSON.

1. Analysing the Catalogue

For read-only use, refer to the Export API. No API key authentication is required.
This provides a full overview of datasets and uploaded files as:

2. Updating the Catalogue

If you're an editor on your site, you'll need an API key to authorise requests. Log in to your site and go to the My Account page:

GET
https://data.website/manage/my-account
  • The API key is a UUID passed in the Authorization header.
  • An optional Bearer prefix is accepted. Do not use other prefixes such as "Token".
  • Your API key carries the same permissions as your user account. Use the whoami endpoint to check what you can access.

Internally, all datasets are stored as JSON documents. They can be queried and updated using standard GET, POST, PATCH and DELETE semantics.