API Details

The API was developed using RESTful principles, and returns JSON responses by default. See Common API Parameters for options to change the output.

For case-sensitivity rules, see API Case Sensitivity.

The API also uses common approaches for the following:

DataAPI data is JSON encoded with UTF-8. API JSON is either a single object or a list of objects.
AuthenticationAccess control using API Key in the header.
Errors4xx and 5xx responses returning JSON with error messages. See HTTP Status Codes for details.
Rate LimitingControls how many requests can be made in a time window
HTTP/HTTPSMethods are used in accordance with HTTP (GET, POST and DELETE are the primary methods used) and resources are identified using URIs. All API requests are sent over HTTPS.