API REFERENCE

netsh.io API v1

23 network diagnostic endpoints, one consistent JSON contract. Get a free key by signing in (or view pricing plans).

Base URL

https://netsh.io/api/v1

Authentication

An x-api-key header, or an api_key query parameter if you can't set custom headers (e.g. testing a URL in a browser).

Rate limit

300 credits/day per key, on a rolling 24-hour window. A simple lookup costs 1 credit; heavier diagnostics cost more (shown on each endpoint). Exceeding the budget returns a 429, and every response reports the charge in X-RateLimit-Cost.

Versioning

v1 is a stable contract — a breaking change ships as v2, never an in-place edit.

Response envelope

Every endpoint returns the same shape, success or failure:

{
  "ok": true,
  "data": { /* endpoint-specific */ },
  "meta": { "tool": "whois", "version": "v1" }
}

{
  "ok": false,
  "error": "Missing API key — pass it as an x-api-key header or an api_key query parameter.",
  "meta": { "tool": "whois", "version": "v1" }
}

Authentication example

curl "https://netsh.io/api/v1/whois?domain=example.com" \
  -H "x-api-key: YOUR_API_KEY"