Order Management System REST API - Event Controller
The event/toposition
URL provides access to the events generated by OMS views.
Retrieves the events between a timestamp and a position in the event stream.
Section titled “Retrieves the events between a timestamp and a position in the event stream.”GET /event/between
Retrieves the events between a timestamp and a position in the event stream for the requested views.
Query Parameters
Section titled “Query Parameters”Parameter | Expected | Description |
---|---|---|
from | Optional | An ISO8601 date and time. The earliest timestamp to return (exclusive). If omitted, defaults to the beginning of time. |
to[<seq>] | Required | Describes the ending position of a sequence (inclusive). Repeat for each feed involved in OMS. |
count | Optional | The maximum number of records to return. If omitted, returns every record. |
for | Optional | The SubscriptionType to return events for. Repeat for additional views. If omitted, supplies events for all views. |
owner | Optional | The Owner ID to return events for. Repeat for additional owners. If omitted, returns all owners. |
account | Optional | A Trading Account ID of the format <owner>/<account> to return events for. Repeat for additional accounts. If omitted, returns all accounts. |
snapshot | Optional | True to include starting snapshot events for the requested views. If omitted or false, no snapshot is supplied. |
When using the owner
and account
filters, an event must match a listed owner OR a listed account to be returned.
Eg: owner=A&account=B%2FC
will return events for all Accounts with Owner A, plus events for Account B/C
.
Response
Section titled “Response”Code | Status | Description |
---|---|---|
200 | Success | Content is an array of EventMessage objects. |
403 | Failure | You supplied invalid owner or account values. |
Examples
Section titled “Examples”In this example, we retrieve the first 100 updates after a timestamp:
curl --oauth2-bearer $AccessToken http://oms.hub/event/toposition?from=20250101T000000Z&to[prodigy]=20&to[oms]=200&to[foundry]=10&count=100&for=Transactions