Sign in

v2

latestOpenAPI 3.1.0Proprietary2026-08-01122398.8 KB
IP

Look up an IP address (query param or the caller's own)

Same as /ip/v1/{ip}, but with the address supplied via the ip query parameter; the path slug takes precedence when both are present. Omit the parameter entirely to look up the caller's own address ("where am I?").

get/ip/v1

Query parameters

ipstring

IP address to look up when it isn't given as the path slug; the path slug takes precedence when both are present. Both IPv4 and IPv6 are accepted. Omit it (and the path slug) to look up the caller's own address.

response_fieldsstring

Comma-separated dot-path projection. Only the specified fields are returned. Example: names.common,codes.alpha_2,flag.emoji

response_fields_omitstring

Comma-separated dot-path blocklist. The specified fields are removed from the response. Useful for trimming heavy branches like names.translations.

prettyboolean

Set to true (a bare ?pretty, 1, or true) to pretty-print the JSON response; 0 or false keep it minified. Default is minified.

Response

Geolocation record for the resolved IP address, always a single object.