Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Events

Subscribe to Non-Trading Activities Events (SSE)

The Events API provides event push as well as historical queries via SSE (server sent events).

You can listen to non-trading activities updates as they get processed by our backoffice, for both end-user and firm accounts.

Historical events are streamed immediately if queried, and updates are pushed as events occur.

You can listen to when NTAs are pushed such as CSDs, JNLC (journals) or FEEs.

Query Params Rules:

  • since required if until specified
  • since_id required if until_id specified
  • since_ulid required if until_ulid specified
  • since, since_id or since_ulid can't be used at the same time Behavior:
  • if since, since_id or since_ulid not specified this will not return any historic data
  • if until, until_id or until_ulid reached stream will end (status 200)'
get/v1/events/nta

Query parameters

idstring
sincestring date

Format: YYYY-MM-DD

untilstring date

Format: YYYY-MM-DD

since_idinteger
until_idinteger
since_ulidstring ulid
until_ulidstring ulid
include_preprocessingboolean
group_idstring uuid

ID used to link activities who share a sibling relationship

Response

OK

account_idstring uuid required

Account UUID

atstring date-time required

Timestamp of when the event was emitted

cusipstring

CUSIP the event is associated with, not present when no CUSIP is applicable

descriptionstring required

Additional information about the event, empty string if not applicable

entry_typestring required

Type of entry for e.g JNLC, FEE, INT, DIVNRA etc

event_idinteger

Monotonically increasing 64bit integer

event_ulidstring ulid required

lexically sortable, monotonically increasing character array

idstring uuid required

Record UUID

net_amountnumber required

Net amount if applicable, 0 otherwise

per_share_amountnumber

Per share amount if applicable

pricestring decimal

Price if applicable.

qtynumber

Quantity of the stock affected. 0 for cash events

settle_datestring date required

Date of settlement if applicable

status'executed' | 'correct' | 'canceled'

Status of the event

symbolstring

Symbol the event is associated with, empty string when no symbol is applicable

system_datestring date required

Date of the event recorded in the system

Example response

{
  "cusip": "037833100",
  "description": "Example description",
  "entry_type": "JNLC",
  "net_amount": 1,
  "per_share_amount": 0.3,
  "price": "0.38921",
  "status": "executed",
  "symbol": "AAPL"
}