Errors
Ipregistry uses conventional HTTP response codes to indicate the success or failure of an API request.
In general, codes in the 2xx
range indicate success. Codes in the 4xx
range indicate an error that failed given the information provided (e.g. a required parameter was omitted or an invalid value was passed). Codes in the 5xx
range indicate an error with Ipregistry's servers (these are rare).
To ease debugging, quickly identify issues but also to facilitate programmatic handling, all errors include an Ipregistry error code, a message that describes the problem, and a resolution field that gives guidance about how to fix the error. Below is an example in JSON:
{
code: "MISSING_API_KEY",
message: "You have not supplied an API key.",
resolution: "Add your API key as a query parameter: https://api.ipregistry.co/?key=YOUR_API_KEY"
}
Here is an exhaustive list of all error codes:
Error Code | HTTP Status | Description |
---|---|---|
BAD_REQUEST | 400 | You specified an invalid request payload, for instance with our batch endpoints. Check out endpoints examples. |
DISABLED_API_KEY | 451 | Your API key is disabled. This may be caused by your account email that has not been verified after multiple recalls or usage against our terms is made. |
FORBIDDEN_IP | 403 | IP filtering is enabled for the API key in use and the user request is from an IP that you did not whitelist. |
FORBIDDEN_ORIGIN | 403 | Origin filtering is enabled for the API key in use and the request origin is from an origin that does not match the ones you allowed. |
FORBIDDEN_IP_ORIGIN | 403 | IP and origin filtering are enabled for the API key in use and the user request is not matching what you allowed. |
INTERNAL | 500 | An unexpected error has occurred on Ipregistry servers. Please check your request and retry again. Contact us if the issue persists. |
INSUFFICIENT_CREDITS | 402 | You need to buy credits to continue using the service (we send up to 3 email alerts before you run out of credits). |
INVALID_API_KEY | 403 | Your API key is invalid. Make sure you are using the right key or check its value for a typo. |
INVALID_ASN | 400 | The Autonomous System Number you entered is in the wrong format. It should begin with AS followed by a number, like AS173. |
INVALID_FILTER_SYNTAX | 400 | The filter pattern you entered to select a subset of fields is invalid. Decompose your filter into smaller parts and test them incrementally. |
INVALID_IP_ADDRESS | 400 | The IP address that was searched is not a valid IPv4 or IPv6 address. |
MISSING_API_KEY | 401 | You did not specify an API key. Learn more about authentication. |
RESERVED_ASN | 400 | You attempted to search for a private ASN. These ASNs are not visible on the global Internet. Please try with a public ASN instead |
RESERVED_IP_ADDRESS | 400 | The IP address that was searched is a reserved address (loopback, link-local, multicast, private, site-local or wildcard IP address). Such IP addresses cannot be used to deduce geolocation information. |
TOO_MANY_ASNS | 400 | You've submitted a batch request with too many Autonomous System Numbers (ASNs). Ensure your batch request includes no more than 16 ASNs. Please reduce the number of ASNs and try again. |
TOO_MANY_IPS | 400 | You made a batch request with too many IP addresses. Batch requests must not contain more than 1024 IP addresses. Input less IP addresses. |
TOO_MANY_REQUESTS | 429 | Rate limiting was enabled for the API key in use and too many requests were made for the window you configured. Decrease your invocation rate or change your settings from the Ipregistry dashboard. |
TOO_MANY_USER_AGENTS | 429 | You have specified too many user agents with the batch endpoint. Batch requests must not contain more than 256 user agents. Input fewer user agents. |
UNKNOWN_ASN | 404 | No Autonomous System is currently announcing the specified IP address or IP prefix. This can happen with the Origin AS endpoint. |