Documentation

Ledgers

post
https://api.bitfinex.com/v2/auth/r/ledgers//hist

View your past ledger entries. Most recent entries are returned by default, but a timestamp can be used to retrieve time-specific data.

The endpoint returns data up to 6 years old.

🚧

Retrieve all ledgers

The currency param can be omitted to return a ledger including all currencies. The path for this call is 'v2/auth/r/ledgers/hist'.

Response data

IndexFieldTypeDescription
[0...n]LEDGER_ENTRYLedger entryEach index contains one of the n current user's ledger entries.

Ledger entry arrays

IndexFieldTypeDescription
[0]IDintLedger identifier
[1]CURRENCYstringThe symbol of the currency (e.g. "BTC")
[2]WALLETstring (or null)Returns the relevant wallet for the ledger entry ('exchange', 'margin', 'funding', 'contribution')
[3]MTSintTimestamp in milliseconds
[5]AMOUNTfloatAmount changed
[6]BALANCEfloatBalance after change
[8]DESCRIPTIONstringDescription of ledger transaction

Possible values for the 'category' filter

This table shows the possible values for the 'category' body param. The table shows the filter followed by the int value that should be entered in the 'category' param to activate the filter.

FilterInt ValueFilterInt ValueFilterInt Value
exchange5canceled withdrawal105withdrawal fee254
position modified, closed, or liquidated22trading fee201withdrawal express fee255
position claim23trading rebate202miner fee258
position transfer25hidden order fee204staking payment262
position swap26otc trade fee207adjustment401
position funding cost or interest charged27swap fee222expense501
margin / swap / interest payment28claiming fee224currency conversion / computation fee905
derivatives funding event29used margin funding charge226monthly profit payment907
settlement31unused margin funding fee228losses911
transfer51earned fee / affiliate rebate241
deposit101ETHFX loyalty fee243
withdrawal104deposit fee251

Ratelimit: 90 req/min

Path Params
string
required

Currency (BTC, ...) For an up-to-date listing of supported currencies see: https://api.bitfinex.com/v2/conf/pub:map:currency:label (Can be omitted to retrieve Ledgers for all currencies)

Body Params
int32

Allows you to filter the ledger response using an int value. For a list of possible values, see the table below.

int64

Millisecond start time

int64

Millisecond end time

int32

Number of records (Max 2500)

string

Wallet name e.g. exchange, margin, funding

Responses

Updated about 1 year ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago