Getting started¶
1. Register a client¶
One POST gives you a Free-tier API key. No email confirmation required.
curl -X POST https://api.nationkit.site/v1/clients/register \
-H "Content-Type: application/json" \
-d '{"name": "My App", "email": "me@example.com", "password": "s3cret", "companyName": "ACME"}'
{
"clientId": "0193…-uuid",
"name": "My App",
"email": "me@example.com",
"companyName": "ACME",
"tier": "Free",
"apiKey": "nk_live_8b3c…68",
"requestsPerMin": 60, "requestsPerDay": 5000, "requestsPerMonth": 50000
}
The full key is shown exactly once
Keys are stored hashed (SHA-256). After registration only the key prefix (first 12 characters) is ever visible again — in the dashboard and on login. Store the full key in your secrets manager immediately.
Already registered? Retrieve your account (key prefix only) with
POST /v1/clients/login using the same credentials.
2. Call the API¶
Every data endpoint expects your key in the X-API-Key header — never as a
query parameter.
3. Pick your SDK¶
The SDK page has install + usage snippets for 13 languages.
Every SDK implements the same contract: 14 endpoints, Page<T> paging and typed
errors for 401/404/429 — pinned by recorded fixtures in CI.
Where to go next¶
- API reference — every endpoint, parameter and response shape
- Errors & rate limits — the four error types and your quotas
- Data coverage — what's inside DZ and TN, and the data licenses