Skip to navigation

List assets

The assets this environment’s instruments are quoted in, settle in and are written on, sorted by symbol unless sort says otherwise. search matches a substring of the symbol. Page with limit and cursor.

Authentication

AuthorizationBearer

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

Query parameters

searchstringOptional

Case-insensitive substring of the symbol.

symbolstringOptional

Only these symbols, case-insensitive; repeat the parameter or comma-separate.

typestringOptional

Only these types: COIN, TOKEN, FIAT, STABLE_COIN, INDEX, COMMODITY, STOCK, OTHER.

sortstringOptional

Comma-separated symbol, assetId or type; prefix - for descending. Default symbol.

limitintegerOptional

Page size, 1-100; larger values are clamped. Default 50.

cursorstringOptional

nextCursor or prevCursor from a previous page, sent with the same filters and sort.

includestringOptional

total adds the exact number of matching assets.

Response

A page of assets.
asOfSeqTsNsstring or nullformat: "^[0-9]+$"

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

itemslist of objects
nextCursorstring or null

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

prevCursorstring or null

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

totalinteger or null

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

Errors

400
List Assets Request Bad Request Error
401
List Assets Request Unauthorized Error
503
List Assets Request Service Unavailable Error