Skip to content

Downloader API

API Link

OpenAPI Documentation

This is the same API used for the Data Downloader Website.

It's built with OpenAPI, so the documentaion for the endpoints is the automaically generated from the OpenAPI spec. Only thing worth noting is how authentication is handled.

Authentication

  • To obtain the access token, send the username and password in the body of the request to the token endpoint /token.
  • The login endpoint returns an access token.

  • Take the access token from the response and put it in the Authorization header with Bearer prefix.

    Example :
    Authorization: Bearer your_access_token

  • Send all the requests with the access token in the Authorization header.

Endpoints

  • /token : Obtains an authentication token required for subsequent API calls.
  • /index: Provides information about the user if their token is valid.
  • /sensors_data: Retrieves all the organizations, projects and sensors the user has access to.
  • /submit_request: Submits a download request for sensor data by providing the organization ID, project ID, sensor IDs, start date, and end date for as many sensors as user wants.
  • /jobs: Retrieves a list of submitted download jobs, including their status, creation time, and other relevant information.
  • /jobs/{job_id}: Retrieves details about a specific download job by providing its unique identifier (job ID).