IP Shield

IP Shield

Overview

Network API

Deep network intelligence and routing data

The Network API retrieves deep network intelligence for any IPv4 or IPv6 address. The endpoint returns proxy detection, Tor exit node status, verified bot associations, and Autonomous System Number (ASN) routing data. Use this endpoint to filter traffic based on network origin and infrastructure type.

Endpoint

Terminal
curl -X GET "https://ip-shield.riavzon.com/api/v1/network/8.8.8.8" \
  -H "x-api-key: YOUR_API_KEY"

The 8.8.8.8 parameter in the URL path represents the target IPv4 or IPv6 address you want to analyze.

Response Example

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ok": true,
  "date": "2025-06-12T00:00:00.000Z",
  "data": {
    "ip": "8.8.8.8",
    "proxy": false,
    "vpn": false,
    "threat_level": 0,
    "is_known_bot": true,
    "bot_details": {
      "bot_owner": "google",
      "creationTime": "2024-03-09T22:00:00.000Z"
    },
    "is_tor_node": true,
    "tor_details": {
      "flags": ["Exit", "Fast", "Running", "Stable", "Valid"],
      "last_seen": "2025-06-12T00:00:00.000Z",
      "exit_probability": 0.015,
      "guard_probability": 0.0,
      "exit_addresses": "185.220.101.45",
      "exit_policy_summary": "accept 80, 443",
      "country": "DE",
      "as_name": "CENSUS-PROV",
      "as_id": "205100"
    },
    "asn": {
      "asn_id": "205100",
      "asn_name": "CENSUS-PROV",
      "classification": "hosting",
      "route_visibility_count": 420
    }
  },
  "meta": {
    "total_credits": 10000,
    "credits_remaining": 9999
  }
}

Response Fields

ok
boolean
Returns true when the request succeeds.
date
string
This field contains the ISO 8601 timestamp of the response.
data.ip
string
This field contains the queried IP address.
data.proxy
boolean
Returns true if the IP address acts as a proxy.
data.vpn
boolean
Returns true if the IP address belongs to a Virtual Private Network.
data.threat_level
number
A score indicating the historical risk of the IP (higher is riskier).
data.is_known_bot
boolean
Returns true if the IP address associates with a known datacenter bot or crawler.
data.bot_details
object | null
This object provides metadata about the verified bot, or null if the IP is not a known bot.
data.bot_details.bot_owner
string
This field identifies the organization that operates the bot (e.g., Google, Bing).
data.bot_details.creationTime
string
This field contains the ISO 8601 timestamp when the bot IP was first verified.
data.is_tor_node
boolean
Returns true if the IP address routes through the Tor anonymity network.
data.tor_details
object | null
This object provides metadata about the Tor relay, or null if the IP is not a Tor node.
data.tor_details.flags
string[] | null
This array lists the consensus flags assigned to the Tor relay.
data.tor_details.last_seen
string | null
This field contains the ISO 8601 timestamp when the relay was last observed in the consensus.
data.tor_details.exit_probability
number | null
This value represents the probability that the relay acts as an exit node.
data.tor_details.guard_probability
number | null
This value represents the probability that the relay acts as a guard node.
data.tor_details.exit_addresses
string | null
This field lists the known exit IP addresses for the relay.
data.tor_details.exit_policy_summary
string | null
This field summarizes the port access policy for the exit node.
data.tor_details.country
string | null
This field provides the two-letter ISO country code where the relay operates.
data.tor_details.as_name
string | null
This field provides the Autonomous System name hosting the relay.
data.tor_details.as_id
string | null
This field provides the Autonomous System Number hosting the relay.
data.asn
object | null
This object provides routing metadata, or null if no BGP data exists.
data.asn.asn_id
string | null
This field provides the Autonomous System Number assigned to the routing provider.
data.asn.asn_name
string | null
This field provides the name of the Autonomous System organization.
data.asn.classification
string | null
This field classifies the network type as hosting, eyeballs, or unknown.
data.asn.route_visibility_count
number | null
This field indicates the number of BGP peers observing routes to this ASN.
meta.total_credits
number
This field displays the total number of credits allocated to the account plan.
meta.credits_remaining
number
This field displays the number of credits remaining in the current billing cycle.

Error Response

Error responses, such as bad requests or rate limits, return the following JSON format.

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "ok": false,
  "date": "2025-06-12T00:00:00.000Z",
  "reason": "Invalid IP address format"
}

Error Fields

ok
boolean
The API always returns false for error responses.
date
string
This field contains the ISO 8601 timestamp of the error event.
reason
string
This field provides a human-readable message that explains why the request failed.

Lookup IP API

Summary API

Logo