Get request's status | Documentation | IP Geolocation Bulk API | WhoisXML API

Get request's status

POST https://ip-geolocation.whoisxmlapi.com/api/bgservice/request/status

CURL request sample

curl https://ip-geolocation.whoisxmlapi.com/api/bgservice/request/status -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "ids": [622], "format": "json"}'

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "ids": [544, 595, 596],
    "format": "json"
}

Input parameters

apiKey

Required. Get your personal API KEY on My products page.

ids

Required. Array.

Required requests' IDs.

format

Optional. String.

Used to specify the response format.

Allowed values: "xml", "json", "csv".

Default value: "json".

Sample output

{
    "response": [
        {
            "id": 544,
            "date_start": "1528204702",
            "total_terms": 500,
            "invalid_terms": 0,
            "processed_terms": 500,
            "failed_terms": 0,
            "ready": 1
        },
        {
            "id": 595,
            "date_start": "1528377227",
            "total_terms": 20,
            "invalid_terms": 0,
            "processed_terms": 20,
            "failed_terms": 0,
            "ready": 1
        },
        {
            "id": 596,
            "date_start": "1528377253",
            "total_terms": 3,
            "invalid_terms": 0,
            "processed_terms": 3,
            "failed_terms": 0,
            "ready": 1
        }
    ]
}

Code: 200 OK.
response

The response object.

Contains an array of user's requests' info on success. This array can be empty in case the 'ids' array contains non-existing ids only.

In case of an error it contains its description in the 'error' field. If there are multiple errors their descriptions are returned in the 'errors' array.

Have questions?

We are here to listen. For a quick response, please select your request type or check our Contact us page for more information. By submitting a request, you agree to our Terms of Service and Privacy Policy.

Or shoot us an email to