Lending API

Get borrow details

Get borrow details

GEThttps://dev-api.thorswap.net/lending/borrow

Query parameters

Response

200

A full quote of the borrow

Body

application/json

inboundAddressstring

The inbound address recipient of the collateral

inboundConfirmationBlocksnumber

The number of blocks to wait for inbound confirmation

inboundConfirmationSecondsnumber

The number of seconds to wait for inbound confirmation

outboundDelayBlocksnumber

The number of blocks to wait for outbound confirmation

outboundDelaySecondsnumber

The number of seconds to wait for outbound confirmation

feesFeeComponent (object)

Details for the fees occuring on a leg

expirynumber

The expiry time of the loan

warningstring

A warning message from the THORChain protocol

notesstring

A note from the THORChain protocol

dustThresholdstring

The dust threshold of the loan

completeboolean

A flag to indicate if the response data has been fully formed

memostring

The memo message to include in the deposit to open the loan

expectedAmountOutstring

The expected amount out of the loan, in midgard amount

expectedCollaterizationRatiostring

The expected collaterization ratio of the protocol for the loan

expectedCollateralUpstring

The expected collateral amount to be held in the protocol

expectedDebtUpstring

The expected debt amount, in TOR, to be recorded by the protocol

minAmountOutstring

The minimum amount out of the loan, in midgard amount

expectedOutputstring

The expected asset amount out from the loan

expectedOutputMaxSlippagestring

The expected asset amount out from the loan if the entire slippage amount, provided in the quote, is incurred.

expectedOutputUSDstring

The expected asset amount out from the loan, in USD

expectedOutputMaxSlippageUSDstring

The expected asset amount out from the loan if the entire slippage amount, provided in the quote, is incurred, in USD

calldataCalldata (object)

The response object of a quote, that is to be passed into the swap contract of the THORSwap aggregation protocol

Request

JavaScriptCurlPython

const response = await fetch('https://dev-api.thorswap.net/lending/borrow?assetIn=text&assetOut=text&amount=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "inboundAddress": "text",
  "inboundConfirmationBlocks": 0,
  "inboundConfirmationSeconds": 0,
  "outboundDelayBlocks": 0,
  "outboundDelaySeconds": 0,
  "fees": {
    "type": "inbound",
    "asset": "BTC.BTC",
    "networkFee": "0.001",
    "networkFeeUSD": "1.92",
    "affiliateFee": "0.0012",
    "affiliateFeeUSD": "2.24",
    "slipFee": "0.002",
    "slipFeeUSD": "3.84"
  },
  "expiry": 0,
  "warning": "text",
  "notes": "text",
  "dustThreshold": "text",
  "complete": false,
  "memo": "text",
  "expectedAmountOut": "text",
  "expectedCollaterizationRatio": "text",
  "expectedCollateralUp": "text",
  "expectedDebtUp": "text",
  "minAmountOut": "text",
  "expectedOutput": "text",
  "expectedOutputMaxSlippage": "text",
  "expectedOutputUSD": "text",
  "expectedOutputMaxSlippageUSD": "text",
  "calldata": {
    "tcRouter": "text",
    "tcVault": "text",
    "tcMemo": "text",
    "token": "text",
    "amount": "text",
    "amountOutMin": "text",
    "deadline": "text"
  }
}

Get loan details

Get details of loans of provided address and asset

GEThttps://dev-api.thorswap.net/lending/loans

Query parameters

Response

200

Details of loans of provided address and asset

Body

application/json

ownerstring

Address of the owner of the loan

assetstring

The asset of the loan

debt_upstring

The total amount of debt taken for this asset.

debt_downstring

The total amount of debt paid for this asset.

collateral_upstring

The total amount of collateral added for this asset.

collateral_downstring

The total amount of collateral removed.

last_open_heightnumber

Block height at which last loan was taken

last_repay_heightnumber

Block height at which last loan was repaid

Request

JavaScriptCurlPython

const response = await fetch('https://dev-api.thorswap.net/lending/loans?asset=text&address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "owner": "text",
  "asset": "text",
  "debt_up": "text",
  "debt_down": "text",
  "collateral_up": "text",
  "collateral_down": "text",
  "last_open_height": 0,
  "last_repay_height": 0
}

Get available asset for given pool

Get available asset for given pool

GEThttps://dev-api.thorswap.net/lending/asset/available

Query parameters

Response

200

response for available asset

Body

application/json

availablenumber

The amount of asset available.

Request

JavaScriptCurlPython

const response = await fetch('https://dev-api.thorswap.net/lending/asset/available?asset=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "available": 0
}