Skip to main content
GET
List application margin accounts

Query Parameters

clientId
string
required

Application client ID

Minimum string length: 1
address
string

Filter by wallet address. A wallet with no margin account in the application returns an empty page.

Minimum string length: 1
pageSize
integer<uint32>
default:20

Items per page (max 1000)

Required range: 1 <= x <= 1000
pageToken
string

Pagination cursor with two states:

  • Omitted or empty string (""): start a cursor walk with no prior position.
  • Non-empty: an opaque cursor from a previous response's nextPageToken; results resume immediately after that position.

Ordered by margin account id ascending.

Filters must match the request that produced the token, or the request is rejected 400.

Response

OK

marginAccounts
object[] | null
total
integer<uint32> | null

Number of margin accounts matching the filter, bounded by the server ceiling — a lower bound when totalCapped is true.

Example:

50

pageSize
integer<uint32> | null

Items per page

Example:

20

totalPages
integer<uint32> | null

Number of pages at this pageSize, bounded by the server ceiling — a lower bound when totalCapped is true.

Example:

3

nextPageToken
string | null

Cursor for the next page, minted from the last row of an over-fetched page: this listing is one ordered read, so a page shorter than pageSize proves the walk is exhausted and this is empty.

totalCapped
boolean | null

True when more than the server ceiling of margin accounts matched, so the count stopped at the ceiling and total/totalPages are a lower bound.

Example:

false