GeoIP API

API reference

GeoIP HTTP endpoints on api.syndaq.com.

All GeoIP endpoints are served from https://api.syndaq.com/v1/geoip/.

Authenticated requests require a valid GeoIP key. Lookup routes require your geo_sec_ secret key.

Endpoints overview

Method	Path	Auth	Purpose
GET	`/v1/geoip/lookup`	Secret key	Lookup by `?ip=` query parameter
GET	`/v1/geoip/lookup/{ip}`	Secret key	Lookup by IP in the URL path
GET	`/v1/geoip/status`	Public or secret key	Plan limits and quota snapshot

Response headers

Successful and error responses may include:

Header	Description
`X-Request-Id`	Unique ID for support and log correlation
`X-RateLimit-Limit`	Plan requests per minute for this key
`X-RateLimit-Remaining`	Requests left in the current minute window
`X-RateLimit-Reset`	Unix timestamp when the minute window resets
`X-Quota-Limit`	Monthly quota for the subscription
`X-Quota-Remaining`	Lookups left this calendar month (UTC)
`X-Quota-Period`	Current quota month (`YYYY-MM`)
`Retry-After`	Seconds to wait after HTTP 429

GET /v1/geoip/lookup

Returns geolocation and network metadata for a single IP address.

Request

Pass the target IP using one of these forms:

GET /v1/geoip/lookup/8.8.8.8
GET /v1/geoip/lookup?ip=8.8.8.8

Both IPv4 and IPv6 are supported. IPv6 addresses in the path should be URL-encoded.

Headers:

Authorization: Bearer geo_sec_YOUR_SECRET_KEY

Success response (200)

{
  "success": true,
  "ip": "8.8.8.8",
  "cached": true,
  "provider": "ipwhois",
  "fetched_at": "2026-06-22 12:00:00.000",
  "continent": "North America",
  "country": {
    "code": "US",
    "name": "United States"
  },
  "region": "California",
  "city": "Mountain View",
  "postal": "94035",
  "location": {
    "latitude": 37.386,
    "longitude": -122.084
  },
  "timezone": {
    "id": "America/Los_Angeles"
  },
  "connection": {
    "isp": "Google LLC",
    "org": "Google Public DNS",
    "asn": 15169,
    "domain": "google.com",
    "type": "IPv4"
  },
  "is_eu": false,
  "request_id": "e6d04020be9b57b1e1069d6e483c0443"
}

Response fields

Field	Type	Description
`cached`	boolean	`true` when served from cache or local database
`country.code`	string	ISO 3166-1 alpha-2 country code
`country.name`	string	Country display name
`region`	string	State, province, or region
`city`	string	City name when available
`postal`	string	Postal or ZIP code when available
`location.latitude`	number	WGS84 latitude
`location.longitude`	number	WGS84 longitude
`timezone.id`	string	IANA timezone identifier when available
`connection.isp`	string	Internet service provider
`connection.org`	string	Organization name
`connection.asn`	integer	Autonomous system number
`connection.domain`	string	Reverse DNS domain when known
`connection.type`	string	`IPv4` or `IPv6`
`is_eu`	boolean	Whether the country is in the European Union

GET /v1/geoip/status

Returns key status, plan limits, and quota usage without performing a lookup.

Request

GET /v1/geoip/status
Authorization: Bearer geo_sec_YOUR_SECRET_KEY

The public key (geo_pub_) is accepted on this route.

Success response (200)

{
  "success": true,
  "status": "active",
  "product": "geoip",
  "plan": "starter",
  "rate_limit_per_minute": 120,
  "monthly_quota": 10000,
  "quota_unlimited": false,
  "quota_remaining": 9842,
  "quota_period": "2026-06",
  "database_records": 1250000
}

Errors

Failed requests return JSON with success: false, error, error_code, and usually request_id.

HTTP	error_code	Typical cause
400	`invalid_ip`	Missing or malformed IP address
401	`missing_credentials`	No API key provided
401	`invalid_api_key`	Unknown, inactive, or revoked key
401	`wrong_key_type`	Public key used on a lookup endpoint
403	`ip_not_allowed`	Caller IP not on the key allowlist
404	`ip_not_found`	Upstream could not resolve the address
422	`ip_not_routable`	Private, reserved, or non-routable IP
429	`rate_limit_exceeded`	Per-minute limit exceeded
429	`quota_exceeded`	Monthly quota exhausted
502	`lookup_failed`	Temporary upstream error
500	`internal_error`	Unexpected server error

Handle non-200 responses in your application and retry transient errors with exponential backoff.