Skip to navigation
REST APITradingAlgos

List an instance's orders

Lists exactly the orders the instance placed, live and terminal — the same rows GET /orders serves, each carrying algoInstanceId and a userId of 0. Any other instance is 404. Newest first: by orderId, descending.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired

The instance’s id — a positive 32-bit integer the platform minted; the value an algo’s orders carry as algoInstanceId.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

limitintegerOptional>=1

Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.

cursorstringOptional<=2048 characters

nextCursor or prevCursor from a previous page, sent with the same filters. One that does not decode, or that came from another query, is refused 400 INVALID_CURSOR: drop it and fetch the first page.

includeenumOptional

total adds the exact number of rows matching the filters.

Allowed values:

Response

A page of the orders the instance placed, newest first — all of them unless limit is sent; the position it was read at rides the body and the headers.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

itemslist of objects
asOfSeqTsNsstring or nullOptionalformat: "^[0-9]+$"

The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.

nextCursorstring or nullOptional

Pass as cursor for the next page. Null on the last page.

prevCursorstring or nullOptional

Pass as cursor for the previous page. Null on the first page.

totalinteger or nullOptional

Exact count matching the filter. Null unless include=total.

Errors

400
List Instance Orders Algos Request Bad Request Error
401
List Instance Orders Algos Request Unauthorized Error
403
List Instance Orders Algos Request Forbidden Error
404
List Instance Orders Algos Request Not Found Error
503
List Instance Orders Algos Request Service Unavailable Error