Institutional Loan

Bind/Unbind UID to Risk Unit

POST

https://api.bitget.com

/api/v3/ins-loan/bind-uid

Rate limit: 3/sec/UID

Binding:

The uid and riskUnitId belong to the same main account.
The uid is not bound to any other risk unit.

Unbinding:

The API key used for the call must belong to the main account or the lending-exclusive sub-account UID within the risk unit.
The uid is within the risk unit and is not equal to riskUnitId.
The uid has a zero balance, or the riskUnitId has not_paid_off or in_progress loan orders.

The account mode must be set to Advanced Mode; Basic Mode is not supported.

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Bind/Unbind UID to Risk Unit › Request Parameters

uid

string · required

Sub UID (limit 50 UIDs for one Risk Unit)

operate

string · required

bind Bind unbind Unbind

riskUnitId

string

Risk Unit ID (Required for parent account calls, not required for risk unit account calls)

Bind/Unbind UID to Risk Unit › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

riskUnitId

string

Risk Unit ID

uid

string

Bind or unbind the UID of the sub-account to the risk unit. Bind: the UID and the riskUnitId belong to the same main account; the UID is not bound to other risk units. Unbind: the API key for invoking the interface must be the UID of the exclusive sub-account for borrowing and lending within the main account or the risk unit; the UID is within the risk unit and is not equal to the riskUnitId; the assets of the UID are zero, or there are no outstanding or in-transit borrowing and lending orders for the riskUnitId.

operate

string

bind Bind unbind Unbind

Get Margin Coin Info

GET

https://api.bitget.com

/api/v3/ins-loan/ensure-coins-convert

Rate limit: 3/sec/UID

Get Margin Coin Info

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Margin Coin Info › Request Parameters

productId

string · required

Product Id

Get Margin Coin Info › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

productId

string

Product Id

object[]

Spot margin coin

GET/api/v3/ins-loan/ensure-coins-convert

curl 'https://api.bitget.com/api/v3/ins-loan/ensure-coins-convert?productId=<string>'

Example Responses

{
  "code": "00000",
  "msg": "success",
  "requestTime": 1711697581815,
  "data": {
    "productId": "xxxxxxxx",
    "coinInfo": [
      {
        "coin": "USDC",
        "convertRatio": "1",
        "maxConvertValue": "1000",
        "convertRatioList": [
          {
            "ladder": "0-100000000",
            "convertRatio": "1"
          },
          {
            "ladder": "100000000-200000000",
            "convertRatio": "0.99"
          }
        ]
      },
      {
        "coin": "USDT",
        "convertRatio": "1",
        "maxConvertValue": "1000",
        "convertRatioList": [
          {
            "ladder": "0-100000000",
            "convertRatio": "1"
          },
          {
            "ladder": "100000000-200000000",
            "convertRatio": "0.99"
          }
        ]
      }
    ]
  }
}

json

application/json

Get LTV

GET

https://api.bitget.com

/api/v3/ins-loan/ltv-convert

Rate limit: 3/sec/UID

Get LTV

If the riskUnitId parameter is not passed in, the account calling the interface must be an institutional exclusive lending unit account.
If this parameter has been provided, the UID carried in the parameter must belong to an institutional lending exclusive unit account, and the account calling the API must be the primary account.
Update frequency: 1s

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get LTV › Request Parameters

riskUnitId

string

Risk Unit ID

Get LTV › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

ltv

string

Risk rate, 0.6667

subAccountUids

string[]

Sub-accounts user ID in Risk Unit

usdtBalance

string

Total assets (margin coins converted to USDT)

unpaidUsdtAmount

string

Total debt (converted to USDT)

object[]

Debt details

object[]

Asset details

Get Loan Orders

GET

https://api.bitget.com

/api/v3/ins-loan/loan-order

Rate limit: 3/sec/UID

Get Loan Orders

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Loan Orders › Request Parameters

orderId

string

Loan order id. If not passed, then return all orders, sort by loanTime in descend

startTime

string

The start timestamp (ms)

endTime

string

The end timestamp (ms)

Get Loan Orders › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

Loan details

orderId

string

Loan order ID

orderProductId

string

Product Id

uid

string

The designated UID that is used to bind INS loan product, loan and repayment

loanTime

string

Loan timestamp, in milliseconds

loanCoin

string

Loan coin

loanAmount

string

Loan amount

unpaidAmount

string

Unpaid principal

unpaidInterest

string

Unpaid interest

repaidAmount

string

Repaid principal

repaidInterest

string

Repaid interest

reserve

string

Reserve amount

status

string

Not paid off not_paid_off; Paid off paid_off

Get Product Info

GET

https://api.bitget.com

/api/v3/ins-loan/product-infos

Rate limit: 3/sec/UID

Get Product Info

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Product Info › Request Parameters

productId

string · required

Product Id

Get Product Info › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

productId

string

Product Id

leverage

string

The maximum leverage for this loan product. 2x/4x

supportUsdtContract

string

Whether USDT-M Futures are supported. YES/NO

supportCoinContract

string

Whether Coin-M Futures are supported. YES/NO

supportUsdcContract

string

Whether USDC-M Futures are supported. YES/NO

transferLine

string

Restrict line for transfer, eg: 0.6667

spotBuyLine

string

Restrict line for Spot buy, eg: 0.8

usdtContractOpenLine

string

Restrict line for USDT-M Futures open position, eg: 0.8

coinContractOpenLine

string

Restrict line for Coin-M Futures open position, eg: 0.8

usdcContractOpenLine

string

Restrict line for USDC-M Futures open position, eg: 0.8

liquidationLine

string

Line for liquidation, eg: 0.9

stopLiquidationLine

string

Line for stop liquidation, eg: 0.75

Get Repayment Orders

GET

https://api.bitget.com

/api/v3/ins-loan/repaid-history

Rate limit: 3/sec/UID

Get Repayment Orders

By default, query the data of the past two years.
At most, support querying the data of the past two years.
Only display the data of successfully repaid orders.
Only display the repayment orders under the unified account. The orders under the spot account can be queried through the v2 version.
Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Repayment Orders › Request Parameters

startTime

string

The start timestamp (ms)

endTime

string

The end timestamp (ms)

limit

string

Limit default 100; max 100

Get Repayment Orders › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

Repayment orders

repayOrderId

string

Repaid order ID

repaidTime

string

Repaid timestamp (ms)

coin

string

Repaid coin

repayAmount

string

Repaid principle

repayInterest

string

Repaid interest

repayType

string

Repaid type: all All repayment; part partial repayment

businessType

string

Business type: normal normal repayment; liquidation repaid by liquidation

Get Risk Unit

GET

https://api.bitget.com

/api/v3/ins-loan/risk-unit

Rate limit: 3/sec/UID

Get Risk Unit, only the parent account API Key can use this endpoint

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Risk Unit › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

riskUnitId

string[]

All Risk Unit Ids

Get Trade Symbols

GET

https://api.bitget.com

/api/v3/ins-loan/symbols

Rate limit: 3/sec/UID

Get Trade Symbols

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Trade Symbols › Request Parameters

productId

string · required

Product Id

Get Trade Symbols › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

productId

string

Product Id

spotSymbols

string[]

Spot trading pairs

marginLeverage

string

The allowable maximum leverage for Spot margin trading

usdtContractLeverage

string

The allowed default leverage for USDT-M Futures

coinContractLeverage

string

The allowed default leverage for Coin-M Futures

usdcContractLeverage

string

The allowed default leverage for USDC-M Futures

object[]

USDT-M Futures Object If supportUsdtContract=NO, then it returns "[]" If there are whitelist symbols, it returns those whitelist data

object[]

Coin-M Futures Object If supportCoinContract=NO, then it returns "[]" If there are whitelist symbols, it returns those whitelist data

object[]

USDC-M Futures Object If supportUsdcContract=NO, then it returns "[]" If there are whitelist symbols, it returns those whitelist data

Get Transferred Quantity

GET

https://api.bitget.com

/api/v3/ins-loan/transfered

Rate limit: 3/sec/UID

Get Transferred Quantity

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Transferred Quantity › Request Parameters

coin

string · required

Coin

userId

string

User Id (Master account or sub-accounts)

Get Transferred Quantity › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

coin

string

Coin name

transfered

string

Transferred quantity

userId

string

User Id

Institutional Loan

Bind/Unbind UID to Risk Unit

POST

https://api.bitget.com

/api/v3/ins-loan/bind-uid

Rate limit: 3/sec/UID

Binding:

The uid and riskUnitId belong to the same main account.
The uid is not bound to any other risk unit.

Unbinding:

The API key used for the call must belong to the main account or the lending-exclusive sub-account UID within the risk unit.
The uid is within the risk unit and is not equal to riskUnitId.
The uid has a zero balance, or the riskUnitId has not_paid_off or in_progress loan orders.

The account mode must be set to Advanced Mode; Basic Mode is not supported.

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Bind/Unbind UID to Risk Unit › Request Parameters

uid

string · required

Sub UID (limit 50 UIDs for one Risk Unit)

operate

string · required

bind Bind unbind Unbind

riskUnitId

string

Risk Unit ID (Required for parent account calls, not required for risk unit account calls)

Bind/Unbind UID to Risk Unit › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

riskUnitId

string

Risk Unit ID

uid

string

operate

string

bind Bind unbind Unbind

Get Margin Coin Info

GET

https://api.bitget.com

/api/v3/ins-loan/ensure-coins-convert

Rate limit: 3/sec/UID

Get Margin Coin Info

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Margin Coin Info › Request Parameters

productId

string · required

Product Id

Get Margin Coin Info › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

productId

string

Product Id

object[]

Spot margin coin

GET/api/v3/ins-loan/ensure-coins-convert

curl 'https://api.bitget.com/api/v3/ins-loan/ensure-coins-convert?productId=<string>'

Example Responses

{
  "code": "00000",
  "msg": "success",
  "requestTime": 1711697581815,
  "data": {
    "productId": "xxxxxxxx",
    "coinInfo": [
      {
        "coin": "USDC",
        "convertRatio": "1",
        "maxConvertValue": "1000",
        "convertRatioList": [
          {
            "ladder": "0-100000000",
            "convertRatio": "1"
          },
          {
            "ladder": "100000000-200000000",
            "convertRatio": "0.99"
          }
        ]
      },
      {
        "coin": "USDT",
        "convertRatio": "1",
        "maxConvertValue": "1000",
        "convertRatioList": [
          {
            "ladder": "0-100000000",
            "convertRatio": "1"
          },
          {
            "ladder": "100000000-200000000",
            "convertRatio": "0.99"
          }
        ]
      }
    ]
  }
}

json

application/json

Get LTV

GET

https://api.bitget.com

/api/v3/ins-loan/ltv-convert

Rate limit: 3/sec/UID

Get LTV

If the riskUnitId parameter is not passed in, the account calling the interface must be an institutional exclusive lending unit account.
If this parameter has been provided, the UID carried in the parameter must belong to an institutional lending exclusive unit account, and the account calling the API must be the primary account.
Update frequency: 1s

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get LTV › Request Parameters

riskUnitId

string

Risk Unit ID

Get LTV › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

ltv

string

Risk rate, 0.6667

subAccountUids

string[]

Sub-accounts user ID in Risk Unit

usdtBalance

string

Total assets (margin coins converted to USDT)

unpaidUsdtAmount

string

Total debt (converted to USDT)

object[]

Debt details

object[]

Asset details

Get Loan Orders

GET

https://api.bitget.com

/api/v3/ins-loan/loan-order

Rate limit: 3/sec/UID

Get Loan Orders

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Loan Orders › Request Parameters

orderId

string

Loan order id. If not passed, then return all orders, sort by loanTime in descend

startTime

string

The start timestamp (ms)

endTime

string

The end timestamp (ms)

Get Loan Orders › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

Loan details

orderId

string

Loan order ID

orderProductId

string

Product Id

uid

string

The designated UID that is used to bind INS loan product, loan and repayment

loanTime

string

Loan timestamp, in milliseconds

loanCoin

string

Loan coin

loanAmount

string

Loan amount

unpaidAmount

string

Unpaid principal

unpaidInterest

string

Unpaid interest

repaidAmount

string

Repaid principal

repaidInterest

string

Repaid interest

reserve

string

Reserve amount

status

string

Not paid off not_paid_off; Paid off paid_off

Get Product Info

GET

https://api.bitget.com

/api/v3/ins-loan/product-infos

Rate limit: 3/sec/UID

Get Product Info

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Product Info › Request Parameters

productId

string · required

Product Id

Get Product Info › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

productId

string

Product Id

leverage

string

The maximum leverage for this loan product. 2x/4x

supportUsdtContract

string

Whether USDT-M Futures are supported. YES/NO

supportCoinContract

string

Whether Coin-M Futures are supported. YES/NO

supportUsdcContract

string

Whether USDC-M Futures are supported. YES/NO

transferLine

string

Restrict line for transfer, eg: 0.6667

spotBuyLine

string

Restrict line for Spot buy, eg: 0.8

usdtContractOpenLine

string

Restrict line for USDT-M Futures open position, eg: 0.8

coinContractOpenLine

string

Restrict line for Coin-M Futures open position, eg: 0.8

usdcContractOpenLine

string

Restrict line for USDC-M Futures open position, eg: 0.8

liquidationLine

string

Line for liquidation, eg: 0.9

stopLiquidationLine

string

Line for stop liquidation, eg: 0.75

Get Repayment Orders

GET

https://api.bitget.com

/api/v3/ins-loan/repaid-history

Rate limit: 3/sec/UID

Get Repayment Orders

By default, query the data of the past two years.
At most, support querying the data of the past two years.
Only display the data of successfully repaid orders.
Only display the repayment orders under the unified account. The orders under the spot account can be queried through the v2 version.
Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Repayment Orders › Request Parameters

startTime

string

The start timestamp (ms)

endTime

string

The end timestamp (ms)

limit

string

Limit default 100; max 100

Get Repayment Orders › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object[]

Repayment orders

repayOrderId

string

Repaid order ID

repaidTime

string

Repaid timestamp (ms)

coin

string

Repaid coin

repayAmount

string

Repaid principle

repayInterest

string

Repaid interest

repayType

string

Repaid type: all All repayment; part partial repayment

businessType

string

Business type: normal normal repayment; liquidation repaid by liquidation

Get Risk Unit

GET

https://api.bitget.com

/api/v3/ins-loan/risk-unit

Rate limit: 3/sec/UID

Get Risk Unit, only the parent account API Key can use this endpoint

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Risk Unit › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

riskUnitId

string[]

All Risk Unit Ids

Get Trade Symbols

GET

https://api.bitget.com

/api/v3/ins-loan/symbols

Rate limit: 3/sec/UID

Get Trade Symbols

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Trade Symbols › Request Parameters

productId

string · required

Product Id

Get Trade Symbols › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

productId

string

Product Id

spotSymbols

string[]

Spot trading pairs

marginLeverage

string

The allowable maximum leverage for Spot margin trading

usdtContractLeverage

string

The allowed default leverage for USDT-M Futures

coinContractLeverage

string

The allowed default leverage for Coin-M Futures

usdcContractLeverage

string

The allowed default leverage for USDC-M Futures

object[]

USDT-M Futures Object If supportUsdtContract=NO, then it returns "[]" If there are whitelist symbols, it returns those whitelist data

object[]

Coin-M Futures Object If supportCoinContract=NO, then it returns "[]" If there are whitelist symbols, it returns those whitelist data

object[]

USDC-M Futures Object If supportUsdcContract=NO, then it returns "[]" If there are whitelist symbols, it returns those whitelist data

Get Transferred Quantity

GET

https://api.bitget.com

/api/v3/ins-loan/transfered

Rate limit: 3/sec/UID

Get Transferred Quantity

Rate limit: 3/sec/UID
Permission: UTA mgt. (read)

Get Transferred Quantity › Request Parameters

coin

string · required

Coin

userId

string

User Id (Master account or sub-accounts)

Get Transferred Quantity › Response Parameters

200

Successful response

code

string

msg

string

requestTime

integer

object

coin

string

Coin name

transfered

string

Transferred quantity

userId

string

User Id