Bitget APIBitget API
UTAClassic
Legacy Doc
  • Overview
  • API Documentation
  • WebSocket
  • Agent Hub
  • SDK
  • Changelog
Copied to clipboard
API Document
Classic Earn
    Loan
      Get Currency ListgetGet Est. Interest and BorrowablegetBorrowpostGet Loan OrdersgetRepaypostGet Repay HistorygetModify Pledge RatepostGet Pledge Rate HistorygetGet Loan HistorygetGet DebtsgetGet Liquidation Recordsget
Classic Earn Loan
Classic Earn Loan

Loan

Classic Account — C2C Loan


Get Currency List

GET
https://api.bitget.com
/api/v2/earn/loan/public/coinInfos

Rate limit: 10/sec/IP

Get loan-able currency list.

Get Currency List › Request Parameters

coin
​string

Coin, BTC

Get Currency List › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

Loan infos

​object[]

Pledge infos

GET/api/v2/earn/loan/public/coinInfos
curl https://api.bitget.com/api/v2/earn/loan/public/coinInfos
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1692433281223, "data": { "loanInfos": [ { "coin": "USDT", "hourRate7D": "0.00000617", "rate7D": "0.054", "hourRate30D": "0.00000879", "rate30D": "0.077", "minUsdt": "200", "maxUsdt": "1000000", "min": "200", "max": "1000000" } ], "pledgeInfos": [ { "coin": "MATIC", "initRate": "0.6", "supRate": "0.75", "forceRate": "0.83", "minUsdt": "0", "maxUsdt": "200000" } ] } }
json
application/json

Get Est. Interest and Borrowable

GET
https://api.bitget.com
/api/v2/earn/loan/public/hour-interest

Rate limit: 10/sec/IP

Get estimated hourly interest rate and borrowable amount.

Get Est. Interest and Borrowable › Request Parameters

loanCoin
​string · required

Coin to loan, BTC

pledgeCoin
​string · required

Collateral coin, ETH

daily
​string · required

Mortgage term

SEVEN 7 days

THIRTY 30 days

FLEXIBLE Flexible

pledgeAmount
​string · required

Pledge amount

Get Est. Interest and Borrowable › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
hourInterest
​string

Estimated interest amount per hour

loanAmount
​string

Borrowable amount

GET/api/v2/earn/loan/public/hour-interest
curl 'https://api.bitget.com/api/v2/earn/loan/public/hour-interest?loanCoin=<string>&pledgeCoin=<string>&daily=<string>&pledgeAmount=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1692433739845, "data": { "hourInterest": "0.00133436", "loanAmount": "216.2654" } }
json
application/json

Borrow

POST
https://api.bitget.com
/api/v2/earn/loan/borrow

Rate limit: 10/sec/UID

Borrow coin by pledging collateral and paying interest.

Borrow › Request Parameters

loanCoin
​string · required

Coin to loan, ETH

pledgeCoin
​string · required

Pledge coin (Collateral), USDT

daily
​string · required

Mortgage term

SEVEN 7 days

THIRTY 30 days

FLEXIBLE Flexible

pledgeAmount
​string

Pledge (Collateral) amount, pledgeAmount and loanAmount must send one

loanAmount
​string

Loan amount, pledgeAmount and loanAmount must send one

Borrow › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
orderId
​string

Order ID

POST/api/v2/earn/loan/borrow
curl https://api.bitget.com/api/v2/earn/loan/borrow \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "loanCoin": "loanCoin", "pledgeCoin": "pledgeCoin", "daily": "daily", "pledgeAmount": "pledgeAmount", "loanAmount": "loanAmount" }'
Example Request Body
{ "loanCoin": "loanCoin", "pledgeCoin": "pledgeCoin", "daily": "daily", "pledgeAmount": "pledgeAmount", "loanAmount": "loanAmount" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 163123213132, "data": { "orderId": "1" } }
json
application/json

Get Loan Orders

GET
https://api.bitget.com
/api/v2/earn/loan/ongoing-orders

Rate limit: 10/sec/UID

Get on-going loan orders.

Get Loan Orders › Request Parameters

orderId
​string

Order ID

loanCoin
​string

Coin to loan

pledgeCoin
​string

Pledge (Collateral) coin

Get Loan Orders › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
orderId
​string

Order ID

loanCoin
​string

Coin to loan

loanAmount
​string

Loan amount

interestAmount
​string

Interest amount

hourInterestRate
​string

Hour interest rate

pledgeCoin
​string

Pledge (Collateral) coin

pledgeAmount
​string

Pledge (Collateral) amount

pledgeRate
​string

Pledge (Collateral) rate

supRate
​string

Supplementary rate

forceRate
​string

Forced Liquidation Pledge Rate Percentage

borrowTime
​string

Borrow time millseconds

expireTime
​string

Expire time millseconds

GET/api/v2/earn/loan/ongoing-orders
curl https://api.bitget.com/api/v2/earn/loan/ongoing-orders
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1692434611622, "data": [ { "orderId": "1", "loanCoin": "ETH", "loanAmount": "1", "interestAmount": "0.00000229", "hourInterestRate": "0.000229", "pledgeCoin": "USDT", "pledgeAmount": "2619.69231032", "pledgeRate": "65", "supRate": "75", "forceRate": "83", "borrowTime": "1692434472156", "expireTime": "1693036799999" } ] }
json
application/json

Repay

POST
https://api.bitget.com
/api/v2/earn/loan/repay

Rate limit: 10/sec/UID

Repay.

Repay › Request Parameters

orderId
​string · required

Order ID

repayAll
​string · required

Repay all

yes

no

amount
​string

When repayAll=no: Repay amount

repayUnlock
​string

Whether redeem after repay, default: yes

yes

no

Repay › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
loanCoin
​string

Coin to loan

pledgeCoin
​string

Pledge (Collateral) coin

repayAmount
​string

Repay amount

payInterest
​string

Paid interest

repayLoanAmount
​string

Repay loan amount

repayUnlockAmount
​string

Pledge (Collateral) redeemed amount

POST/api/v2/earn/loan/repay
curl https://api.bitget.com/api/v2/earn/loan/repay \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "orderId": "orderId", "amount": "amount", "repayUnlock": "repayUnlock", "repayAll": "repayAll" }'
Example Request Body
{ "orderId": "orderId", "amount": "amount", "repayUnlock": "repayUnlock", "repayAll": "repayAll" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1684747525424, "data": { "loanCoin": "TRX", "pledgeCoin": "USDT", "repayAmount": "1566.23820848", "payInterest": "0.1185634", "repayLoanAmount": "1566.22635214", "repayUnlockAmount": "195" } }
json
application/json

Get Repay History

GET
https://api.bitget.com
/api/v2/earn/loan/repay-history

Rate limit: 10/sec/UID

Get the list of repay history.

Get Repay History › Request Parameters

startTime
​string · required

Start time, ms, only supports querying the data of the past three months

endTime
​string · required

End time, ms

orderId
​string

Order ID

loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

pageNo
​string

Page No default 1

pageSize
​string

Page size default 10, max 100

Get Repay History › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
orderId
​string

Order ID

loanCoin
​string

Coin to loan

pledgeCoin
​string

Pledge (Collateral) coin

repayAmount
​string

Repay amount

payInterest
​string

Paid interest

repayLoanAmount
​string

Loan Currency Repayment of Principal Amount

repayUnlockAmount
​string

Pledge (Collateral) release amount

repayTime
​string

Repayment time

GET/api/v2/earn/loan/repay-history
curl 'https://api.bitget.com/api/v2/earn/loan/repay-history?startTime=<string>&endTime=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1684747525424, "data": [ { "orderId": "12121212121", "loanCoin": "TRX", "pledgeCoin": "USDT", "repayAmount": "1566.23820848", "payInterest": "0.1185634", "repayLoanAmount": "1566.22635214", "repayUnlockAmount": "195", "repayTime": "1684747525424" } ] }
json
application/json

Modify Pledge Rate

POST
https://api.bitget.com
/api/v2/earn/loan/revise-pledge

Rate limit: 10/sec/UID

Withdraw or supplement collateral.

Modify Pledge Rate › Request Parameters

orderId
​string · required

Order ID

amount
​string · required

Amount to withdraw or supplement

pledgeCoin
​string · required

Pledge (Collateral) coin

reviseType
​string · required

Repay Type

OUT Withdraw collateral

IN supplement collateral

Modify Pledge Rate › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

afterPledgeRate
​string

Pledge Rate Percentage after adjusted

POST/api/v2/earn/loan/revise-pledge
curl https://api.bitget.com/api/v2/earn/loan/revise-pledge \ --request POST \ --header 'Content-Type: application/json' \ --data '{ "orderId": "orderId", "amount": "amount", "pledgeCoin": "pledgeCoin", "reviseType": "reviseType" }'
Example Request Body
{ "orderId": "orderId", "amount": "amount", "pledgeCoin": "pledgeCoin", "reviseType": "reviseType" }
json
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1684747525424, "data": { "loanCoin": "TRX", "pledgeCoin": "USDT", "afterPledgeRate": "60.5" } }
json
application/json

Get Pledge Rate History

GET
https://api.bitget.com
/api/v2/earn/loan/revise-history

Rate limit: 10/sec/UID

Get pledge rate history.

Get Pledge Rate History › Request Parameters

startTime
​string · required

Start time, ms, only supports querying the data of the past three months

endTime
​string · required

End time, ms

orderId
​string

Order ID

reviseSide
​string

Revise side

down supplement collateral to turn down

up withdraw collateral to turn up

pledgeCoin
​string

Pledge (Collateral) coin

pageNo
​string

pageNo default 1

pageSize
​string

pageSize default 10, max 100

Get Pledge Rate History › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

orderId
​string

Order ID

reviseTime
​string

Adjust time

reviseSide
​string

Revise side

down supplement collateral to turn down

up withdraw collateral to turn up

reviseAmount
​string

Adjustment quantity

afterPledgeRate
​string

Pledge Rate Percentage after adjustment

beforePledgeRate
​string

Pledge rate percentage before adjustment

GET/api/v2/earn/loan/revise-history
curl 'https://api.bitget.com/api/v2/earn/loan/revise-history?startTime=<string>&endTime=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1692436125845, "data": [ { "loanCoin": "ETH", "pledgeCoin": "USDT", "orderId": "1", "reviseTime": "1692436102448", "reviseSide": "down", "reviseAmount": "10", "afterPledgeRate": "64.75", "beforePledgeRate": "65" } ] }
json
application/json

Get Loan History

GET
https://api.bitget.com
/api/v2/earn/loan/borrow-history

Rate limit: 10/sec/UID

Get the list of loan history.

Get Loan History › Request Parameters

startTime
​string · required

Start time, ms, only supports querying the data of the past three months

endTime
​string · required

End time, ms

orderId
​string

Order ID

loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

status
​string

Status

ROLLBACK failure

FORCE force liquidation

REPAY already repaid

pageNo
​string

Page No default 1

pageSize
​string

Page size default 10, max 100

Get Loan History › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

orderId
​string

Order ID

initPledgeAmount
​string

Initial pledge amount

initLoanAmount
​string

Initial loan amount

hourRate
​string

hourly rate percentage

daily
​string

Pledge days

borrowTime
​string

Borrowed time

status
​string

Status

ROLLBACK failure

FORCE force liquidation

REPAY already repaid

GET/api/v2/earn/loan/borrow-history
curl 'https://api.bitget.com/api/v2/earn/loan/borrow-history?startTime=<string>&endTime=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1684747525424, "data": [ { "orderId": "12121212121", "loanCoin": "TRX", "pledgeCoin": "USDT", "initPledgeAmount": "0.757", "initLoanAmount": "4321321.23820848", "hourRate": "59.1", "daily": "7", "borrowTime": "1684747528424", "status": "REPAY" } ] }
json
application/json

Get Debts

GET
https://api.bitget.com
/api/v2/earn/loan/debts

Rate limit: 10/sec/UID

Get the list of repay history.

Get Debts › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object
​object[]

Loan info

​object[]

Pledge Info

GET/api/v2/earn/loan/debts
curl https://api.bitget.com/api/v2/earn/loan/debts
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1692436610750, "data": { "pledgeInfos": [ { "coin": "USDT", "amount": "28826.61539642", "amountUsdt": "28826.61" } ], "loanInfos": [ { "coin": "ETH", "amount": "11.00002748", "amountUsdt": "18730.85" } ] } }
json
application/json

Get Liquidation Records

GET
https://api.bitget.com
/api/v2/earn/loan/reduces

Rate limit: 10/sec/UID

Get the list of liquidation records.

Get Liquidation Records › Request Parameters

startTime
​string · required

Start time, ms, only supports querying the data of the past three months

endTime
​string · required

End time, ms

orderId
​string

Order ID

loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

status
​string

Status

COMPLETE completed liquidation

WAIT liquidating

pageNo
​string

Page No, default 1

pageSize
​string

Page size, default 10, max 100

Get Liquidation Records › Response Parameters

200

Successful response

code
​string
msg
​string
requestTime
​integer
​object[]
orderId
​string

Order ID

loanCoin
​string

Loan coin

pledgeCoin
​string

Pledge (Collateral) coin

reduceTime
​string

Liquidated time

pledgeRate
​string

Pledge percentage during liquidation

pledgePrice
​string

Pledge price when Liquidated

status
​string

Status

COMPLETE liquidation completed

WAIT liquidating

pledgeAmount
​string

Liquidation amount of pledged coin

reduceFee
​string

Liquidation fee

residueAmount
​string

Remaining pledged amount

runlockAmount
​string

Released amount of pledged coin

repayLoanAmount
​string

Repayment amount of the loan

GET/api/v2/earn/loan/reduces
curl 'https://api.bitget.com/api/v2/earn/loan/reduces?startTime=<string>&endTime=<string>'
Example Responses
{ "code": "00000", "msg": "success", "requestTime": 1684747525424, "data": [ { "orderId": "12121212121", "loanCoin": "TRX", "pledgeCoin": "USDT", "reduceTime": "0.757", "pledgeRate": "98.2", "pledgePrice": "111.4", "status": "COMPLETE", "pledgeAmount": "1213.5", "reduceFee": "REPAY", "residueAmount": "3234.2", "runlockAmount": "23", "repayLoanAmount": "53.2" } ] }
json
application/json