Get Margin Group Members

Returns paginated DMA and RapidX members with their asset and debt valuations, including zero-asset members.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a paginated list of a MarginX group's members and their asset and debt valuations. DMA accounts and RapidX Portfolio venues are returned together in data.list.

Rate limit: 10 requests per minute per API key.

API key access

Requires a signed LTP Open API request with READ permission. See Authentication.

API key typeCan callScope
Main User Level API key (also the Main Portfolio key)YesMembers of margin groups belonging to the main user.
Sub-user Level API keyNoNot supported.
Dedicated Sub Portfolio Level API keyNoNot supported.
Exchange-native API keyNoUse an LTP Main User Level API key.

Parameters

NameInTypeRequiredDefaultDescription
groupIdPathstringYes—Margin group ID from Get Margin Groups or Create Margin Group. Not a DMA account ID or Portfolio ID. A positive integer expressed as a string.
pageQueryintegerNo1One-based page number. Zero, negative or empty values use 1.
pageSizeQueryintegerNo20Records per page, maximum 1000. Zero, negative or empty values use 20; a value above 1000 is rejected.
quoteCurrencyQuerystringNoUSDValuation currency: USD, BTC or USDT. Input is case-insensitive; response values are uppercase. Empty is invalid.
sortByQuerystringNototalValuetotalValue, borrowed, interest, adjustedEquity or accountName. Empty uses totalValue.
sortDirectionQuerystringNoDESCASC or DESC. Input is case-insensitive. Empty uses DESC.

Pagination and sorting

  • Non-integer or out-of-range integer pagination values return 1002. An integer pageSize above 1000 returns 100400.
  • A page beyond the last page returns list: [] while retaining the group's totalSize. There is no pageNum field.
  • Members are sorted before pagination. Equal sort values use the member identity (primeType, memberId, venue) as a stable secondary key.
  • Invalid sort fields, directions or valuation currencies are rejected, not silently replaced with defaults.
  • Retrieve every page when you need the complete membership. Do not submit only one page as the complete member set when updating a group.

Member identity and zero assets

A DMA member is identified by memberId, its DMA account ID. A RapidX member is identified by memberId (Portfolio ID) plus venue; the same Portfolio's Binance and OKX venues count as two members.

Every group has at least one member. Members with zero assets are still returned with zero amounts. This endpoint can return those members even when Get Margin Group Details has no asset/risk data and returns an error.

Response fields

FieldTypeDescription
codeinteger200 means success; any other value indicates an error.
messagestringResult message.
data.pageintegerPage number used.
data.pageSizeintegerPage size used.
data.totalSizeintegerTotal member records in the group, not just the current page.
data.listarray of objectsMembers on this page. Empty when the requested page is beyond the end.

Member fields: data.list[]

Monetary fields are decimal strings valued in quoteCurrency, not quantities of an individual asset. Group-level borrowing capacity and risk metrics are not returned here.

FieldTypeDescription
memberIdstringDMA account ID or RapidX Portfolio ID, according to primeType. Not a margin group ID.
primeTypestringAccount family: dma or rapidx.
venuestringMember's exchange, such as BINANCE, OKX or BYBIT. For RapidX, this identifies the Portfolio's exchange venue, not the value RAPIDX.
accountNamestringAccount/Portfolio display name. May also be populated for DMA accounts; empty when unavailable.
accountNotestringAccount/Portfolio note; empty when unavailable.
portfolioTypestringMAIN or SUB for a RapidX Portfolio; empty string for DMA.
quoteCurrencystringCurrency used for the monetary valuations: USD, BTC or USDT.
totalValuestringMember's asset valuation.
totalDebtstringMember's outstanding principal and interest valuation.
borrowedstringMember's outstanding principal valuation.
intereststringMember's outstanding interest valuation.
adjustedEquitystringMember's equity after collateral adjustments.

Success, beyond-last-page and error examples are available in the response panel.

Error codes

Errors can return HTTP 200 with a non-success JSON code. Check code, not HTTP status alone. See Error Codes for shared errors.

CodeWhen it occursWhat to do
1002A pagination value cannot be converted to a supported integer, such as abc, 1.5 or an out-of-range integer.Send integer values. The message identifies the affected field.
100400Invalid group ID, pageSize above 1000, or an invalid currency, sort field or direction.Use the supported values above.
-1The group is unavailable; observed message: Group unavailable.Check the group ID and its availability to the main user.
2000Signature verification fails.Check the signature and authentication headers.
2003The calling API key level is not allowed.Use a Main User Level API key.
2004The key lacks a required permission.Use a key with READ permission.
100429Rate limit exceeded.Reduce the request rate.
Path Params
string
required

Margin group ID, not a DMA account or Portfolio ID. Positive integer expressed as a string.

Query Params
integer
Defaults to 1

One-based page number; non-positive or empty values use 1. Invalid integer format or range returns 1002.

integer
≤ 1000
Defaults to 20

Records per page; non-positive or empty values use 20. More than 1000 returns 100400.

string
enum
Defaults to USD

Valuation currency. Input is case-insensitive. Empty is invalid; omit to use USD.

Allowed:
string
enum
Defaults to totalValue

Member sort field. Empty uses totalValue. Equal values use the member identity as a stable secondary key.

Allowed:
string
enum
Defaults to DESC

Sort direction. Input is case-insensitive. Empty uses DESC.

Allowed:
Headers
string
required

Current Unix timestamp in seconds, also used in the signature.

string
required

HMAC-SHA256 hex signature; see Authentication.

string
required

Current Unix timestamp in microseconds.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json