Skip to main content

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.

Standard error format

All errors return a JSON body:
{
  "error": "string",
  "message": "Human-readable description"
}

Status codes

CodeNameWhen it occurs
200OKRequest succeeded
400Bad RequestMissing or invalid parameters
401UnauthorizedAPI key missing, invalid, or revoked
403ForbiddenYour plan doesn’t include this feature
404Not FoundResource doesn’t exist or doesn’t belong to your account
429Too Many RequestsRate limit exceeded — back off and retry
500Internal Server ErrorSomething went wrong on NearIQ’s side

429 — Rate limiting

When you exceed the rate limit, the response includes headers telling you when to retry:
HTTP/1.1 429 Too Many Requests
Retry-After: 30
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
Implement exponential backoff: wait Retry-After seconds, then retry. Don’t hammer the API — repeated 429s may result in temporary key suspension.

403 — Plan restrictions

{
  "error": "Forbidden",
  "message": "API access requires a Growth plan or higher.",
  "planRequired": "growth"
}
Upgrade your plan at app.neariq.io/settings/billing.