Ledger events
get_ledger_eventsIdempotent
Individual ledger rows with default tax classification: perp opens, closes, liquidations and funding (main account and subaccounts); spot and HIP-4 outcome buys and sells; vault deposits and withdrawals; staking rewards; HyperEVM swaps, protocol deposits, loans and liquidity positions; transfers; papertrade mints and staking; anything unrecognised, flagged for review. Filter by event type or venue. Without paid access, live wallets return the first 10 rows.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"address": "<address>"
},
"name": "get_ledger_events"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | ||
| limit | No | ||
| venue | No | Venue key: hl (perps), hip3:<dex> (e.g. hip3:xyz), spot, outcome (HIP-4 outcome markets), vault, staking, evm (HyperEVM), pt (papertrade), fork, core (deposits and transfers); a subaccount's venues are sub:<address>:<venue> | |
| sample | No | Return deterministic sample data instead of reading Hyperliquid | |
| address | Yes | Public Hyperliquid wallet address | |
| tax_year | No | Tax year. AU-2027 = Australia · FY 2026–27; AU-2026 = Australia · FY 2025–26; US-2026 = United States · 2026; US-2025 = United States · 2025; UK-2027 = United Kingdom · 2026–27; UK-2026 = United Kingdom · 2025–26; CA-2026 = Canada · 2026; CA-2025 = Canada · 2025; NZ-2027 = New Zealand · 2026–27; NZ-2026 = New Zealand · 2025–26; JP-2026 = Japan · 2026; JP-2025 = Japan · 2025; ES-2026 = Spain · 2026; ES-2025 = Spain · 2025. Defaults by jurisdiction: AU AU-2026, US US-2026, UK UK-2026, CA CA-2026, NZ NZ-2027, JP JP-2026, ES ES-2026. | |
| save_wallet | No | With a Trader or Accountant plan API key: add this wallet to the plan if it is not on it yet (uses one of the plan's 10 wallets or a client seat). Without it, a wallet not on the plan gets the preview and a note. | |
| jurisdiction | No | Used when tax_year is not given. AU = 1 Jul–30 Jun; US, CA, JP and ES = calendar year; UK = 6 Apr–5 Apr; NZ = 1 Apr–31 Mar | AU |
| unlock_token | No | Unlock token returned by buy_report (or the website after paying), for wallets bought without an API key | |
| trade_history_csv | No | Optional: the text of a trade history CSV the user exported from Hyperliquid (Trade History, Export as CSV). Hyperliquid's API serves only about a wallet's most recent 10,000 fills, so for very active wallets this adds the older trades; only trades the API didn't return are added. Nothing is stored. | |
| trade_history_account | No | Optional: the subaccount address the trade history file belongs to (from coverage.subaccounts). Omit for the main account's file. |