✦
VPNSignal
Documentation
Go to Dashboard

Quick Start#

Get your first IP check running in under 5 minutes. This guide will walk you through making your first API call using curl, JavaScript, and Python.

Prerequisites#

Before you begin, make sure you have:

  • An API key from the dashboard
  • The API endpoint: https://vpnsignal.io/api/v1/check

Make Your First Request#

Using curl#

bash
curl -X POST https://vpnsignal.io/api/v1/check \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ip": "1.1.1.1"}'

Using JavaScript (fetch)#

javascript
const response = await fetch('https://vpnsignal.io/api/v1/check', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ ip: '1.1.1.1' }),
});

const result = await response.json();
console.log(result);

Using Python (requests)#

python
import requests

response = requests.post(
    'https://vpnsignal.io/api/v1/check',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    json={'ip': '1.1.1.1'},
)

result = response.json()
print(result)

Understanding the Response#

A successful response looks like this:

json
{
  "ip": "1.1.1.1",
  "is_vpn": false,
  "is_proxy": false,
  "is_tor": false,
  "is_relay": false,
  "is_hosting": true,
  "risk_score": 30,
  "recommendation": "allow",
  "company": {
    "name": "Cloudflare, Inc.",
    "type": "hosting"
  },
  "location": {
    "country": "US",
    "city": "San Francisco"
  }
}
FieldDescription
risk_score0-100 score indicating risk level
recommendationallow, verify, or block
is_vpnTrue if IP belongs to a VPN provider
is_proxyTrue if IP is a known proxy
is_torTrue if IP is a Tor exit node

Next Steps#