IP Shield

IP Shield

Overview

Summary API

Full IP intelligence summary

The Summary API is our most comprehensive endpoint. It executes multiple database lookups concurrently (Network, Geolocation, and Threat) and returns a unified intelligence payload in a single, high-speed response.

Endpoint

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

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

Response Example

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

{
  "ok": true,
  "date": "2025-06-12T00:00:00.000Z",
  "data": {
    "ip": "1.1.1.1",
    "country_code": "US",
    "proxy": false,
    "vpn": false,
    "threat_level": 0,
    "is_known_bot": false,
    "is_tor_node": false,
    "classification": "hosting",
    "asn_id": "13335"
  },
  "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.country_code
string | null
This field provides the two-letter ISO 3166-1 alpha-2 country code.
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.is_tor_node
boolean
Returns true if the IP address routes through the Tor anonymity network.
data.classification
string | null
This field classifies the network type as hosting, eyeballs, or unknown.
data.asn_id
string | null
This field provides the Autonomous System Number assigned to the routing provider.
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
Always false for error responses.
date
string
ISO 8601 timestamp of when the error occurred.
reason
string
A human-readable message explaining why the request failed.

Network API

User Agent Check API

Logo