Get a list of your requests | Documentation | IP Geolocation Bulk API | WhoisXML API

Get a list of your requests

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

CURL request sample

curl https://ip-geolocation.whoisxmlapi.com/api/bgservice/request/list -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "page": 1, "onlyIds": false, "perPage": 10, "sort": "desc", "format": "json"}'

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "page": 1,
    "format": "json",
    "onlyIds": false,
    "perPage": 10,
    "sort": "desc"
}

Input parameters

apiKey

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

page

Optional. Integer.

Used to paginate the result sets in conjunction with 'perPage'.

Default value: 1.

onlyIds

Optional. Boolean.

When it's true only the list of IDs is returned.

Default value: true.

perPage

Optional. Integer.

Limits each page of the result-set to this number of requests.

Min: 10; Max: 50.

Default value: 10

sort

Optional. String.

Specify the order of requests in the response.

Allowed values: "asc", "desc".

Default value: "desc".

format

Optional. String.

Used to specify the response format.

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

Default value: "json".

Sample output

{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596
            },
            {
                "id": 595
            },
            {
                "id": 544
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.
{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596,
                "date_start": "1528377253",
                "total_terms": 3,
                "invalid_terms": 0,
                "processed_terms": 3,
                "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": 544,
                "date_start": "1528204702",
                "total_terms": 500,
                "invalid_terms": 0,
                "processed_terms": 500,
                "failed_terms": 0,
                "ready": 1
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.

Input parameters

response

The response object.

Contains the 'data' field with an array of user's requests' data on success.

The 'from' and 'to' fields represent the result set's ID range of the requests returned for the current page.

'per_page' is the pages' size and 'total' is the number of requests in the result set.

The 'current_page' and 'last_page' correspond to the number of pages in the result set.

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.

data

Array.

A list of your requests' info elements (if 'onlyIds' is true, each element has only the 'id' field).

data[k].id

The response object.

Request ID.

data[k].date_start

String.

String representation of the request's start Unix timestamp.

data[k].total_terms

Integer.

The total of number of terms (IPs, emails, domain names) in the request.

data[k].invalid_terms

Integer.

Number of invalid terms.

data[k].processed_terms

Integer.

Number of already processed terms.

data[k].failed_terms

Integer.

Number of terms that could not be processed.

data[k].ready

Integer.

1 if processing has finished, 0 – otherwise.

from

Integer.

Min. request ID in the current page of the data set.

to

Integer.

Max. request ID in the current page of the data set.

per_page

Integer.

Max. number of requests for each page of the result set.

total

Integer.

The total number of requests in the result set.

current_page

Integer.

Current page number in the result set.

last_page

Integer.

The number of the last page in the set.

error

String.

Error description.

errors

Array.

Multiple error messages.

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