🎯 Successful Response Fields
success
Type: Boolean
Boolean indicating if the request was successful.
Boolean indicating if the request was successful.
Example: true
data
Type: Object
Object containing all the geolocation and metadata information for the requested IP address.
Object containing all the geolocation and metadata information for the requested IP address.
country_code
Type: String
Two-letter ISO 3166-1 alpha-2 country code.
Two-letter ISO 3166-1 alpha-2 country code.
Example: "DE" (Germany)
country
Type: String
Full country name in English.
Full country name in English.
Example: "Germany"
city
Type: String
City name where the IP address is likely located.
City name where the IP address is likely located.
Example: "Berlin"
lat
Type: Float
Latitude coordinate (decimal degrees).
Latitude coordinate (decimal degrees).
Example: 52.5200
lng
Type: Float
Longitude coordinate (decimal degrees).
Longitude coordinate (decimal degrees).
Example: 13.4050
postal
Type: String
Postal code or ZIP code for the location.
Postal code or ZIP code for the location.
Example: "10178"
accuracy
Type: Integer
Accuracy radius in meters. Lower values indicate more precise location data.
Accuracy radius in meters. Lower values indicate more precise location data.
Example: 1000 (accurate within ~1km)
timezone
Type: String
IANA timezone identifier for the location.
IANA timezone identifier for the location.
Example: "Europe/Berlin"
continent_code
Type: String
Two-letter continent code.
Two-letter continent code.
Example: "EU" (Europe)
continent
Type: String
Full continent name in English.
Full continent name in English.
Example: "Europe"
region
Type: String
Administrative region, state, or province.
Administrative region, state, or province.
Example: "Berlin"
subregion
Type: String
Secondary administrative division. May be empty.
Secondary administrative division. May be empty.
Example: ""
is_proxy
Type: Boolean
Boolean indicating if the IP address is identified as a proxy server.
Boolean indicating if the IP address is identified as a proxy server.
Example: false
is_vpn
Type: Boolean
Boolean indicating if the IP address belongs to a known VPN provider.
Boolean indicating if the IP address belongs to a known VPN provider.
Example: false
is_tor_exit
Type: Boolean
Boolean indicating if the IP address is a Tor exit node.
Boolean indicating if the IP address is a Tor exit node.
Example: false
is_tor
Type: Boolean
Boolean indicating if the IP address is part of the Tor network.
Boolean indicating if the IP address is part of the Tor network.
Example: false
tor_nickname
Type: String (optional)
Nickname of the Tor relay. Only present when the IP is a Tor node.
Nickname of the Tor relay. Only present when the IP is a Tor node.
Example: "MyExitRelay"
tor_fingerprint
Type: String (optional)
40-character hex fingerprint of the Tor relay. Only present when the IP is a Tor node.
40-character hex fingerprint of the Tor relay. Only present when the IP is a Tor node.
Example: "ABCD1234567890ABCD1234567890ABCD12345678"
tor_flags
Type: Array of Strings (optional)
Tor directory authority flags assigned to this relay. Only present when the IP is a Tor node.
Tor directory authority flags assigned to this relay. Only present when the IP is a Tor node.
Example: ["Exit", "Fast", "Running", "Stable", "Valid"]
currency
Type: String
Three-letter ISO 4217 currency code for the country.
Three-letter ISO 4217 currency code for the country.
Example: "EUR"
usd_rate
Type: String
Exchange rate from local currency to USD (string format for precision).
Exchange rate from local currency to USD (string format for precision).
Example: "1.150748"
eur_rate
Type: String
Exchange rate from local currency to EUR (string format for precision).
Exchange rate from local currency to EUR (string format for precision).
Example: "1.000000"
meta
Type: Object
Object containing request metadata and rate limiting information.
Object containing request metadata and rate limiting information.
ip
Type: String
The client IP address that made the request.
The client IP address that made the request.
Example: "82.80.127.168"
rate_limit
Type: Object
Object containing rate limiting information.
Object containing rate limiting information.
limit
Type: Integer
Total number of requests allowed per day.
Total number of requests allowed per day.
Example: 10000
remaining
Type: Integer
Number of requests remaining for today.
Number of requests remaining for today.
Example: 9995
reset_time
Type: Integer
Unix timestamp when the rate limit will reset (start of next day UTC).
Unix timestamp when the rate limit will reset (start of next day UTC).
Example: 1754265600
response_time
Type: String
Time taken to process the request on the server side.
Time taken to process the request on the server side.
Example: "743.521µs"
❌ Error Response Fields
success
Type: Boolean
Boolean indicating the request failed.
Boolean indicating the request failed.
Example: false
error
Type: String
Human-readable error message describing what went wrong.
Human-readable error message describing what went wrong.
Example: "IP not found: 192.168.1.999"
meta
Type: Object
Same metadata structure as successful responses, containing rate limit and timing information.
Same metadata structure as successful responses, containing rate limit and timing information.
