Skip to main content
POST
companies.identify-ip-detailed

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ip
string
required

Public IPv4 or IPv6 address.

Required string length: 1 - 64
includeLocation
boolean
default:true

Include IP location; default true.

includeMetadata
boolean
default:false

Explicit extra-cost network metadata; default false.

includeOccupationalAttributes
boolean
default:false

Explicit extra-cost occupational role and level attributes; default false.

allowUnmatched
boolean
default:false

Return IP-only information when no company matches; default false.

Response

The result

ip
string
required

IP address.

company
object

Company behind the address.

location
object

IP geographic location.

network
object

Network flags, only when explicitly requested.

occupation
object

Optional occupational attributes associated with the IP; no name or contacts.