Get Borrowing Currency Configuration

Queries all MarginX borrowing-currency configurations. No query parameters. Pool field rename and value alignment are pending deployment; see the rollout note.

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

Returns the MarginX borrowing-currency configuration, including amount precision, borrowing and repayment limits, floating-pool availability, and floating and fixed-term rate options. This is a configuration view, not a particular group's borrowing capacity.

Rate limit: 10 requests per minute per API key.

Rollout note: poolAvailableAmount replaces poolRemainingAmount. The field rename and value alignment with Get Group Borrowable Assets are pending deployment. Until then, responses may still contain poolRemainingAmount with a different value; use the group endpoint's floating.poolAvailableAmount when checking floating-pool availability.

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)YesMarginX borrowing-currency configuration.
Sub-user Level API keyNoNot supported.
Dedicated Sub Portfolio Level API keyNoNot supported.
Exchange-native API keyNoUse an LTP Main User Level API key.

Request parameters

No query parameters. The endpoint returns all configured currencies without pagination. Supplying currency, groupId, page or pageSize returns 100400.

For a specific group's borrowing capacity in a currency, use Get Group Borrowable Assets.

Response fields

FieldTypeDescription
codeinteger200 means success; any other value indicates an error.
messagestringResult message.
data.listarray of objectsConfigured borrowing currencies.

Currency configuration: data.list[]

Amounts and prices are decimal strings. Amounts are in currency, not USD valuations.

FieldTypeDescription
currencystringCurrency symbol.
currencyDetailsobject or nullCurrency metadata; see below.
precisionintegerMaximum number of decimal places for borrowing and repayment quantities.
canBorrowbooleanCurrency-level borrowing switch. A corresponding enabled borrowing term is also required.
minBorrowAmountPerRequeststring or nullMinimum borrowing quantity per request.
minRepayAmountPerRequeststring or nullMinimum repayment quantity per request.
maxBorrowPerGroupstring or nullConfigured borrowing cap for this currency per group, not the group's remaining borrowing capacity.
poolAvailableAmountstring or nullAvailable quantity in this currency's floating borrowing pool, aligned with floating.poolAvailableAmount in the group endpoint after rollout. Not a fixed-term pool balance or the customer's borrowing limit. See the rollout note for current responses.
pricestring or nullUSD price of one unit of currency.
borrowTermsarray of objectsFloating and fixed-term configurations, including disabled terms.

A currency may have canBorrow=true while floating borrowing is disabled and fixed-term borrowing remains enabled. An enabled floating term can also have zero pool availability. To assess whether a group can borrow, check its currency-specific capacity and limits using the group endpoint.

Borrowing term: borrowTerms[]

FieldTypeDescription
interestRateTypestringFLOATING or FIXED.
termDaysinteger or nullFixed-term duration in days, such as 30, 60 or 180. null for floating borrowing.
annualInterestRatestring or nullCurrent annual rate as a decimal: "0.0401" means 4.01% annually. May be null for an unavailable floating term. A configured rate on a disabled term does not make that term available.
nextAnnualInterestRateEstimatestring or nullFloating annual-rate estimate for the next UTC 00:00 rate reset. Updated hourly as the next reset approaches; null when unavailable. Always null for fixed terms.
enabledbooleanWhether this term is enabled. Borrowing also requires canBorrow=true.
updatedAtinteger or nullRate update time in Unix milliseconds, when available.

The effective floating rate resets daily at UTC 00:00. Hourly forecast updates do not replace the current effective rate. Fixed-term quotes are indicative; the actual fixed rate is determined when funds are disbursed.

Unlike the group endpoint, this configuration endpoint retains disabled fixed terms and their configured rates. For example, a currency can return 30-, 60- and 180-day fixed terms here while only the enabled 30-day term appears in the group endpoint.

currencyDetails

FieldTypeDescription
idintegerCurrency identifier.
iconUrlstringCurrency icon URL.
currencyNamestringCurrency display name.
slugstringCurrency slug.
referenceAssetIdinteger or nullReference asset identifier.
multipliernumber or nullConversion multiplier to the reference asset.

The response panel contains a four-currency example of the aligned response and the current pre-alignment response. Unavailable rate forecasts remain null in both examples.

Error codes

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

CodeWhen it occursWhat to do
100400Unsupported query parameters are supplied.Send no query parameters.
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.
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