Skip to main content
GET
Get geolocation for an IP address

Query Parameters

customer_ip_address
string

IPv4 or IPv6 address of the end user. Defaults to the IP address of the request.

Response

object | null

Geolocation resolved successfully

Resolved location, or null if the IP address could not be resolved

alpha3_country_code
string
required

ISO 3166-1 alpha-3 country code

Example:

"USA"

state_code
string
required

Two-letter region code, or an empty string when not available

Example:

"PA"

default_currency
string

Default fiat currency code for the location

Example:

"USD"