Documentation Index
Fetch the complete documentation index at: https://docs.neariq.io/llms.txt
Use this file to discover all available pages before exploring further.
API key authentication
Include your API key in every request using theX-NearIQ-Key header:
Key format
API keys follow this format:niq_a3f7c92b1d4e8f06b2c5a9e7d1f3b8c2
Keys are case-sensitive and must be kept secret. Do not expose them in client-side code, public repositories, or URLs.
Generating and revoking keys
Keys are managed in Settings → API:- Generate — creates a new key. The full key is only shown once at creation.
- Revoke — immediately invalidates the key. All requests using it will return
401.
Key scopes
API keys can be limited to the parts of the API an integration needs. Existing keys and keys created without an explicit scope list receive all scopes.| Scope | Allows |
|---|---|
competitors:read | Business profile, competitors, reviews, snapshots, GBP health, gap analysis, AI visibility, content history, behavioral signals, and GBP insights endpoints |
alerts:read | Alert list endpoints |
export | Account export endpoint |
webhooks:manage | Create, list, update, and delete webhook endpoints |
usage:read | Usage and API key metadata endpoints |
content:write | Generate and refine Content Studio drafts |
Error responses
| Status | Meaning |
|---|---|
401 Unauthorized | Key is missing, invalid, or revoked |
403 Forbidden | Key is valid but your plan or key scopes do not allow the endpoint |
Security best practices
- Store keys in environment variables, never hardcoded
- Use one key per integration so you can revoke selectively
- Rotate keys periodically
- Never log or print API keys