Major improvements to our API ergonomics (August 2023)

July 14, 2023
Title picture for Major improvements to our API ergonomics (August 2023)

In our ongoing mission to enhance your user experience, we're introducing changes to our APIs that will break compatibility. These will take effect on August 10, 2023, at 5 PM EST. We strongly recommend that you update to the latest version of our APIs or client libraries to support these changes.

We're making changes to our HTTP POST endpoints to improve our API standardization and address limitations with query parameters' maximum length. From now on, all HTTP POST endpoints will expect form-encoded data by default, replacing the previous support for both query parameters and form-encoded data.

The following updates will be implemented:

  • The recommended method for the timeseries.get_range endpoint will transition to POST. We will still support the GET version of the endpoint.
  • The primary method for the symbology.resolve endpoint will transition to POST. We will still support the GET version of the endpoint.
  • Our client libraries will use the POST versions of endpoints where available. The batch.submit_job endpoint will now require form-encoded data. ‍

We're altering the following three metadata endpoints and their corresponding client library methods:


These modifications will standardize parameter behavior and change the structure of responses from objects to ordered lists, resulting in more predictable and user-friendly endpoints.

The current metadata.json file associated with batch jobs has a symbology section that duplicates the information found in the symbology.json file. To minimize redundancy and reduce the size of batch downloads, we will be removing the symbology section of the metadata.json file.

Note that the symbology.json file contains the exact response you can obtain by querying the symbology.resolve endpoint with the same parameters.

We understand that making these changes may require you to modify your code. However, we believe that these updates will improve your experience with our data, APIs, and services. If you have any questions or need assistance, please contact support.