Returns asset, debt, borrowing-capacity and risk data for one MarginX group, without a member list.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the asset valuation, outstanding debt, borrowing capacity and risk metrics of one MarginX margin group. Members are queried separately; this response does not include a member 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 type | Can call | Scope |
|---|---|---|
| Main User Level API key (also the Main Portfolio key) | Yes | 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. |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
groupId | Path | string | Yes | Margin group ID returned by Get Margin Groups or Create Margin Group. Not a DMA account ID or Portfolio ID. Must be a positive integer expressed as a string. |
quoteCurrency | Query | string | No | Valuation currency: USD, BTC or USDT. Defaults to USD. Input is case-insensitive; response values are uppercase. An empty value is invalid. |
Members with zero assets
A group always has at least one member. When its members have zero assets, group asset/risk data may be unavailable, and this endpoint may return code: -1 with message: "MarginX group data unavailable". This does not mean the group has no members or was deleted. The group list and member query can still return the group and its members.
Response fields
All monetary fields below are decimal strings valued in quoteCurrency. They are valuations, not quantities of an individual asset. Ratios are decimal strings, not percentage-formatted text. createdAt is a Unix timestamp in milliseconds.
| Field | Type | Description |
|---|---|---|
code | integer | 200 means success; any other value indicates an error. |
message | string | Result message. |
data.id | string | Margin group ID. |
data.name | string | Group name. |
data.quoteCurrency | string | Currency used for monetary valuations: USD, BTC or USDT. |
data.totalValue | string | Total group asset valuation. |
data.totalDebt | string | Total outstanding principal and interest valuation. |
data.maxAvailableBorrow | string | Available borrowing capacity expressed in the valuation currency, not the quantity of a specific borrowable asset. |
data.borrowed | string | Outstanding principal valuation. |
data.interest | string | Outstanding interest valuation. |
data.adjustedEquity | string | Group equity after collateral adjustments. |
data.im | string | Initial margin requirement, in the valuation currency. |
data.mm | string | Maintenance margin requirement, in the valuation currency. |
data.imr | string or null | Initial margin ratio (IMR). null when unavailable. |
data.mmr | string or null | Maintenance margin ratio (MMR). null when unavailable. |
data.ltv | string or null | Loan-to-value ratio (LTV). null when unavailable. |
data.ltvLimit | string | Group LTV limit; for example, "0.7" means 70%. |
data.riskStatus | string | Group risk status; see below. |
data.createdAt | integer | Group creation time, Unix timestamp in milliseconds. |
Risk status
| Value | Meaning |
|---|---|
MMR_NORMAL | Normal. |
MMR_LOW_RISK | Low risk. |
MMR_MEDIUM_RISK | Medium risk. |
MMR_HIGH_RISK | High risk. |
MMR_LIQUIDATED | Liquidated. |
Success 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.
| Code | When it occurs | What to do |
|---|---|---|
100400 | Invalid group ID (zero, negative, non-integer or out of range), or an empty/unsupported quoteCurrency. | Use a valid group ID and supported currency. |
-1 | The group is unavailable, or no group asset/risk data is available. Observed messages: Group unavailable and MarginX group data unavailable. | Check the ID in the group list. A group whose members have zero assets may have no detail data; this does not mean it has no members. If data is expected but remains unavailable, contact support. |
2000 | Signature verification fails. | Check the authentication headers and signature. |
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. |