API Documentation

All API requests require authentication using your API key. Include it in the request header:

X-API-KEY: YOUR_API_KEY

Analyze an IP address for VPN, proxy, Tor, and datacenter detection.

Endpoint

GET /api/v1/ip/lookup?ip={ip}

Parameters

Example Request

curl -X GET "https://affguard.ai/api/v1/ip/lookup?ip=8.8.8.8" \
     -H "X-API-KEY: YOUR_API_KEY"

Example Response

{
    "ip": "8.8.8.8",
    "country": "US",
    "is_vpn": "no",
    "is_proxy": "no",
    "is_tor": "no",
    "is_bot": "no",
    "is_hosting": "yes",
    "is_blacklist": "no",
    "is_residential": "no",
    "risk_score": 40,
    "fraud_score": 30,
    "confidence": 80,
    "threat_categories": ["datacenter_hosting"],
    "subnet_risk": 12.50,
    "is_abusive": "no",
    "abuse_reports": 0,
    "is_market_research_flagged": "no",
    "market_research_reports": 0
}

Response Field Dictionary

When a user attempts to open an offer from your Ad Network or Offerwall partners, check their IP first. If the risk_score is above 40, we recommend blocking the redirect to protect your advertiser reputation.

// Example Logic
if ($data['risk_score'] > 40) {
    die("VPN/Proxy detected. Please disable it to continue to offers.");
}

The threat_categories field returns a structured array of detected threat types, ordered by severity. Use these labels to build routing rules, auto-block policies, or dashboard visualizations.

Our IP Intelligence system provides multiple scoring dimensions to help you make informed security decisions.

Score Interpretation Guide

Rate limits vary by plan tier:

• PHP
• Python
• JavaScript
• cURL

<?php
$apiKey = 'YOUR_API_KEY';
$ip = '8.8.8.8';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://affguard.ai/api/v1/lookup/$ip");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $apiKey"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);

echo "Risk Score: " . $data['risk_score'];
?>

import requests

api_key = 'YOUR_API_KEY'
ip = '8.8.8.8'

headers = {'Authorization': f'Bearer {api_key}'}
response = requests.get(f'https://affguard.ai/api/v1/lookup/{ip}', headers=headers)

data = response.json()
print(f"Risk Score: {data['risk_score']}")

const apiKey = 'YOUR_API_KEY';
const ip = '8.8.8.8';

fetch(`https://affguard.ai/api/v1/lookup/${ip}`, {
    headers: {
        'Authorization': `Bearer ${apiKey}`
    }
})
.then(response => response.json())
.then(data => {
    console.log('Risk Score:', data.risk_score);
});

curl -X GET "https://affguard.ai/api/v1/lookup/8.8.8.8" \
     -H "Authorization: Bearer YOUR_API_KEY"