Getting Started with APIVoid APIs

Threat analysis, domain and IP intelligence, and security APIs for developers. Every endpoint requires HTTPS POST over TLS 1.2+, accepts a JSON body, returns structured JSON responses, and authenticates requests using the X-API-Key header.

Follow the changelog for officially released updates. We also announce API updates in our newsletter to registered users. See Versioning for which changes are backward-compatible, and which only arrive with a new major version under a new versioned URL. Following both is the easiest way to pick up new endpoints and fields as they ship.

Quick start

Get an API key. Create an account and copy your API key from the dashboard.
Start a free trial or subscribe. Activate your 30-day trial or choose a paid subscription.
Make your first request. Send an HTTPS POST request with your key in the X-API-Key header:

curl

curl -X POST "https://api.apivoid.com/v2/ip-reputation" \
     -H "Content-Type: application/json" \
     -H "X-API-Key: YOUR_API_KEY_HERE" \
     -d '{"ip": "80.82.77.139"}'

The Content-Type: application/json header is required for every API request.

A successful request returns HTTP 200 with a JSON body.

The basics

These concepts apply to every API, so they are documented once:

AuthenticationHow to send your API key, where to find it, and how to keep it safe across your applications and environments. How credits workFixed credit costs per API, no credits consumed on errors, overage, and when your balance resets. X-Service-Quota headerRead your credit usage, remaining balance, next credits reset and overage status from every response. API errors & retriesThe error format, 4xx vs 5xx, and which status codes are safe to retry when handling failed API requests. Request timeoutsAverage and maximum response times for every API, and the client timeout we suggest for each. Rate limitsConcurrency and RPS limits, the X-Concurrency-Limit and Retry-After headers, and limits per plan.

Base URL & conventions

base url

https://api.apivoid.com/v2/{service}

All endpoints use HTTPS POST with Content-Type: application/json.
TLS 1.2+ is required; older TLS/SSL versions are not supported for security reasons.
All request and response bodies, including errors, are encoded in JSON format.
Successful requests always return status 200; anything else is an error.
Each API consumes a fixed number of credits per successful call, listed on its reference page.
Responses with a non-200 status code, such as 4xx or 5xx errors, never consume credits.
Every API call performs a fresh, live analysis of the submitted target.
Successful responses include the X-Service-Quota header with your live usage stats.

Production checklist

Before going live, make sure your integration checks these boxes:

Store API keys securely. Use environment variables or a secrets manager. See Authentication.
Handle API errors. Check non-200 responses and retry only when safe. See API errors & retries.
Respect rate limits. Back off when you hit concurrency or RPS limits. See Rate limits.
Set proper timeouts. Allow enough time for longer scans. See Request timeouts.
Monitor API usage. Track credits and overage via X-Service-Quota header or Account Info API.
Estimate credit usage. Project your monthly credit volume with the pricing calculator.

Homepage · Pricing calculator · Contact us · FAQs · Changelog · Service status · Dashboard