Skip to main content
POST
Request IP2Company enrichment
See IP2Company enrichment and polling. A saved HTTP 200 response can include unfinished work; inspect refreshStatus and honor the polling delay.

Authorizations

X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Body

application/json
ip
string
required

One IPv4 or IPv6 address. URLs, CIDRs and ports are rejected.

Maximum string length: 64
Example:

"192.0.2.10"

Response

Saved or missing lookup with current credit balance; ISP data is free and may include a pending refresh.

ip
string
required
status
enum<string>
required
Available options:
complete,
pending,
missing
data
object | null
required
stale
boolean | null
required
pollAfterSeconds
integer | null
required
Required range: x >= 0
refreshStatus
enum<string> | null
required

Refresh state for saved data, including HTTP 200 responses. pending confirms accepted unfinished work; deferred requires retrying POST after pollAfterSeconds; not_requested means this read started no refresh; not_needed means no refresh is required. Null without saved data. stale independently describes the saved result age.

Available options:
not_needed,
not_requested,
pending,
deferred,
null
meta
object
required