These are the headers sent by the API to your client when a request has been completed. Not listed are the normal headers sent by the webserver such as Content-Length, Cache-Control, etc. For explanations of these headers please look up the HTTP specification for each.
Hourly-Access-Key-Usage Shows the number of API accesses made by the current accesskey within the last hour. This value can be useful in making sure your systems do not go over the hourly access limit.
Api-Version Shows the version number of the API that responded. This can be useful when used in conjunction with the version response header to insure your request was processed by the version requested.
Status codes are returned with every API call. They can quickly tell you if the call was a success or was in error.
All status codes currently returned by the API:
- 200 – OK
- 204 – OK, nothing returned. This is most common for DELETE requests.
- 400 – Required parameter missing or invalid.
- 401 – accesskey not valid or revoked.
- 403 – IP blocked
- 403.4 – URL provided is not using SSL (HTTPS).
- 404 – Invalid API component specified.
- 405 – Method requested is invalid. This usually indicates a typo or that you may be requested a method that is part of a different API component.
- 406 – accesskey not provided
- 409 – Duplicate unique data detected.
- 412 – Account is over it’s hourly access limit.
- 413 – Requested entity too large.
- 416 – Requested time range not satisfiable.
- 417 – There are more saved links in the account than allowed through the API.
- 500 – General system error. Please try again later or contact IDX support.
- 503 – Scheduled or emergency API maintenance will result in 503 errors.
- 521 – Temporary error. There is a possibility that not all API methods are affected.