Overview
The National Centers for Environmental Information (NCEI) Common Access Order Service provides a RESTful application programming interface (API) to retrieve information about previous orders based on a set of parameters to the /v1 or /v1/airs URLs, respectively. The NCEI Common Access Support Service is only available via HTTP Strict Transport Security (HSTS) following Federal government policy. Requests use HTTP 1.1 GET request and results are formatted as JavaScript Object Notation (JSON) that contains a results array property.
Orders Endpoint
https://www.ncei.noaa.gov/access/services/orders/v1
- Parameters: {email}, {limit}, {offset}
The email parameter is required, while the limit and offset are not. Limit and offset parameters can be used for paginated resultsets. The limit parameter sets the number of orders per page. The offset parameter delegates the starting point of the orders resultset.
Note: All orders are returned if no limit or offset is specified.
-
Example URL with email, limit and offset parameters: https://www.ncei.noaa.gov/access/services/orders/v1?email=john.smith@noaa.gov&limit=5&offset=0