Skip to content

IP

Return the caller IP address as plain text. The service prefers the Cloudflare CF-Connecting-IP header when present.

Endpoint

GET /v1/ip

Response

Plain text containing the IP address.

GeoIP lookup

Resolve either the caller IP or an explicit ip query parameter against the local GeoLite2 city database.

Endpoint

GET /v1/ip/geo

Auth

Requires a JWT or service token with permission ip:geo.read.

Query parameters

  • ip (optional): explicit IPv4/IPv6 address to resolve. When omitted, the API resolves the caller IP from forwarded headers.

Response

JSON payload with the normalized GeoIP fields:

  • ip
  • country
  • countryIso
  • region
  • city
  • zip
  • timezone
  • continent
  • lat
  • lon