Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.exorde.io/llms.txt

Use this file to discover all available pages before exploring further.

1. Mint a trial key

No sign-up, no credit card. One POST, one key.
curl
curl -X POST https://intel-v1.exorde.io/v1/keys/trial \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'
Python
import httpx

r = httpx.post(
    "https://intel-v1.exorde.io/v1/keys/trial",
    json={"email": "[email protected]"},
    timeout=10,
)
r.raise_for_status()
api_key = r.json()["api_key"]
print(api_key)
Node
const r = await fetch("https://intel-v1.exorde.io/v1/keys/trial", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ email: "[email protected]" }),
});
const data = await r.json();
console.log(data.api_key);
PowerShell
$body = @{ email = "[email protected]" } | ConvertTo-Json
$r = Invoke-RestMethod `
  -Method Post `
  -Uri "https://intel-v1.exorde.io/v1/keys/trial" `
  -ContentType "application/json" `
  -Body $body
$env:EXORDE_API_KEY = $r.api_key
Write-Host $env:EXORDE_API_KEY
Your trial key is Watch-tier, valid 7 days, scoped to the global topic, at 30 requests per minute. Upgrade any time to unlock See and Know tiers — see Tiers and Quotas.

2. Save the key as an environment variable

Every authenticated request uses the X-API-Key header. Export your key once and all examples below will pick it up.
bash / zsh
export EXORDE_API_KEY="exd_trial_..."
PowerShell (session)
$env:EXORDE_API_KEY = "exd_trial_..."
PowerShell (persistent, current user)
[Environment]::SetEnvironmentVariable("EXORDE_API_KEY", "exd_trial_...", "User")
The trending endpoint returns the top terms driving conversation volume on the topic, live.
curl
curl https://intel-v1.exorde.io/v1/topics/global/trending \
  -H "X-API-Key: $EXORDE_API_KEY"
Python
import os, httpx

r = httpx.get(
    "https://intel-v1.exorde.io/v1/topics/global/trending",
    headers={"X-API-Key": os.environ["EXORDE_API_KEY"]},
    timeout=10,
)
r.raise_for_status()
for term in r.json()["terms"][:10]:
    print(term)
Node
const r = await fetch(
  "https://intel-v1.exorde.io/v1/topics/global/trending",
  { headers: { "X-API-Key": process.env.EXORDE_API_KEY } }
);
const data = await r.json();
console.log(data.terms.slice(0, 10));
PowerShell
$r = Invoke-RestMethod `
  -Uri "https://intel-v1.exorde.io/v1/topics/global/trending" `
  -Headers @{ "X-API-Key" = $env:EXORDE_API_KEY }
$r.terms | Select-Object -First 10 | Format-Table

4. Get the live narrative summary

What is actually being said, not just which terms spike. This endpoint is Watch-tier, so your trial key works.
curl
curl https://intel-v1.exorde.io/v1/topics/global/narrative \
  -H "X-API-Key: $EXORDE_API_KEY"
The response contains a short editorial summary of the dominant storyline over the last 24h plus sub-narrative volume weights.

You are live. What next

  • Use cases — brand monitoring, crisis detection, disinformation tracking. Copy-paste recipes.
  • API reference — every endpoint with a live try-it.
  • Topics and watchlists — go beyond curated topics, track your own keywords.
  • Subscriptions — push volume spikes to Slack, Teams, or your own webhook URL.

Handling errors

Every non-2xx response follows a typed envelope with a stable error code. Match on the code, show the message to users.
{
  "error": "upgrade_required",
  "message": "This endpoint requires the 'see' tier",
  "feature": "clusters",
  "current_tier": "watch",
  "required_tier": "see",
  "upgrade": true
}
The two most common errors with a trial key:
CodeMeaningWhat to do
upgrade_requiredThe endpoint needs a higher tierUse Watch-tier endpoints or upgrade
rate_limited30 requests per minute exceededWait the seconds given in Retry-After and retry
See Errors for the full list and Rate limits for the correct backoff pattern.

Rotate or revoke your key

Leaked key? One call.
Rotate
curl -X POST https://intel-v1.exorde.io/v1/keys/rotate \
  -H "X-API-Key: $EXORDE_API_KEY"
Revoke
curl -X DELETE https://intel-v1.exorde.io/v1/keys/current \
  -H "X-API-Key: $EXORDE_API_KEY"
Rotate preserves your topic access and expiry window. Revoke is permanent. See Authentication for the full lifecycle.

Need help