API documentation

Everything on the site — scores, confidence intervals, ranks, movement, citations — as JSON, updated weekly. Get an API key ($199/mo, 10,000 requests/month). The free CSV stays free.

Authentication

curl https://helloranked.com/api/v1/industries \
  -H "Authorization: Bearer hr_live_..."

Keys are shown once at creation and stored only as hashes. Manage them in your dashboard. Limits: 10,000 requests/month (429 beyond), key revocation is immediate (401).

Endpoints

Endpoint	Returns
`GET /api/v1/industries`	All industries with their latest run.
`GET /api/v1/industries/{slug}/leaderboard`	Latest leaderboard: global scores, CIs, ranks, per-provider metrics.
`GET /api/v1/industries/{slug}/movers`	Week-over-week movement with significance flags.
`GET /api/v1/brands/{slug}/history`	Full weekly score history for a brand.
`GET /api/v1/brands/{slug}/citations`	Domains cited by search-backed answers mentioning the brand.

Example response

{
  "industry": "crm",
  "run": { "id": 5, "date": "2026-07-07", "partial": false },
  "leaderboard": [
    {
      "brand": "hubspot", "name": "HubSpot", "rank": 1,
      "global_score": 71.5, "ci_low": 69.7, "ci_high": 73.2,
      "providers": [
        { "provider": "openai", "score": 72.1, "mention_rate": 0.86, ... }
      ]
    }
  ]
}

Semantics match the public site: scores are 0–100 with 95% bootstrap CIs; movement rows carry a significant flag — treat non-significant deltas as noise (we do). Full definitions on the methodology page.