/browserleaks/ips

POST /api/browserleaks/ips

Price: 1 credit

Look up an IP address or domain — geolocation, ISP and ASN, network usage flags, Tor relay identification and the registry whois record

How to use it

Use this to judge what kind of network an address belongs to, not merely where it is — the usage classification and the routing-registry flags separate hosting and VPN ranges from residential ones. A domain name is accepted and resolved, so pass one directly. The allocation record is not a strict either/or between `registry` and `whois` — both are populated together on most addresses, one alone on the rest, and rarely neither — so read whichever is populated instead of reading an empty one as a failure. Reserved and private ranges carry an RFC assignment and no geolocation at all.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• address string required — IPv4 address, IPv6 address or domain name to look up. A domain is resolved first and the report describes its primary address (examples: "8.8.8.8", "2606:4700:4700::1111", "example.com"; minLength: 1)

Response

• @type string (default: "BrowserleaksIp")
• ip string required
• domain string nullable
• hostname string nullable
• additional_ips array (default: [])
• country string nullable
• country_code string nullable
• region string nullable
• city string nullable
• isp string nullable
• organization string nullable
• asn integer nullable
• asn_name string nullable
• network_tags array (default: [])
  • @type string (default: "BrowserleaksNetworkTag")
  • code string required
  • description string nullable
• usage_type string nullable
• timezone string nullable
• timezone_abbreviation string nullable
• utc_offset string nullable
• latitude number nullable
• longitude number nullable
• assignment string nullable
• assignment_rfc string nullable
• address_block string nullable
• net_range string nullable
• tor_relays array (default: [])
  • @type string (default: "BrowserleaksTorRelay")
  • fingerprint string required
  • nickname string nullable
  • is_running boolean nullable
  • or_addresses array (default: [])
  • exit_addresses array (default: [])
  • flags array (default: [])
  • exit_policy array (default: [])
  • first_seen_at integer nullable
  • last_seen_at integer nullable
  • last_restarted_at integer nullable
  • bandwidth_mbps number nullable
  • contact string nullable
  • platform string nullable
  • version_status string nullable
• registry object nullable
  • @type string (default: "BrowserleaksIpRegistry")
  • source string nullable
  • id string nullable
  • name string nullable
  • allocation_type string nullable
  • country string nullable
  • ip_version string nullable
  • start_address string nullable
  • end_address string nullable
  • cidr array (default: [])
  • parent_id string nullable
  • status array (default: [])
  • registered_at integer nullable
  • updated_at integer nullable
  • remarks array (default: [])
  • contacts array (default: [])
    • @type string (default: "BrowserleaksRegistryContact")
    • id string nullable
    • name string nullable
    • organization string nullable
    • kind string nullable
    • roles array (default: [])
    • email string nullable
    • phone string nullable
    • address string nullable
    • remarks array (default: [])
• whois array (default: [])
  • @type string (default: "BrowserleaksWhoisEntry")
  • name string required
  • value string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — browserleaks.com does not recognise this address Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.