Endpoints

Five data endpoints plus a public health check. All data endpoints require a Bearer API key.

GET/healthPublic

Service liveness check. Unauthenticated.

Response (200)

{
  "status": "ok",
  "service": "intel-api",
  "version": "1.0.0"
}

GET/v1/companies/{normalized_name}Auth required

Latest research snapshot for a single company.

Parameters

Name	In	Description
normalized_name	path	Slug format, e.g. "starbucks" or "the-cheesecake-factory". Lowercase, hyphenated.

Example

curl https://api.iqintel.crelytic.ai/v1/companies/starbucks \
  -H "Authorization: Bearer iqi_live_..."

Response (200)

{
  "normalized_name": "starbucks",
  "display_name": "Starbucks Corporation",
  "industry": "Coffee & Quick-Service Restaurants",
  "composite_score": 84,
  "letter_grade": "B",
  "dimension_scores": {...},
  "strengths": [...],
  "risks": [...],
  "captured_at": "2026-04-17T..."
}

GET/v1/companies/{normalized_name}/historyAuth required

Time series of composite scores for drift / trend analysis.

Parameters

Name	In	Description
normalized_name	path	Company slug.
days	query	Window size (1-730, default 365).

Example

curl 'https://api.iqintel.crelytic.ai/v1/companies/starbucks/history?days=180' \
  -H "Authorization: Bearer iqi_live_..."

Response (200)

{
  "normalized_name": "starbucks",
  "points": [
    { "scored_at": "...", "composite_score": 87, "letter_grade": "B", "confidence": "High" },
    { "scored_at": "...", "composite_score": 84, "letter_grade": "B", "confidence": "High" }
  ]
}

GET/v1/companies/{normalized_name}/benchmarksAuth required

Industry peer benchmarks — percentile bands, dimension averages — for the company's industry.

Parameters

Name	In	Description
normalized_name	path	Company slug.

Example

curl https://api.iqintel.crelytic.ai/v1/companies/starbucks/benchmarks \
  -H "Authorization: Bearer iqi_live_..."

Response (200)

{
  "normalized_name": "starbucks",
  "industry": "Coffee & Quick-Service Restaurants",
  "benchmarks": [
    {
      "industry": "...",
      "period_start": "2026-04-01",
      "period_end": "2026-06-30",
      "composite_score_p25": 78.5,
      "composite_score_p50": 84.0,
      "composite_score_p75": 89.5,
      "n_companies": 12,
      "n_reports": 15
    }
  ],
  "suppressed_quarters_below_min_n": 2,
  "min_n_threshold": 3
}

GET/v1/searchAuth required

Prefix-match lookup against the canonical company registry.

Parameters

Name	In	Description
q	query	Query string (2-100 chars). Matches normalized_name prefix.
limit	query	Max results (1-100, default 20).

Example

curl 'https://api.iqintel.crelytic.ai/v1/search?q=sta&limit=5' \
  -H "Authorization: Bearer iqi_live_..."

Response (200)

{
  "query": "sta",
  "results": [
    { "normalized_name": "starbucks", "display_name": "Starbucks Corporation", "industry": "..." }
  ]
}

GET/v1/markets/{state}Auth required

State-level research-event volume. Weeks below the minimum-N threshold are suppressed.

Parameters

Name	In	Description
state	path	Two-letter USPS state code, e.g. FL, CA.
weeks	query	Lookback window in weeks (1-52, default 8).

Example

curl 'https://api.iqintel.crelytic.ai/v1/markets/FL?weeks=4' \
  -H "Authorization: Bearer iqi_live_..."

Response (200)

{
  "state": "FL",
  "weeks": [
    {
      "period_start": "2026-04-13",
      "period_end": "2026-04-19",
      "property_state": "FL",
      "n_events": 8,
      "n_unique_companies": 6,
      "top_industries": [{ "industry": "QSR", "n": 4 }]
    }
  ],
  "min_n_threshold": 5,
  "weeks_suppressed": 2
}

← Rate limits Errors →