Get Account Ledgers - Spot/Margin

Description

This interface is for transaction records from all your account types, supporting various currency inquiries. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.

Tips

The start and end time range cannot exceed 24 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.

Tips

Support to obtain 1-year historical data. If you need to obtain longer historical data, please submit a ticket: https://kucoin.zendesk.com/hc/en-us/requests/new

context

If the returned value under bizType is “trade exchange”, the additional trade info (such as order ID, trade ID, trading pair, etc.) will be returned in field context.

BizType Description

Field	Description
Assets Transferred in After Upgrading	Assets Transferred in After V1 to V2 Upgrading
Deposit	Deposit
Withdrawal	Withdrawal
Transfer	Transfer
Trade_Exchange	Trade
Vote for Coin	Vote for Coin
KuCoin Bonus	KuCoin Bonus
Referral Bonus	Referral Bonus
Rewards	Activities Rewards
Distribution	Distribution, such as get GAS by holding NEO
Airdrop/Fork	Airdrop/Fork
Other rewards	Other rewards, except Vote, Airdrop, Fork
Fee Rebate	Fee Rebate
Buy Crypto	Use credit card to buy crypto
Sell Crypto	Use credit card to sell crypto
Public Offering Purchase	Public Offering Purchase for Spotlight
Send red envelope	Send red envelope
Open red envelope	Open red envelope
Staking	Staking
LockDrop Vesting	LockDrop Vesting
Staking Profits	Staking Profits
Redemption	Redemption
Refunded Fees	Refunded Fees
KCS Pay Fees	KCS Pay Fees
Margin Trade	Margin Trade
Loans	Loans
Borrowings	Borrowings
Debt Repayment	Debt Repayment
Loans Repaid	Loans Repaid
Lendings	Lendings
Pool transactions	Pool-X transactions
Instant Exchange	Instant Exchange
Sub Account Transfer	Sub-account transfer
Liquidation Fees	Liquidation Fees
Soft Staking Profits	Soft Staking Profits
Voting Earnings	Voting Earnings on Pool-X
Redemption of Voting	Redemption of Voting on Pool-X
Convert to KCS	Convert to KCS
BROKER_TRANSFER	Broker transfer record

Request

Query Params

currency

string

optional

Currency (you can choose more than one currency). You can specify a max. of 10 currencies in one go. If not specified, all currencies will be queried by default.

Example:

BTC

direction

enum<string>

optional

direction: in, out

Allowed values:

inout

Example:

bizType

string

optional

Type: DEPOSIT-deposit, WITHDRAW-withdraw, TRANSFER-transfer, SUB_TRANSFER-sub-account transfer, TRADE_EXCHANGE-trade, MARGIN_EXCHANGE-margin trade, KUCOIN_BONUS-bonus, BROKER_TRANSFER-Broker transfer record

Example:

TRANSFER

startAt

integer <int64>

optional

Start time (milliseconds)

Example:

1728663338000

endAt

integer <int64>

optional

End time (milliseconds)

Example:

1728692138000

currentPage

integer

optional

Current request page.

Default:

Example:

pageSize

integer

optional

Number of results per request. Minimum is 10, maximum is 500.

>= 10<= 500

Default:

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

string

required

data

object

required

currentPage

integer

required

current page

pageSize

integer

required

page size

totalNum

integer

required

total number

totalPage

integer

required

total pages

items

array [object {10}]

required

Example

{
  "code": "200000",
  "data": {
    "currentPage": 1,
    "pageSize": 50,
    "totalNum": 1,
    "totalPage": 1,
    "items": [
      {
        "id": "265329987780896",
        "currency": "USDT",
        "amount": "0.01",
        "fee": "0",
        "balance": "0",
        "accountType": "TRADE",
        "bizType": "SUB_TRANSFER",
        "direction": "out",
        "createdAt": 1728658481484,
        "context": ""
      }
    ]
  }
}