Error Codes
Learn more about error codes and how to resolve them.
Geolocated.io's API communicates the outcome of your requests using standard HTTP response codes. These codes are designed to inform you immediately about the success or failure of your API call.
- 2xx Codes signify successful requests. For example, a 200 OK response indicates the operation was successful, and the requested data is included in the response payload.
- 4xx Codes highlight errors caused by the request sent from the client side. These errors can stem from various issues, such as incomplete or incorrect data provided in the request. Here are common scenarios:
- A 400 Bad Request error may indicate a missing required parameter.
- A 404 Not Found error suggests that the requested API endpoint does not exist.
- 5xx Codes indicate problems on the server side, meaning the issue lies with Geolocated.io's infrastructure. While these occurrences are uncommon, they are not impossible. A 500 Internal Server Error, for instance, signals a broad server-side issue that needs addressing by our team.
In addition to the HTTP response codes, our APIs provide specific error codes within the response body to offer clearer insights into the nature of the issue encountered. Each error code is a concise string accompanied by a brief explanation. This approach allows you to quickly identify the root cause of an error and take the necessary steps to address it. The following is a comprehensive list of potential error codes you may encounter, complete with detailed information for each.
| Status | Error Code | Description |
|---|---|---|
| 400 | invalid_ip_address | The IP address provided is not in a valid IPv4 or IPv6 format. Ensure the IP address adheres to standard formatting. |
| 400 | invalid_batch_request_format | The batch request does not conform to the expected JSON array format. Ensure the input consists of a valid JSON array of IP addresses. |
| 400 | too_many_ips | The batch request contains more than the permissible limit of 25 IP addresses. Reduce the number of IPs in the request and try again. |
| 401 | missing_api_key | The required api-key query parameter is absent in the request. Include this parameter with a valid API key for authentication. |
| 401 | invalid_api_key | The provided api-key does not match any existing user account. Check the API key for any inaccuracies or consult the account dashboard. |
| 403 | no_subscription | There is no active subscription associated with the provided credentials. An active subscription plan is required to access the API's features. |
| 403 | subscription_expired | The subscription to Geolocated.io has expired. Renewal or purchase of a new subscription is required for continued service access. |
| 403 | origin_not_allowed | The origin of the preflight request is not part of the approved CORS domain list. Ensure the request is being made from an authorized domain or update the domain list if necessary. |
| 403 | feature_not_available | The specific endpoint or the module is not available under current subscription level. |
| 404 | no_such_api_exists | The requested API endpoint is either invalid or does not exist. Verify the endpoint's path and check the documentation for available endpoints. |
| 429 | rate_limit_exceeded | The allowable request frequency per minute for the current subscription level has been surpassed. |
| 429 | daily_limit_exceeded | The daily allowance of requests for the current subscription level has been exhausted. |
| 500 | unexpected_api_server_error | Suggests a temporary problem within our server infrastructure or an unforeseen error in handling your request. We recommend retrying your request after some time. |