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

Authentication

Authentication

The GEOCitation API uses API keys passed via the X-API-Key header.

Creating an API Key

Navigate to the API Keys page in your dashboard. Click "Create new key", give it a name, and optionally set an expiry date and a webhook URL to receive completion notifications.

One-Time Display

Your API key and webhook secret are shown only once at creation. Store them securely — they cannot be retrieved later.

Using the API Key

Pass your key in the X-API-Key header on every request.

bash
curl -X POST https://api.geocitation.io/v1/audits \
  -H "X-API-Key: geo_citation_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "audit_type": "market", "keyword": "seo agency london", "language": "en", "country": "GB" }'
python
import httpx

response = httpx.post(
    "https://api.geocitation.io/v1/audits",
    headers={"X-API-Key": "geo_citation_YOUR_KEY"},
    json={
        "audit_type": "market",
        "keyword": "seo agency london",
        "language": "en",
        "country": "GB",
    }
)
print(response.json())  # {"audit_id": "...", "status": "pending"}

Revoking a Key

You can revoke a key at any time from the API Keys page. Revoked keys return 401 immediately.

json
// Response when using a revoked key
HTTP/1.1 401 Unauthorized
{
  "detail": "Invalid or revoked API key"
}
Previous
Getting Started
Next
Endpoints API