Get loan info for portfolio/asset

Retrieves the loan info for a given portfolio and asset.

TS/JS

const portfoliosService = new PortfoliosService(client);

portfoliosService.getAssetLoan({
    portfolio: 'PORTFOLIO_ID_HERE',
    asset: 'ETH',
}).then(async (response) => {
    console.log('Active Loan: ', response);
})

For more information, please visit the INTX TS SDK.

Authorizations

CB-ACCESS-KEY · string · header · required

The Client ID that owns the API Key for the request

CB-ACCESS-PASSPHRASE · string · header · required

The pass phrase affiliated with the API Key

CB-ACCESS-SIGN · string · header · required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

CB-ACCESS-TIMESTAMP · string · header · required

The timestamp of when the request is being made

Path Parameters

portfolio · string · required

Identifies the portfolio by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175)

asset · string · required

Identifies the asset by name (e.g., BTC), UUID (e.g., 291efb0f-2396-4d41-ad03-db3b2311cb2c), or asset ID (e.g., 1482439423963469)

Response

200

application/json

Loan information

portfolio_id · string

The unique identifier of the portfolio the fill was executed under

Example:

"t4umaqa-1-1"

asset_id · string

The unique identifier of the asset

Example:

"14thr7fc-1-1"

asset_uuid · string<uuid>

The UUID of the asset

Example:

"d92669ba-8a04-46d8-9b28-a2bbaeee3b9a"

asset · string

Name of the asset

Example:

"USDC"

total_loan · string

The total quantity of the asset borrowed by the portfolio

Example:

100.75

collateral_backed_overdraft_loan · string

The quantity of the asset automatically borrowed by the portfolio to cover USDC deficits

Example:

10.5

user_requested_loan · string

The quantity of the asset borrowed by the portfolio upon explicit request

Example:

64.5

collateral_requirement · string

The notional collateral requirement to hold the loan

Example:

10.01

initial_margin_contribution · string<string>

The notional amount this loan contributes to the portfolio initial margin notional value

Example:

0.07

initial_margin_requirement · string<string>

The initial margin requirement of the loan

Example:

0.15

current_interest_rate · string

The annualized interest rate to hold the loan

Example:

0.085

pending_interest_charge · string

The pending USDC charge for the loan that will be charged at UTC midnight

Example:

0.9