# APIVoid Documentation

> Official API documentation for APIVoid v2 threat analysis, domain/IP intelligence, and security APIs. Every page below is static HTML and can be fetched directly. All API endpoints use HTTPS POST to https://api.apivoid.com/v2/{service} with Content-Type: application/json and the API key in the X-API-Key header. Successful requests return HTTP 200 with a JSON body; non-200 responses are errors and never consume credits.

Each API reference page documents: the endpoint URL, request parameters, credit cost per request, and a complete example request and JSON response. API reference URLs follow the pattern https://docs.apivoid.com/{service}-api/ — for example https://docs.apivoid.com/ip-reputation-api/ documents the endpoint https://api.apivoid.com/v2/ip-reputation

## Getting started

- [Getting Started](https://docs.apivoid.com/): APIVoid v2 API documentation: authentication, credits, errors, rate limits, and a reference for every endpoint with request and response examples.
- [API Authentication](https://docs.apivoid.com/authentication/): How to authenticate APIVoid v2 API requests using the X-API-Key header, where to find your API key, and best practices for keeping it secure.
- [How Credits Work](https://docs.apivoid.com/how-credits-work/): How APIVoid API credits work: fixed credit cost per call, no credits consumed on errors, overage on Startup plans and above, resets, and usage estimates.
- [X-Service-Quota Header](https://docs.apivoid.com/service-quota/): How to read the X-Service-Quota response header in APIVoid v2 APIs to monitor credit usage, remaining balance, reset time and overage status.
- [API Errors & Retries](https://docs.apivoid.com/errors/): APIVoid v2 API error format, the difference between 4xx and 5xx errors, which status codes are safe to retry, and how to implement incremental backoff.
- [Request Timeouts & API Response Times](https://docs.apivoid.com/request-timeout/): Average and maximum response times for every APIVoid v2 API, suggested HTTP client timeouts, and why response times vary with the target and request parameters.
- [Rate Limits & Concurrency](https://docs.apivoid.com/rate-limit/): APIVoid v2 concurrency and requests-per-second limits, the X-Concurrency-*, X-RateLimit-* and Retry-After headers, limits per plan, and how to size your client.
- [API Versioning](https://docs.apivoid.com/versioning/): How APIVoid versions its APIs: the major version in the URL (currently v2), breaking vs backward-compatible changes, and the deprecation policy.
- [OpenAPI Specification](https://docs.apivoid.com/openapi-specification/): Download the APIVoid OpenAPI 3.0 specification (openapi.json) for all v2 endpoints. Import into Postman, generate clients, or feed it to AI coding assistants.
- [Migrate from v1 to v2](https://docs.apivoid.com/migrate-to-v2/): Migrate from the deprecated APIVoid v1 API to v2: GET to POST, the X-API-Key header, JSON body parameters, new base URL, and the flatter response structure.

## API reference (v2)

- [Account Info API Reference](https://docs.apivoid.com/account-info-api/): Account Info API v2 reference: endpoint, parameters, credit cost, and example request and response. Get your APIVoid plan, credits balance, usage and reset.
- [ASN Info API Reference](https://docs.apivoid.com/asn-info-api/): ASN Info API v2 reference: endpoint, parameters, credit cost, and example request and response. Get ASN organization, country, IPv4/IPv6 prefixes.
- [BIMI Validator API Reference](https://docs.apivoid.com/bimi-validator-api/): BIMI Validator API v2 reference: endpoint, parameters, credit cost, and example request and response. Validate BIMI DNS record, SVG logo and VMC certificate.
- [DKIM Validator API Reference](https://docs.apivoid.com/dkim-validator-api/): DKIM Validator API v2 reference: endpoint, parameters, credit cost, and example request and response. Validate a domain DKIM record and detect common issues.
- [DMARC Validator API Reference](https://docs.apivoid.com/dmarc-validator-api/): DMARC Validator API v2 reference: endpoint, parameters, credit cost, and example request and response. Validate a domain DMARC record, policy tags and issues.
- [DNS Lookup API Reference](https://docs.apivoid.com/dns-lookup-api/): DNS Lookup API v2 reference: endpoint, parameters, credit cost, and example request and response. Resolve A, AAAA, MX, NS, TXT, DMARC, CAA, DNSSEC and more.
- [DNS Propagation API Reference](https://docs.apivoid.com/dns-propagation-api/): DNS Propagation API v2 reference: endpoint, parameters, credit cost, and example request and response. Check global DNS propagation from multiple locations.
- [DNSSEC Status API Reference](https://docs.apivoid.com/dnssec-status-api/): DNSSEC Status API v2 reference: endpoint, parameters, credit cost, and example request and response. Check if DNS records are DNSSEC-signed and validated.
- [Domain Age API Reference](https://docs.apivoid.com/domain-age-api/): Domain Age API v2 reference: endpoint, parameters, credit cost, and example request and response. Get domain creation date and age to spot new domains.
- [Domain Info API Reference](https://docs.apivoid.com/domain-info-api/): Domain Info API v2 reference: endpoint, parameters, credit cost, and example request and response. Get whois-like data: registrar, owner, dates, nameservers.
- [Domain Reputation API Reference](https://docs.apivoid.com/domain-reputation-api/): Domain Reputation API v2 reference: endpoint, parameters, credit cost, and example request and response. Check a domain on many blacklists, with a risk score.
- [Email Verify API Reference](https://docs.apivoid.com/email-verify-api/): Email Verify API v2 reference: endpoint, parameters, credit cost, and example request and response. Verify syntax, deliverability, MX, disposable providers.
- [EML Insights API Reference](https://docs.apivoid.com/eml-insights-api/): EML Insights API v2 reference: endpoint, parameters, credit cost, and example request and response. Analyze EML files: headers, URLs, attachments, signals.
- [Geo Request API Reference](https://docs.apivoid.com/geo-request-api/): Geo Request API v2 reference: endpoint, parameters, credit cost, and example request and response. Make an HTTP request to a URL from a chosen country.
- [HTML to PDF API Reference](https://docs.apivoid.com/html-to-pdf-api/): HTML to PDF API v2 reference: endpoint, parameters, credit cost, and example request and response. Convert custom HTML into a printable PDF as base64.
- [HTML to PNG API Reference](https://docs.apivoid.com/html-to-png-api/): HTML to PNG API v2 reference: endpoint, parameters, credit cost, and example request and response. Convert custom HTML into a browser-rendered PNG as base64.
- [HTTP Tracker API Reference](https://docs.apivoid.com/http-tracker-api/): HTTP Tracker API v2 reference: endpoint, parameters, credit cost, and example request and response. Track all HTTP requests a URL makes in a real browser.
- [HTTP3 Status API Reference](https://docs.apivoid.com/http3-status-api/): HTTP3 Status API v2 reference: endpoint, parameters, credit cost, and example request and response. Check if a website supports HTTP/3, with protocol details.
- [IP Reputation API Reference](https://docs.apivoid.com/ip-reputation-api/): IP Reputation API v2 reference: endpoint, parameters, credit cost, and example request and response. Check IP reputation on many blacklists, with risk score.
- [Parked Domain API Reference](https://docs.apivoid.com/parked-domain-api/): Parked Domain API v2 reference: endpoint, parameters, credit cost, and example request and response. Detect parked, inactive or for-sale domains.
- [Phone Validator API Reference](https://docs.apivoid.com/phone-validator-api/): Phone Validator API v2 reference: endpoint, parameters, credit cost, and example request and response. Validate phone numbers: country, carrier, line type.
- [Ping Test API Reference](https://docs.apivoid.com/ping-test-api/): Ping Test API v2 reference: endpoint, parameters, credit cost, and example request and response. Ping a host from multiple locations with latency results.
- [Port Scan API Reference](https://docs.apivoid.com/port-scan-api/): Port Scan API v2 reference: endpoint, parameters, credit cost, and example request and response. Scan common TCP ports and get open/closed status per port.
- [QR Scan API Reference](https://docs.apivoid.com/qr-scan-api/): QR Scan API v2 reference: endpoint, parameters, credit cost, and example request and response. Scan a base64 QR code image and extract its content.
- [Reverse IP API Reference](https://docs.apivoid.com/reverse-ip-api/): Reverse IP API v2 reference: endpoint, parameters, credit cost, and example request and response. Find domains hosted on the same IPv4 address.
- [Screenshot API Reference](https://docs.apivoid.com/screenshot-api/): Screenshot API v2 reference: endpoint, parameters, credit cost, and example request and response. Capture full-page browser screenshots in PNG/JPEG/WebP/AVIF.
- [Security Headers API Reference](https://docs.apivoid.com/security-headers-api/): Security Headers API v2 reference: endpoint, parameters, credit cost, and example request and response. Check which security headers are present or missing.
- [Site Trustworthiness API Reference](https://docs.apivoid.com/site-trustworthiness-api/): Site Trustworthiness API v2 reference: endpoint, parameters, credit cost, and example request and response. Get a website trust score to spot risky web shops.
- [SPF Validator API Reference](https://docs.apivoid.com/spf-validator-api/): SPF Validator API v2 reference: endpoint, parameters, credit cost, and example request and response. Validate SPF records: syntax, lookups, sender IP checks.
- [SSL Info API Reference](https://docs.apivoid.com/ssl-info-api/): SSL Info API v2 reference: endpoint, parameters, credit cost, and example request and response. Get SSL certificate owner, issuer, validity and expiration.
- [TLS Check API Reference](https://docs.apivoid.com/tls-check-api/): TLS Check API v2 reference: endpoint, parameters, credit cost, and example request and response. Check supported SSL/TLS versions and deprecated protocols.
- [Tor Test API Reference](https://docs.apivoid.com/tor-test-api/): Tor Test API v2 reference: endpoint, parameters, credit cost, and example request and response. Check if a website is reachable from the Tor network.
- [URL Reputation API Reference](https://docs.apivoid.com/url-reputation-api/): URL Reputation API v2 reference: endpoint, parameters, credit cost, and example request and response. Check URL safety reputation, risk score and detections.
- [URL Status API Reference](https://docs.apivoid.com/url-status-api/): URL Status API v2 reference: endpoint, parameters, credit cost, and example request and response. Check URL HTTP status, redirect chain and final URL.
- [URL to PDF API Reference](https://docs.apivoid.com/url-to-pdf-api/): URL to PDF API v2 reference: endpoint, parameters, credit cost, and example request and response. Convert any URL into a printable PDF rendered by a browser.
- [VPN Test API Reference](https://docs.apivoid.com/vpn-test-api/): VPN Test API v2 reference: endpoint, parameters, credit cost, and example request and response. Check if a website is reachable from a VPN connection.

## Optional

- [Full documentation as one file](https://docs.apivoid.com/llms-full.txt): complete text content of every documentation page in a single file.
- [OpenAPI 3.0 specification](https://docs.apivoid.com/openapi.json): machine-readable spec covering all v2 API endpoints, request/response schemas, and authentication.
- [Sitemap](https://docs.apivoid.com/sitemap.xml): XML index of all documentation pages.
- [APIVoid main website](https://www.apivoid.com/): product pages, pricing, and use cases for every API.
- [Pricing and calculator](https://www.apivoid.com/pricing/): subscription plans with monthly credits and a pricing calculator.
- [Changelog](https://changelog.apivoid.com/): officially released API updates.
- [Service status](https://status.apivoid.com/): live API status page.
- [Dashboard](https://dash.apivoid.com/): manage API keys, subscription, and billing.