Skip to main content
POST
security.ip.privacy

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 IP to classify.

Minimum string length: 1
detail
enum<string>
default:standard

Standard flags, extended evidence, or residential proxy evidence; unknown fields remain absent.

Available options:
standard,
extended,
residential

Response

The result

ip
string
required

IP checked.

isVpn
boolean

VPN exit address.

isProxy
boolean

Proxy address.

isTor
boolean

Tor exit address.

isRelay
boolean

Anonymous relay address.

isHosting
boolean

Hosting network address.

isResidentialProxy
boolean

Residential proxy address.

classification
enum<string>

Reported network classification.

Available options:
vpn,
corporate_vpn,
proxy,
hosting,
cdn,
tor,
relay,
residential_proxy,
residential_proxy_likely,
residential_proxy_mobile,
datacenter_proxy,
mobile_proxy,
suspected_vpn,
suspected_proxy,
unknown
classificationConfidence
number

Calibrated classification confidence, 0 to 1; absent for ordinal evidence levels.

Required range: 0 <= x <= 1
evidenceLevel
integer

Ordinal evidence level: 1 observed software, 2 corroborated use, 3 direct commercial use; not a probability.

Required range: 1 <= x <= 3
lastSeenAt
string

Last observation time, ISO 8601.

observedDaysPercent
number

Percentage of days observed in the source's observation window, 0 to 100.

Required range: 0 <= x <= 100