Rest API
Get Events
Fetch events by equity, date range, etc.
GET /events
Parameter | Type | DataType | Default | Description |
---|---|---|---|---|
start_date | query | datetime | today | Only return events after this date |
end_date | query | datetime | +7 days | Only return events before this date |
today | query | boolean | null | Only return events for today |
equity_id | query | integer | null | Only return events for this equity |
company_id | query | integer | null | Only return events for this company |
linguistics | query | boolean | false | Whether to include linguistics metadata in the response |
pricing | query | boolean | false | Whether to include price reaction information |
Response
[
{
"event_id": 1234567,
"equity_id": 2761,
"company_id": 9902,
"title": "OFG Q1 Earnings",
"event_date": "2023-04-20T10:00:00-04:00",
"webcast_url": "https://events.q4inc.com/attendee/828509935",
"transcription_status": "archived",
"transcription_version": 0,
"created": "2023-04-20T09:57:36-04:00",
"modified": "2023-04-20T13:08:30-04:00",
"linguistics": {
"topics": [],
"sentiment": {
"average": 0.13217813702848338,
"median": 0.13310034642032326
}
},
"price_data": {
"previous_day_close_price": 24.94,
"current_day_open_price": 24.84000015258789,
"price_at_event_end": 25.65,
"volume_at_event_end": 39111.0
}
}
]
Code Samples
Bash
curl --request GET \
--url 'null/api/speech-v1/events' \
--header 'X-API-Key: xxx'
Python
import requests
requests.get(
"null/api/speech-v1/events",
headers={"X-API-Key": "xxx"}
)