Queries one currency’s group borrowing capacity, quantity limits, floating-pool availability and floating/fixed annual rates. Does not submit a loan.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns a MarginX group's available borrowing quantity, precision, borrowing/repayment limits, floating-pool availability and interest-rate quotes for one specified currency. This is a read-only query; it does not submit a loan or reserve borrowing capacity or pool funds.
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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
groupId | string | Yes | Margin group ID, not a DMA account ID or Portfolio ID. A positive integer expressed as a string. |
currency | string | Yes | One currency symbol, such as USDT, BTC or ETH. Input is case-insensitive; response values are uppercase. Omission does not request all currencies. Comma-separated currency lists are not supported. |
Borrowing capacity belongs to the group, not an individual member. Do not supply memberId, primeType, venue or quoteCurrency. Choose a receiving member when submitting a borrowing request, not when querying this endpoint.
Reading the result
limits.maxAvailableBorrowis the group's remaining borrowing quantity in the requested currency, taking existing borrowing and risk limits into account. It is not the floating-pool balance or the configured group ceiling.- A borrowing request must satisfy the quantity precision, minimum borrowing amount and available borrowing quantity. A positive available quantity below the minimum request amount does not mean a request can be submitted successfully.
- For floating borrowing, check
floating.enabledandfloating.poolAvailableAmount. An enabled pool can have a balance of"0". An amount above the available pool balance may require manual processing; it is not automatically a group-capacity error. Pool availability is not a guarantee that funds have arrived. - For fixed borrowing, choose a term from
fixed.termsand use itstermDaysin the borrowing request. The floating-pool balance does not determine fixed-term automatic disbursement. - Different currencies share the group's borrowing capacity; their maxima are not independent amounts that can all be borrowed simultaneously. Capacity, pool funds, receiving member and route are checked again on submission.
Empty results and unavailable group quotes
A successful query without a matching borrowable currency configuration returns data.list: []. This is different from an invalid parameter error.
Every group has members, but a group whose members have zero assets may have no borrowing quote data. The endpoint may then return code: -1, message: "Group borrow quote unavailable", rather than a zero-valued quote. This does not mean the group has no members or was deleted.
Response fields
All quantities below are in currency, not a separate valuation currency. Quantities and interest rates are decimal strings; precision and termDays are integers.
| Field | Type | Description |
|---|---|---|
code | integer | 200 means success; any other value indicates an error. |
message | string | Result message. |
data.groupId | string | Queried margin group ID. |
data.list | array of objects | Zero or one matching borrowable-currency entry. |
Currency entry: data.list[]
data.list[]| Field | Type | Description |
|---|---|---|
currency | string | Currency symbol. |
currencyDetails | object or null | Currency metadata; see below. |
limits | object | Quantity precision and group-level borrowing/repayment limits. |
floating | object | Floating borrowing availability, pool funds and annual interest rates. |
fixed | object | Available fixed-term quotes. |
currencyDetails
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. |
limits
limits| Field | Type | Description |
|---|---|---|
precision | integer | Maximum decimal places allowed in borrowing/repayment quantities. |
maxAvailableBorrow | string | Maximum quantity the group can currently borrow in this currency. |
minBorrowAmountPerRequest | string | Minimum borrowing quantity per request. |
maxBorrowPerGroup | string | Configured borrowing ceiling per group for this currency, not remaining capacity. |
minRepayAmountPerRequest | string | Minimum repayment quantity per request. |
floating
floating| Field | Type | Description |
|---|---|---|
enabled | boolean | Whether floating borrowing is currently open for the currency. This does not mean the pool has funds available. |
poolAvailableAmount | string or null | Current floating-pool quantity available for automatic disbursement, not total lending-pool size. "0" means no available pool funds; null means unavailable/unknown. |
currentAnnualInterestRate | string or null | Currently effective floating annual rate. For example, "0.1447" means 14.47% annually. null when unavailable or not applicable. |
nextAnnualInterestRateEstimate | string or null | Forecast annual rate for the next UTC 00:00, updated hourly. null when no forecast is available. |
The effective floating rate is set daily at UTC 00:00. Hourly forecast updates do not immediately change the effective rate; the final rate is determined at UTC 00:00. Both fields are annual rates, not daily rates.
fixed.terms[]
fixed.terms[]Only available fixed-term options are returned. No available fixed terms yields terms: [].
| Field | Type | Description |
|---|---|---|
termDays | integer | Fixed borrowing duration in days, such as 30, 60 or 180. Use the returned value when applying. |
annualInterestRate | string or null | Annual quote for this term; null when temporarily unavailable. The actual fixed rate is locked at disbursement. |
Success, empty-list 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 |
|---|---|---|
1001 | Missing groupId or currency. Observed message: Invalid Constraints Required [{groupId}] or Invalid Constraints Required [{currency}]. | Supply both required parameters. |
100400 | Empty/whitespace parameter, malformed currency or invalid group ID. | Use one currency symbol and a valid group ID. |
-1 | Group or quote data unavailable. Observed messages: Group unavailable and Group borrow quote unavailable. | Check the group ID. A group whose members have zero assets may have no quote data. |
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. |