API documentation

Authenticate with your API key and validate IP addresses in real time. 1 lookup = 0.1 credits.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer cb_live_your_api_key

Base URL

https://cleanbyte.co

POST /v1/validate 0.1 credits

Validate a single IP address and return threat scoring, geolocation, and detection flags.

curl -X POST https://cleanbyte.co/v1/validate \
  -H "Authorization: Bearer cb_live_..." \
  -H "Content-Type: application/json" \
  -d '{"ip":"203.0.113.42"}'

POST /v1/bulk 0.1 credits per IP

Validate up to 100 IP addresses in one request.

curl -X POST https://cleanbyte.co/v1/bulk \
  -H "Authorization: Bearer cb_live_..." \
  -H "Content-Type: application/json" \
  -d '{"ips":["8.8.8.8","203.0.113.42"]}'

GET /v1/account Free

Check your remaining credits and usage.

curl https://cleanbyte.co/v1/account \
  -H "Authorization: Bearer cb_live_..."

Response fields

proxy, vpn, datacenter — detection flags
score — threat score from 0 (clean) to 100 (high risk)
country, city, isp — geolocation and network data

Error codes

401 — Invalid or missing API key
402 — Insufficient credits
400 — Invalid request (bad IP format, bulk limit exceeded)

Rate limits

Fair usage applies. Bulk requests are limited to 100 IPs per call. Contact support if you need higher throughput.