API Reference

Using the ReadMe Interface for API Requests

What you’ll need: your API Key, optionally additional information

Using your public API key, you can form and make API requests to our various endpoints through this site (e.g. the /stations endpoint). You can use this interface directly to make requests, or to form the code necessary to make the request you want which can then be copied directly into your workflow or codebase.

To use the readme interface to access the API:

  1. Navigate to one of the API endpoint pages, e.g. the /stations endpoint page
  2. Enter your API key in the box under ‘Credentials’ labeled ‘Header’
    enter your api key in the header box
  3. Enter any other required information or tune the query parameters
    additional options in the query params section
  4. Click on the 'Try It!' button to send the request
    click the try it button
  5. The ‘Response’ section will show you the response data from your request
    returned data will be in the response section
  6. The example request can be easily copied from this page and pasted into your code or your shell terminal
    you can copy the curl request into a shell terminal
  7. You can also get an example request in a variety of formats by selecting a ‘Language’ for ease of integrating this API request into your code
    change the language of the request to copy into your code
  8. Please reach out to [email protected] to request permission for the station(s) you want to access