Skip to main content
POST
Lookup Batch

Authorizations

apiKey
string
query
required

Your API key, passed as the apiKey query parameter on every request. A key sent in a header (Authorization or X-API-Key) is not accepted and gets 401.

Body

application/json
ips
string[]
required

Response

Successful Response

Batch lookup results. Starter and up. results holds one row per distinct IP string in the request, in the order each first appears; an exact repeat is looked up once.

results
(IpLookupResponse · object | BatchRowError · object)[]
required

One row per distinct IP string: a lookup result, or a BatchRowError for an IP that could not be looked up.

The result of one IP lookup. Every key listed here is returned on every plan unless its description says otherwise. Most fields above your plan stay in the response with null, or false for the two residential proxy sub-flags; the few that are left out instead say so in their descriptions. Gate on your plan rather than on whether a key is present. x-min-plan names the lowest plan that fills each field. intro means every plan; the free sign-up lookups get the same fields as Intro. The API covers IPv4 today. IPv6 addresses are accepted but currently return little or no classification. The API refreshes once a day.

credits_charged
integer
required

Credits charged for this request: one per distinct IP looked up. Rows with error are free. One address sent in two spellings (8.8.8.8 and ::ffff:8.8.8.8) gets two rows but is one IP, so it costs one credit. 0 when nothing is charged, as when every row has error.

Required range: x >= 0