Get MarginX Outstanding Debts

Time	Status	User Agent
Retrieving recent requests…

Returns a paginated list of outstanding MarginX debts across your groups, or for one specified group. A debt remains outstanding while either principal or interest is unpaid: a record with zero principal and positive interest is still returned.

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 type	Can call	Scope
Main User Level API key (also the Main Portfolio key)	Yes	Outstanding debts in margin groups belonging to the main user.
Sub-user Level API key	No	Not supported.
Dedicated Sub Portfolio Level API key	No	Not supported.
Exchange-native API key	No	Use an LTP Main User Level API key.

Query parameters

All query parameters are optional.

Name	Type	Default	Description
`page`	integer	`1`	One-based page number. Zero, negative or empty values use `1`.
`pageSize`	integer	`20`	Records per page, maximum `1000`. Zero, negative or empty values use `20`; values above `1000` are rejected.
`groupId`	string	No filter	Exact margin group ID. Omit to query all your groups. If supplied, it must be a positive integer expressed as a string. Empty/whitespace values and group names are invalid. Not a DMA account ID or Portfolio ID.
`quoteCurrency`	string	`USD`	Valuation currency: `USD`, `BTC` or `USDT`. Input is case-insensitive; response values are uppercase. An empty value is invalid.
`sortBy`	string	`outstandingPrincipal`	`outstandingPrincipal`, `outstandingInterest` or `currency`. Empty uses `outstandingPrincipal`.
`sortDirection`	string	`DESC`	`ASC` or `DESC`. Input is case-insensitive. Empty uses `DESC`.

Pagination and filtering

Pagination uses the same rules as the other MarginX list endpoints. Non-integer or out-of-range integer values return 1002; an integer pageSize above 1000 returns 100400.
Records are sorted before pagination. A page beyond the end returns list: [] and retains the matching totalSize. There is no pageNum field.
A valid group with no outstanding debts returns success with totalSize: 0 and list: []. An unavailable or deleted group returns an error instead.
outstandingPrincipal and outstandingInterest sort the debt quantities, not their valuation fields. Different debt currencies retain their own quantity units.

Response fields

Field	Type	Description
`code`	integer	`200` means success; any other value indicates an error.
`message`	string	Result message.
`data.page`	integer	Page number used.
`data.pageSize`	integer	Page size used.
`data.totalSize`	integer	Total matching debt records, not just the number on this page.
`data.list`	array of objects	Outstanding debt records on this page.

Debt fields: `data.list[]`

Quantities, valuations and annual interest rates are decimal strings. IDs are strings. Timestamps are Unix milliseconds.

Field	Type	Description
`debtId`	string	Debt identifier used when submitting repayment. Not an order, group or member ID.
`groupId`	string	Margin group containing this debt.
`groupName`	string	Group name.
`primeType`	string	Account family of the member carrying the debt: `dma` or `rapidx`.
`memberId`	string	DMA account ID or RapidX Portfolio ID of the member carrying the debt.
`venue`	string	Member's exchange. For RapidX this is the specific Portfolio venue, such as `BINANCE` or `OKX`.
`currency`	string	Currency in which the debt is denominated.
`currencyDetails`	object or null	Currency metadata; see below.
`interestRateType`	string	`FLOATING` or `FIXED`.
`termDays`	integer or null	Fixed duration in days. `null` for floating borrowing, not `0`.
`maturityDate`	integer or null	Fixed debt's maturity time in Unix milliseconds. `null` for floating borrowing.
`annualInterestRate`	string	Applicable annual rate as a decimal; for example, `"0.14470000"` means 14.47% annually. Floating debt uses the current rate; fixed debt uses its fixed rate.
`outstandingPrincipal`	string	Unpaid principal quantity, in `currency`. Can be `"0"` while interest is still unpaid.
`outstandingInterest`	string	Unpaid interest quantity, in `currency`.
`quoteCurrency`	string	Currency used for valuations: `USD`, `BTC` or `USDT`.
`outstandingPrincipalValue`	string	Unpaid principal valuation, in `quoteCurrency`.
`outstandingInterestValue`	string	Unpaid interest valuation, in `quoteCurrency`.

Changing quoteCurrency changes the two ...Value fields, not the principal or interest quantities denominated in currency.

`currencyDetails`

Field	Type	Description
`id`	integer	Currency identifier.
`iconUrl`	string	Currency icon URL.
`currencyName`	string	Currency display name.
`slug`	string	Currency slug.
`referenceAssetId`	integer or null	Reference asset identifier.
`multiplier`	number or null	Conversion multiplier to the reference asset.

The response panel includes multiple debt records, including an interest-only balance, plus empty-list and error examples.

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.

Code	When it occurs	What to do
`1002`	A pagination value cannot be converted to a supported integer.	Send integer values; the message identifies the affected field.
`100400`	Invalid group ID, `pageSize` above `1000`, or invalid currency/sort parameters.	Use the supported values above. Omit `groupId` for all groups; do not send an empty value.
`-1`	The requested group is unavailable; observed message: `resource unavailable`.	Check the group ID and whether the group still exists.
`2000`	Signature verification fails.	Check the signature and authentication headers.
`2003`	The calling API key level is not allowed.	Use a Main User Level API key.
`2004`	The key lacks a required permission.	Use a key with `READ` permission.
`100429`	Rate limit exceeded.	Reduce the request rate.