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:
Function | Description |
---|---|
Data | API data is JSON encoded with UTF-8. API JSON is either a single object or a list of objects. |
Authentication | Access control using API Key in the header. |
Errors | 4xx and 5xx responses returning JSON with error messages. See HTTP Status Codes for details. |
Rate Limiting | Controls how many requests can be made in a time window |
HTTP/HTTPS | Methods 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. |