Get account history (Beta)

get

https://sandbox.kyan.sh/v2/account_history

Retrieves the trading history and account events for a specified smart account address.
This includes trades, transfers (deposits/withdrawals), settlements, and funding events with standardized event structures, advanced filtering, and cursor-based pagination for efficient retrieval.

This endpoint is currently in Beta and has not been fully validated in production yet.

Features:

Cursor-based pagination: Efficient retrieval of large datasets with cursor and next_cursor
Advanced filtering: Filter by event types, actions, markets, and transfer types
Sorting: Sort results by timestamp or realized P&L (ascending or descending)
Standardized events: Consistent event structure across all event types with typed data field

Available Event Types:

trade: Trade execution events (buy/sell)
transfer: Deposit and withdrawal events
settlement: Option settlement events
funding: Funding rate payment events

Available Actions (for filtering):

Trade actions: buy, sell
Transfer actions: deposit, withdrawal
Settlement actions: settlement
Funding actions: funding

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

address

string

required

^0x[a-fA-F0-9]{40}$

The smart account address to retrieve history for

cursor

string

Pagination cursor from a previous response's next_cursor field.
Use this to retrieve the next page of results.

sortKey

string

enum

Defaults to timestamp

Field to sort results by. Defaults to timestamp.
Use realized_pnl to sort by P&L (only applies to trade and settlement events).

Allowed:

sortOrder

string

enum

Defaults to desc

Sort direction. Defaults to desc (newest/highest first).

Allowed:

start_timestamp

integer

1704067200000 to 2019686400000

Start timestamp (Unix milliseconds) for the history query.
Must be between 2024-01-01 and 2034-01-01.
Defaults to 30 days ago if not specified.

end_timestamp

integer

1704067200000 to 2019686400000

End timestamp (Unix milliseconds) for the history query.
Must be between 2024-01-01 and 2034-01-01.
Defaults to current time if not specified.

limit

integer

1 to 1000

Defaults to 100

Maximum number of events to return per page. Defaults to 100.

event_types

string

Comma-separated list of event types to filter by.
Available types: trade, transfer, settlement, funding

actions

string

Comma-separated list of actions to filter by.
Examples: buy, sell, deposit, withdrawal, settlement

transfer_type

string

enum

Filter transfer events by type:

internal: Transfers between margin accounts (same smart account)
external: Transfers to/from external wallets

Allowed:

markets

string

Comma-separated list of markets to filter by.
Filters events by instrument name prefix (e.g., BTC matches BTC_USDC-PERPETUAL).
Available markets: BTC, ETH, ARB

Responses

200Successfully retrieved account history

400Invalid request parameters

500Internal server error