Deprecated
v1.1.0 - Single-Event Headlines Endpoint
6 months ago by ReadMe GitHub Action
New per-event headlines endpoint (/headlines/event/{event_id}) replacing the batch endpoint for significantly improved caching performance. The batch /headlines/events endpoint is deprecated with a planned removal date of 2025-10-15.
Added
- New single-event headlines endpoint
/v1/headlines/event/{event_id}for retrieving headlines for a specific event- Benefits: Responses can be cached per event ID, resulting in better cache hit rates and faster response times
- Usage:
GET /v1/headlines/event/123returns headlines for event ID "123"
Deprecated
- Batch headlines endpoint
/v1/headlines/eventswill be removed on 2025-10-15- Migration Strategy:
- Option 1 - For insights workflows: Use
show_events=trueparameter on insights endpoints to get events and headlines together- Before:
GET /insights/analyst/{ticker}→GET /headlines/events?event_ids=123,456 - After:
GET /insights/analyst/{ticker}?show_events=true(single request with events and headlines)
- Before:
- Option 2 - For direct event queries: Use individual calls to
/v1/headlines/event/{event_id}- Before:
GET /v1/headlines/events?event_ids=123,456 - After:
GET /v1/headlines/event/123andGET /v1/headlines/event/456
- Before:
- Option 1 - For insights workflows: Use
- Note: The deprecated endpoint remains fully functional until removal date
- Migration Strategy:
