RISE API Documentation

About the RISE API

What is an API? An Application Programming Interface (API) allows applications to talk to one another. This API allows users to query RISE data programmatically and return a JavaScript Object Notation (JSON) object.

What kinds of data can be obtained from the API? For Geospatial and File Upload datasets, only the metadata (the descriptive information about each dataset) can be queried from the API. For time series datasets, both the metadata and data can be queried.

What format will the data be returned in? API queries will return data in JavaScript Object Notation (JSON) format, using the JSON:API specification. Documentation of the JSON:API specification is available at https://jsonapi.org/.

How do I use this API? There are two ways to perform API queries: manually or programmatically. To perform a manual query, click the “Try it Out” button below a resource name. Enter values next to one or more parameters, or leave all parameters blank to query all data. Click the “Execute” button. Scroll down to the “Server response” section to view the response. Click the “Download” button near the lower right corner to download the response as a JSON file.

By default, the first 25 results will be returned. Use the itemsPerPage parameter to change the number of results returned per page, and the page parameter to change which page of results is returned.

After executing a manual query, the Request URL can be viewed in the Responses section. To perform a query programmatically, send a GET request to the Request URL. The GET request must include the following header:

accept: application/vnd.api+json

The syntax for sending a request using the Curl program is included in the Curl section. There are many other methods for sending requests programmatically, such as using the Requests library in Python or the Fetch API in JavaScript.

API Documentation and Testing

Available formats: jsonapi html
Other API docs: ReDoc GraphiQL