Skip to main content

​
General

The APIs are designed to provide a current snapshot of each category of data, and then streaming events that contain changes to the data. These APIs are not intended to be used as REST APIs where the consumer makes repeated requests to get the “current” state of data. This is a streaming API, and consumers must implement their integrations to support receiving streams of events instead of repeatedly asking for snapshots of data.

​
Caching

It is expected that API consumers will implement appropriate caching mechanisms in their software implementations, along with appropriate limits on the rate at which requests for data are made to the API. Historical data can be cached indefinitely. Participant data such as positions, balances, orders, etc. should be reasonably cached by the caller to limit the potential abuse of their implementation. This could result in high numbers of requests to the API for the same data where that data is not changing at a rate commensurate with the rate of requests to refresh the data. Abuse of the API or implementations which do not have a reasonable caching system implemented may result in usage restrictions being placed upon the caller’s API credentials.

​
Events

Most commands to retrieve a current snapshot of data also have corresponding events for notifications of changes in that data. Consumers of this API are expected to subscribe to those events and maintain a current state of data instead of making repeated calls to retrieve the data snapshots. If a consumer of this API is observed to be making excessive repeated calls to retrieve data that is updated through the events, usage restrictions may be placed upon the API credentials being used.