@spec get_loan_borrow_history(
  limit: any(),
  current: any(),
  endTime: any(),
  startTime: any(),
  orderId: any(),
  collateralCoin: any(),
  loanCoin: any(),
  recvWindow: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Borrow - Get Loan Borrow History (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/borrow/history

Mandatory params:

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000
• loanCoin -
• collateralCoin -
• orderId - orderId in POST /sapi/v1/loan/borrow
• startTime -
• endTime -
• current - Current querying page. Start from 1; default: 1; max: 1000
• limit - Default: 10; max: 100.

@spec get_loan_collateral_data(
  recvWindow: any(),
  vipLevel: any(),
  collateralCoin: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Collateral Assets Data (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/collateral/data

Mandatory params:

Optional params:

• timestamp - timestamp
• collateralCoin -
• vipLevel - Default: user's vip level. Send "-1" to check specified configuration
• recvWindow - The value cannot be greater than 60000

@spec get_loan_income(any(),
  recvWindow: any(),
  limit: any(),
  endTime: any(),
  startTime: any(),
  type: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Get Crypto Loans Income History (USER_DATA)

• If startTime and endTime are not sent, the recent 7-day data will be returned.
• The max interval between startTime and endTime is 30 days.

Weight(UID): 6000

Details:

• METHOD: get
• URL: /sapi/v1/loan/income

Mandatory params:

• asset -

Optional params:

• timestamp - timestamp
• type - All types will be returned by default.

• borrowIn
• collateralSpent
• repayAmount
• collateralReturn - Collateral return after repayment
• addCollateral
• removeCollateral
• collateralReturnAfterLiquidation

• startTime - UTC timestamp in ms
• endTime - UTC timestamp in ms
• limit - default 20, max 100
• recvWindow - The value cannot be greater than 60000

@spec get_loan_loanable_data(
  recvWindow: any(),
  vipLevel: any(),
  loanCoin: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Get Loanable Assets Data (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/loanable/data

Mandatory params:

Optional params:

• timestamp - timestamp
• loanCoin -
• vipLevel - Default: user's vip level. Send "-1" to check specified configuration
• recvWindow - The value cannot be greater than 60000

@spec get_loan_ltv_adjustment_history(
  endTime: any(),
  startTime: any(),
  limit: any(),
  current: any(),
  orderId: any(),
  collateralCoin: any(),
  loanCoin: any(),
  recvWindow: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Adjust LTV - Get Loan LTV Adjustment History (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/ltv/adjustment/history

Mandatory params:

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000
• loanCoin -
• collateralCoin -
• orderId -
• current - Current querying page. Start from 1; default: 1; max: 1000
• limit - Default: 10; max: 100.
• startTime -
• endTime -

@spec get_loan_ongoing_orders(
  limit: any(),
  current: any(),
  orderId: any(),
  collateralCoin: any(),
  loanCoin: any(),
  recvWindow: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Borrow - Get Loan Ongoing Orders (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/ongoing/orders

Mandatory params:

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000
• loanCoin -
• collateralCoin -
• orderId - orderId in POST /sapi/v1/loan/borrow
• current - Current querying page. Start from 1; default: 1; max: 1000
• limit - Default: 10; max: 100.

@spec get_loan_repay_collateral_rate(any(), any(), any(),
  recvWindow: any(),
  timestamp: any()
) ::
  {:ok, any()} | {:error, any()}

Check Collateral Repay Rate (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/repay/collateral/rate

Mandatory params:

• loanCoin -
• collateralCoin -
• repayAmount - repay amount of loanCoin

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000

@spec get_loan_repay_history(
  endTime: any(),
  startTime: any(),
  limit: any(),
  current: any(),
  orderId: any(),
  collateralCoin: any(),
  loanCoin: any(),
  recvWindow: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Repay - Get Loan Repayment History (USER_DATA)

Details:

• METHOD: get
• URL: /sapi/v1/loan/repay/history

Mandatory params:

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000
• loanCoin -
• collateralCoin -
• orderId -
• current - Current querying page. Start from 1; default: 1; max: 1000
• limit - Default: 10; max: 100.
• startTime -
• endTime -

@spec post_loan_adjust_ltv(any(), any(), any(), recvWindow: any(), timestamp: any()) ::
  {:ok, any()} | {:error, any()}

Adjust LTV - Crypto Loan Adjust LTV (TRADE)

Details:

• METHOD: post
• URL: /sapi/v1/loan/adjust/ltv

Mandatory params:

• orderId -
• amount -
• direction - "ADDITIONAL", "REDUCED"

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000

@spec post_loan_borrow(any(), any(), any(),
  recvWindow: any(),
  collateralAmount: any(),
  loanAmount: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Borrow - Crypto Loan Borrow (TRADE)

Details:

• METHOD: post
• URL: /sapi/v1/loan/borrow

Mandatory params:

• loanCoin -
• collateralCoin -
• loanTerm -

Optional params:

• timestamp - timestamp
• loanAmount - Mandatory when collateralAmount is empty
• collateralAmount - Mandatory when loanAmount is empty
• recvWindow - The value cannot be greater than 60000

@spec post_loan_customize_margin_call(any(),
  recvWindow: any(),
  collateralCoin: any(),
  orderId: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Crypto Loan Customize Margin Call (TRADE)

Details:

• METHOD: post
• URL: /sapi/v1/loan/customize/margin_call

Mandatory params:

• marginCall -

Optional params:

• timestamp - timestamp
• orderId - Mandatory when collateralCoin is empty. Send either orderId or collateralCoin, if both parameters are sent, take orderId only
• collateralCoin - Mandatory when orderID is empty. Send either orderId or collateralCoin, if both parameters are sent, take orderId only.
• recvWindow - The value cannot be greater than 60000

@spec post_loan_repay(any(), any(),
  type: any(),
  collateralReturn: any(),
  recvWindow: any(),
  timestamp: any()
) :: {:ok, any()} | {:error, any()}

Repay - Crypto Loan Repay (TRADE)

Details:

• METHOD: post
• URL: /sapi/v1/loan/repay

Mandatory params:

• orderId -
• amount -

Optional params:

• timestamp - timestamp
• recvWindow - The value cannot be greater than 60000
• collateralReturn - Default: TRUE. TRUE: Return extra collateral to spot account; FALSE: Keep extra collateral in the order.
• type - Default: 1. 1 for "repay with borrowed coin"; 2 for "repay with collateral".