API Reference
News Impact API
Query scored news articles and their impact signals via the REST API.
Base URL
All public API endpoints are served under /api/v1/. Requests are authenticated with an API key — see the API Keys doc for how to generate one.
News Impact Heads API Summary
Base URL
- All endpoints are under:
/api/v1/
Authentication
- Header:
Authorization: Bearer st_live_<your_key> - Required scope for these endpoints:
news:read - Rate limit: 60 requests/minute per key
List impact heads
Endpoint
GET /api/v1/news/impact-heads
Query parameters
limit(int, 1–100, default 20): Results per pageoffset(int, default 0): Pagination offsetsort(string):column:direction, e.g.confidence:desc,created_at:asc- Sortable columns:
id,created_at,confidence,article_id,cluster fields(string): Comma-separated fields to include in each iteminclude_article(boolean, default true): Whether to embed the source article objectarticle_id(int): Filter by article IDcluster(string): Filter by cluster nameticker(string): Filter by ticker on the source articlefrom(ISO 8601): Filtercreated_at >= fromto(ISO 8601): Filtercreated_at <= tomin_confidence(number, 0–1): Minimum confidence score
Example request