2GeoCitationDocs
DocsBack to site
⌘K

API Documentation

v1.0

DOCUMENTATION

Introduction
Key Concepts
Getting Started
Authentication

RESOURCES

Endpoints API
Data Models
Market Audit
Webhooks
Errors
Glossary
Use Cases
Rate Limits & Quota
Support

Errors

Errors

The GEOCitation API uses standard HTTP status codes.

CodeMeaningWhat to do
202AcceptedAudit queued. Wait for webhook or poll /v1/audits/{id}/status.
400Bad RequestCheck your request body — e.g. disallowed URL.
401UnauthorizedYour X-API-Key is missing, invalid, or revoked.
402Payment RequiredQuota exhausted or no active plan. Upgrade your plan on the billing page.
404Not FoundThe audit_id doesn't exist or doesn't belong to your account.
409ConflictThe audit is not in a state that allows this operation (e.g. retry on an already-completed audit).
422Unprocessable EntityValidation error. Check audit_type, keyword length, country codes.
429Too Many RequestsRate limit hit. Retry after the Retry-After header value.
500Internal Server ErrorUnexpected server error. Retry with exponential backoff.
502Bad GatewayOutput temporarily malformed. Retry the request.
503Service UnavailableService temporarily unavailable. Retry with backoff.

Rate Limiting

The API allows 100 requests/minute globally and 20 audits/hour per key. Exceeding these limits returns 429.

Error Format

Most errors return a plain detail message. Quota-related errors (402) return a structured detail object with additional context.

json
// Most errors — plain detail message
{
  "detail": "Invalid or revoked API key"
}

// Quota errors — structured detail
{
  "detail": {
    "error": "quota_exceeded",
    "used": 100,
    "limit": 100,
    "plan": "starter"
  }
}
Previous
Webhooks
Next
Glossary