Skip to main content
POST
Lookup IP information
For server-to-server use, send a Pirehub API key with the ip:lookup scope. See Authentication for OAuth support and credential handling. The response is allowlisted and contains approximate, best-effort metadata. Only ip is guaranteed after a successful lookup; all location, hostname, organization, postal, and timezone fields are optional. See the IP information guide for field semantics, accuracy guidance, limits, and integration requirements.

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.

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code with PKCE, issued by Pirehub's Clerk authorization server. Request only the scopes required by the operation.

Headers

Idempotency-Key
string

Self-service keys only. Owner-scoped operation identifier; reuse after admission returns 409 without another debit or execution. USAGE_CONCURRENCY_EXCEEDED retains no new reservation: wait and retry with the same identifier and payload. No response replay. Video jobs use requestId instead.

Required string length: 1 - 80
Pattern: ^[a-zA-Z0-9_-]+$

Path Parameters

ip
string
required

A valid public IPv4 or IPv6 address.

Minimum string length: 2

Response

The IP information lookup completed.

success
boolean
required
data
object
required