Skip to main content
Pirehub IP information accepts an IPv4 or IPv6 address and returns an allowlisted, normalized response. Provider credentials, raw responses, and diagnostic metadata are never exposed.

​
Available information

Only ip is guaranteed in a successful response. All other fields are optional and may be absent when the source has no reliable value. Location data is approximate and must not be used to identify a person or precise address.

​
Accepted input

Place one valid IPv4 or IPv6 address in the URL path. Use a public address for a meaningful lookup; private, loopback, reserved, or otherwise non-routable addresses may not have location or network metadata.

​
Authentication

POST /api/v1/ip-info/{ip} accepts a Pirehub API key with the ip:lookup scope for server-to-server integrations. Send the key in x-pirehub-api-key or as a bearer token. See Authentication for OAuth support and credential handling.

​
Lookup request

​
Lookup response

Treat every field except ip as best-effort. Do not make access-control, identity, fraud, or compliance decisions from approximate location metadata alone.

​
Limits and failures

Administrator-issued API keys use the per-minute and monthly request limits configured for that key. Inspect the X-ApiKey-RateLimit-* and X-ApiKey-Monthly-* response headers. First-party browser requests without an API key are limited to 30 requests per minute per IP and return X-RateLimit-* headers. An invalid address returns 400 INVALID_REQUEST. Temporary service, dependency, or timeout failures can return 429, 502, 503, or 504. Honor Retry-After when present and see Errors and retries.

​
Next steps

IP information endpoint

Review the complete path and response schema.

Authentication

Learn about scopes and credential handling.

Errors and retries

Handle failures safely and predictably.

​
Subscription-backed API keys

Paid self-service keys use shared owner credits and the plan’s per-second and concurrent-job limits. Successful results, including cache hits, consume the configured action cost; errors release the reservation. Video jobs settle at completion. Inspect X-ApiKey-Credit-* and X-ApiKey-RateLimit-*. An optional Idempotency-Key prevents repeated synchronous execution/debits; repeated operations return 409 rather than replaying a response. Job starts use requestId instead. See API plans and idempotency for costs, billing periods, headers, error codes and retry rules.