• Register

API Notes


Content Types

All endpoints return their response in different formats depending on the HTTP Accept header passed at the point of HTTP request. The API currently supports the content types detailed below:

Accept
Content-Type
Description
application/xml
XML
The response will be in XML format.
application/json
JSON
The response will be in JSON format.



Response Codes

Endpoints also return different HTTP response codes depending on the status of the request The API currently returns the following response HTTP response codes:

Response Code
Type
Description
200
Success
The request was successful.
204
Warning
No content available.
400
Warning
Bad request, please check request parameters.
403 
Warning
The service or key is currently over allowed Queries per Second. Please retry again in 1 second.
404
Warning
Requested resource could not be found.
405
Warning
The operation requested is not available on that endpoint (e.g. DELETE on a GET only endpoint).
500
Error
An internal server error occurred.

Docs Navigation