Rest API

Get Events

Fetch events by equity, date range, etc.

GET /events

ParameterTypeDataTypeDefaultDescription
start_datequerydatetimetodayOnly return events after this date
end_datequerydatetime+7 daysOnly return events before this date
todayquerybooleannullOnly return events for today
equity_idqueryintegernullOnly return events for this equity
company_idqueryintegernullOnly return events for this company
linguisticsquerybooleanfalseWhether to include linguistics metadata in the response
pricingquerybooleanfalseWhether 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"}
)
Previous
Get Webhook