Skip to main content
GET
Bulk IP lookup

Authentication

Include your API key in the Authorization header:
API v2 accepts the key only in this header, not in query parameters or request bodies. See Authentication.

Query parameters

string
required
The ips command is used to specify the IP addresses you want to look up.Expected values: comma separated IP addresses (IPv4 or IPv6). The raw query value is limited to 159 characters. Duplicate and invalid entries are skipped; at least one valid IP is required.Sample value: 1.1.1.1,2.2.2.2
string
The params command can be used to specify optional response modules. Basic ip and geo fields are always included.Recognized module names: security, currency, timezone, location, and/or device.Unrecognized tokens are accepted but do not add modules.Sample value: security,timezone,currencyFor more information please refer to Customize response modules.
string
default:"EN"
The lang command is used to get a response in a specific language.Expected values: EN, AR, DE, FR, ES, JA, ZH, or RUFor more information please refer to Localization.
string
The callback command can help you make the response a JSONP format.Expected values: any name that can be used as a function name in Javascript, e.g: myFunctionName.For more information please refer to JSONP callback.
string
Optional amount string used by usage and rate-limit gates.
string
default:"JSON"
The format command is used to get a response in a specific format.Expected values: JSON, XML, CSV, or NewlineFor more information please refer to Response format.
string
default:"live"
The mode command is used in the development stage to simulate the integration process before releasing it to the production environment.Expected values: live, or test.For more information please refer to Development environment.
string
Optional label for your own analytics or support correlation (for example a product or channel name).
string
The user_id command can be used to identify requests sent by specific users to monitor in the Events page.Expected values: email address, phone number, user id, name, etc.For more information please refer to User identifier.

Response properties

boolean
required
true when the request succeeded; false on error.
object
required
Map of IP address strings to lookup results. Each key is one address from the ips query (for example 1.1.1.1). Invalid or duplicate entries in ips are omitted.
integer
required
Time taken to process the request (milliseconds).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ips
string
required

Comma-separated IPv4 or IPv6 addresses (max 159 characters raw). Duplicates and invalid entries are skipped; at least one valid IP required.

params
string

Optional modules: security, currency, timezone, location, device. Basic ip and geo are always included. Unrecognized tokens are accepted but do not add modules.

lang
string
callback
string
format
string
default:JSON
mode
string
default:live
source
string
amount
string
user_id
string

Response

200 - application/json

OK

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

execution_ms
integer
required
Example:

42