geoip.lookup

beta Standard

Geolocate an IP address (country, region, city, coordinates, ASN) via ipwho.is.

GET /v1/geoip/lookup

What you get#

One Geoip record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`ip`	string	yes	(required)	IPv4/IPv6 address	max 45 chars; must match `[0-9a-fA-F:.]{3,45}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/geoip/lookup?ip=8.8.8.8" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Geoip response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "8.8.8.8",
      "name": "United States",
      "category": "California",
      "description": "San Jose"
    },
    "ext": {
      "symbol": "US",
      "asn": 15169,
      "org": "Google LLC",
      "isp": "Google LLC",
      "success": true
    },
    "place": {
      "lat": 37.3393939,
      "lon": -121.8949553,
      "timeZone": "America/Los_Angeles"
    }
  },
  "metadata": {
    "platform": "geoip",
    "endpoint": "lookup",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`ip`	`entity.id`	-
`country`	`entity.name`	-
`country_code`	`ext.symbol`	-
`region`	`entity.category`	-
`city`	`entity.description`	-
`latitude`	`place.lat`	`toNumber`
`longitude`	`place.lon`	`toNumber`
`timezone.id`	`place.timeZone`	-
`connection.asn`	`ext.asn`	`toNumber`
`connection.org`	`ext.org`	-
`connection.isp`	`ext.isp`	-
`success`	`ext.success`	`toBoolean`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).