Skip to main content
POST
Get Ledgers Info

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Query Parameters

account_id
string

Public wallet account ID. Omit to use the authenticated user's default wallet. See List Wallet Accounts.

Body

application/json
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

asset
default:all

Filter output by asset. Accepts one of the following formats:

  • all, a single asset, or a comma delimited list of assets.
  • A list of { asset, aclass } objects, to filter by assets of a specific asset class (e.g. tokenized_asset).
aclass
string
default:currency
deprecated

Filter output by asset class. Deprecated, use the { asset, aclass } list form of asset instead.

type
enum<string>
default:all

Type of ledger to retrieve

Available options:
all,
trade,
deposit,
withdrawal,
transfer,
margin,
adjustment,
rollover,
credit,
settled,
staking,
dividend,
sale,
nft_rebate
start
integer

Starting unix timestamp or ledger ID of results (exclusive)

end
integer

Ending unix timestamp or ledger ID of results (inclusive)

ofs
integer
deprecated

Result offset for pagination. Deprecated, use with_cursor and cursor instead. Must be absent or 0 when with_cursor is true.

with_cursor
boolean
default:false

Use cursor-based pagination instead of ofs. Each page holds up to 50 ledger entries, and the response includes cursor.next when more entries are available. start and end still narrow the range. Skips the count query, so count is returned as null.

cursor
string

Opaque pagination token from cursor.next of the previous page. Requires with_cursor.

without_count
boolean
default:false

If true, does not retrieve count of ledger entries (count is returned as null). Request can be noticeably faster for users with many ledger entries as this avoids an extra database query.

rebase_multiplier
enum<string> | null
default:rebased

Optional parameter for viewing xStocks data.

  • rebased: Display in terms of underlying equity.
  • base: Display in terms of SPV tokens.
Available options:
rebased,
base

Response

200 - application/json

Ledgers info retrieved.

result
LedgersInfo · object

Ledgers Info

error
string[]

Kraken API error