Access Order Service

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 Order Service is only available via HTTP Strict Transport Security ( HSTS specification ) following Federal government HTTPS policy . Requests use HTTP 1.1 GET method specification request and results are formatted as JavaScript Object Notation ( JSON specification ) that contains a results array property.

Orders Endpoint

The NCEI Common Access Order Service queries are directed to the endpoint at the following URL:

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.

Below is a full URL example of an API request to the NCEI Common Access Order Service. The URLs include the request endpoint and the email, limit, and offset endpoint parameters: