Skip to content
locate-me v0.1.0
Checking

ReferenceInfo

Info

Reports the server version, the limits of the calling key and the database that answers lookups.

  • API key
  • 1 unit per request
GET/v1/info

Example

curl -H "X-API-Key: $LOCATE_ME_KEY" http://localhost:8080/v1/info
200 OK
{
  "version": "0.1.0",
  "key": "my-client",
  "rate_limit": { "per_second": 100, "burst": 200 },
  "bulk_max_ips": 100,
  "database": {
    "file": "dbip-city-lite-2026-10.mmdb",
    "database_type": "DBIP-City-Lite",
    "build_epoch": 1790818881,
    "build_date": "2026-10-01T01:41:21Z",
    "ip_version": 6,
    "node_count": 14297794,
    "languages": [
      "en", "de", "es", "fr", "ja", "pt-BR", "ru", "zh-CN", "fa", "ko"
    ],
    "size_bytes": 126998165,
    "loaded_at": "2026-10-12T12:16:13Z"
  },
  "attribution": "IP Geolocation by DB-IP (https://db-ip.com)"
}

Fields

FieldTypeDescription
versionstringServer version.
keystringThe name of the key that made the request.
rate_limit.per_secondnumberSustained units per second for this key.
rate_limit.burstnumberUnits this key can spend at once.
bulk_max_ipsnumberMost addresses one bulk request may carry.
databaseobjectThe active database, or null before the first one is loaded.
database.build_datestringWhen the database was built, RFC 3339 in UTC. build_epoch is the same in Unix seconds.
database.languagesstring[]Languages the file has names in. The API serves eight of them through lang.
database.loaded_atstringWhen this server loaded the file. A monthly update swaps it without downtime.
attributionstringThe credit to show wherever results are displayed.

Use /v1/info to check a key's limits before sizing bulk requests, or to confirm which monthly database a server runs.

Esc