Skip to content

Order Management System REST API - Event Controller

The event/fromposition URL provides access to the events generated by OMS views.

Retrieve events between a position and a timestamp

Section titled “Retrieve events between a position and a timestamp”

GET /event/fromposition

Retrieves the events between a position and a timestamp in the event stream for the requested views.

ParameterExpectedDescription
from[<seq>]OptionalAn integer. The starting position of a sequence (exclusive). Repeat for each feed involved in OMS. If omitted, defaults to 0 for all feeds.
toOptionalAn ISO8601 date and time. The most recent timestamp to return (inclusive). If omitted, defaults to now.
countOptionalAn integer. The maximum number of records to return. If omitted, returns every record.
forOptionalThe SubscriptionType to return events for. Repeat for additional views. If omitted, supplies events for all views.
ownerOptionalThe Owner ID to return events for. Repeat for additional owners. If omitted, returns all owners.
accountOptionalA Trading Account ID of the format <owner>/<account> to return events for. Repeat for additional accounts. If omitted, returns all accounts.
snapshotOptionalTrue 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.

CodeStatusDescription
200SuccessContent is an array of EventMessage objects.
403FailureYou do not have permission to read the update stream.

In this example, we retrieve the first 100 Transaction events between the most recent events seen for each sequence, and a set timestamp.

Terminal window
curl --oauth2-bearer $AccessToken http://oms.hub/event/fromposition?from[prodigy]=1&from[oms]=100&from[foundry]=10&to=20050101T123000Z&count=100