# Hyperliquid

> Read Hyperliquid's public perpetuals and spot data from a workflow: mid prices, perpetual and spot markets, order books, recent trades, price candles, funding history and predicted funding against Binance and Bybit, and validators; and for any address, its positions, spot balances, open orders, fills, funding payments, order history and status, portfolio history, vaults and staking. Triggers start a workflow when an address gets a fill or a new perpetual is listed. It only reads public data: it cannot place orders or move funds, and nothing it returns is investment advice. No account or API key required.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/hyperliquid

## Actions

### Get a perpetual

Get one perpetual's market in a single record: mark, oracle and mid price, 24-hour change and volume, open interest, the hourly funding rate and what it comes to over a year, and maximum leverage.

**Inputs**

- Perpetual (`coin`, text, required): The perpetual, such as BTC or HYPE. Pick one or type a name; one on a builder-deployed exchange is written xyz:XYZ100.

**Outputs**

- `change_percent_24h` (number): Change over 24 hours, in percent
- `coin` (text): The perpetual's coin, such as BTC or xyz:XYZ100
- `dex` (text): The exchange it is on; empty for Hyperliquid's own
- `funding_annualized_percent` (number): That rate over a year, in percent
- `funding_rate` (number): The current hourly funding rate, as a fraction; positive means longs pay
- `impact_ask_price` (number): The price a sizable buy would fill at
- `impact_bid_price` (number): The price a sizable sell would fill at
- `is_delisted` (true/false): True when it no longer trades
- `isolated_only` (true/false): True when it can only be traded on isolated margin
- `mark_price` (number): The mark price positions are valued at
- `max_leverage` (number): The highest leverage allowed
- `mid_price` (number): Halfway between the best bid and ask
- `open_interest` (number): Open interest, in the coin
- `open_interest_usd` (number): Open interest, in US dollars at the mark price
- `oracle_price` (number): The oracle (spot index) price
- `premium` (number): Mark over oracle, as a fraction
- `prev_day_price` (number): The price 24 hours ago
- `size_decimals` (number): Decimal places an order size may have
- `volume_24h` (number): Volume over 24 hours, in the coin
- `volume_24h_usd` (number): Volume over 24 hours, in US dollars

**Example output**

```json
{
  "change_percent_24h": 0.0881642512077,
  "coin": "BTC",
  "dex": "",
  "funding_annualized_percent": 10.95,
  "funding_rate": 1.25e-05,
  "impact_ask_price": 82875.0,
  "impact_bid_price": 82872.3,
  "is_delisted": false,
  "isolated_only": false,
  "mark_price": 82873.0,
  "max_leverage": 40,
  "mid_price": 82874.5,
  "open_interest": 39974.46542,
  "open_interest_usd": 3312803872.75,
  "oracle_price": 82891.0,
  "premium": -0.0001930246,
  "prev_day_price": 82800.0,
  "size_decimals": 5,
  "volume_24h": 33651.78332,
  "volume_24h_usd": 2821050959.049752
}
```

### Get a perpetuals account

Get an address's perpetuals account: its value, margin in use, what it could withdraw, and every open position with size, entry price, value, unrealised profit or loss, leverage, liquidation price and funding paid.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Exchange (`dex`, text): A builder-deployed (HIP-3) perpetual exchange to read instead of Hyperliquid's own, such as xyz. Leave it empty for Hyperliquid's own.

**Outputs**

- `account_value` (number): The account's value, in USDC
- `cross_account_value` (number): The value on cross margin
- `dex` (text): The exchange read; empty for Hyperliquid's own
- `maintenance_margin_used` (number): Margin needed to avoid liquidation
- `margin_used` (number): Margin in use
- `position_count` (number): How many positions are open
- `positions` (list): Open positions
- `time` (text): When Hyperliquid took this snapshot
- `total_position_value` (number): The value of all positions
- `unrealized_pnl` (number): Unrealised profit or loss across positions
- `user` (text): The address that was read, in lower case
- `withdrawable` (number): USDC that could be withdrawn now

**Example output**

```json
{
  "account_value": 3147557.330388,
  "cross_account_value": 3147557.330388,
  "dex": "",
  "maintenance_margin_used": 39399.400841,
  "margin_used": 196997.004511,
  "position_count": 2,
  "positions": [
    {
      "coin": "BTC",
      "entry_price": 83199.7,
      "funding_all_time": -612357.091628,
      "funding_since_open": 640.719548,
      "leverage": 20.0,
      "leverage_type": "cross",
      "liquidation_price": null,
      "margin_used": 3195.259099,
      "max_leverage": 50,
      "position_value": 63905.181984,
      "return_on_equity_percent": -7.84866651,
      "side": "long",
      "signed_size": 0.77112,
      "size": 0.77112,
      "unrealized_pnl": -251.773273
    },
    {
      "coin": "ETH",
      "entry_price": 2477.44,
      "funding_all_time": -483641.871151,
      "funding_since_open": 138.338384,
      "leverage": 20.0,
      "leverage_type": "cross",
      "liquidation_price": null,
      "margin_used": 1033.329798,
      "max_leverage": 50,
      "position_value": 20666.59596,
      "return_on_equity_percent": -27.08020196,
      "side": "long",
      "signed_size": 8.4564,
      "size": 8.4564,
      "unrealized_pnl": -283.668699
    }
  ],
  "time": "2026-10-22T04:23:15.168Z",
  "total_position_value": 3939940.091359,
  "unrealized_pnl": -535.441972,
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a",
  "withdrawable": 2753563.321294
}
```

### Get a vault

Get a vault's details: its name, leader, description, APR, value and all-time profit or loss, whether it takes deposits, and the child vaults of a parent such as HLP.

**Inputs**

- Vault address (`vault_address`, text, required): The vault's address, from its page at https://app.hyperliquid.xyz/vaults.

**Outputs**

- `account_value` (number): Its latest value, in USDC
- `all_time_pnl` (number): Its profit or loss since it opened, in USDC
- `allow_deposits` (true/false): True when it accepts deposits
- `apr_percent` (number): Its APR, in percent
- `child_addresses` (list): A parent vault's child vaults
- `description` (text): Its own description
- `is_closed` (true/false): True when it no longer takes deposits or trades
- `leader` (text): The address that runs it
- `leader_commission` (number): The leader's commission on profits
- `leader_fraction` (number): The leader's share of the vault
- `max_distributable` (number): USDC it could pay out now
- `max_withdrawable` (number): USDC a depositor could withdraw now
- `name` (text): The vault's name
- `parent_address` (text): A child vault's parent; empty otherwise
- `relationship` (text): parent, child or normal
- `vault_address` (text): Its address

**Example output**

```json
{
  "account_value": 177332110.108363,
  "all_time_pnl": 138814188.348363,
  "allow_deposits": true,
  "apr_percent": 3.53118951016,
  "child_addresses": [
    "0x010461c14e146ac35fe42271bdc1134ee31c703a",
    "0x2e3d94f0562703b25c83308a05046ddaf9a8dd14",
    "0x2ed5c4484ea3ff8b57d5f2fb152a40d9f2b68308",
    "0x31ca8395cf837de08b24da3f660e77761dfb974b",
    "0x469f690213c467c39a23efacfd2816896009d7d8",
    "0x5e177e5e39c0f4e421f5865a6d8beed8d921cb70",
    "0xb0a55f13d22f66e6d495ac98113841b2326e9540"
  ],
  "description": "This community-owned vault provides liquidity to Hyperliquid through multiple market making strategies, performs liquidations, and accrues platform fees.",
  "is_closed": false,
  "leader": "0x677d831aef5328190852e24f13c46cac05f984e7",
  "leader_commission": 0.0,
  "leader_fraction": 0.002043776187880197,
  "max_distributable": 37586471.239521,
  "max_withdrawable": 0.0,
  "name": "Hyperliquidity Provider (HLP)",
  "parent_address": "",
  "relationship": "parent",
  "vault_address": "0xdfc24b077bc1425ad1dea75bcb6f8158e10df303"
}
```

### Get an order book

Get a market's order book: up to 20 price levels a side, each with its size and number of orders, the best bid and ask and the spread. Group prices to fewer significant figures for a wider view.

**Inputs**

- Coin (`coin`, text, required): The market: a perpetual such as BTC, or a spot pair such as HYPE/USDC (Hyperliquid names most spot pairs @ and a number, @107 for HYPE/USDC). Pick one or type a name; a perpetual on a builder-deployed exchange is written with its exchange, such as xyz:XYZ100.
- Price grouping (`sig_figs`, text): Group price levels to this many significant figures, which shows deeper into the book. Defaults to every price. One of: `full` (Every price (no grouping)), `5` (5 significant figures), `4` (4 significant figures), `3` (3 significant figures), `2` (2 significant figures). Default: `full`.

**Outputs**

- `ask_size_total` (number): The size across those ask levels
- `asks` (list): Asks, lowest first, at most 20
- `best_ask_price` (number): The lowest ask
- `best_bid_price` (number): The highest bid
- `bid_size_total` (number): The size across those bid levels
- `bids` (list): Bids, highest first, at most 20
- `coin` (text): The market
- `mid_price` (number): Halfway between them
- `sig_figs` (text): full, or the significant figures prices were grouped to
- `spread` (number): Ask minus bid
- `time` (text): When Hyperliquid took this snapshot

**Example output**

```json
{
  "ask_size_total": 24.76576,
  "asks": [
    {
      "orders": 64,
      "price": 82875.0,
      "size": 18.25204
    },
    {
      "orders": 19,
      "price": 82876.0,
      "size": 5.73812
    },
    {
      "orders": 6,
      "price": 82877.0,
      "size": 0.7756
    }
  ],
  "best_ask_price": 82875.0,
  "best_bid_price": 82874.0,
  "bid_size_total": 0.20087,
  "bids": [
    {
      "orders": 2,
      "price": 82874.0,
      "size": 0.20049
    },
    {
      "orders": 1,
      "price": 82873.0,
      "size": 0.00014
    },
    {
      "orders": 1,
      "price": 82872.0,
      "size": 0.00024
    }
  ],
  "coin": "BTC",
  "mid_price": 82874.5,
  "sig_figs": "5",
  "spread": 1.0,
  "time": "2026-10-22T04:23:12.602Z"
}
```

### Get an order's status

Look up one order of an address by its order id or client order id and get its status (open, filled, canceled and so on) and details. An order the address does not have comes back with found set to false rather than as an error.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Order id (`order_id`, text, required): The order's number (oid), or the client order id it was placed with (0x and 32 hex characters).

**Outputs**

- `cloid` (text): The client order id it was placed with, if any
- `coin` (text): The market
- `found` (true/false): False when the address has no such order
- `is_position_tpsl` (true/false): True for a take-profit or stop-loss on a position
- `is_trigger` (true/false): True for a stop or take-profit order
- `oid` (number): The order's id; 0 when not found
- `order_type` (text): Limit, Market, Stop Market and so on
- `original_size` (number): The size it was placed with
- `placed_at` (text): When it was placed
- `price` (number): The limit price
- `reduce_only` (true/false): True when it could only shrink a position
- `requested_id` (text): The order id or client order id that was asked for
- `side` (text): buy or sell
- `size` (number): The size left
- `status` (text): filled, canceled, open and so on, or unknownOid
- `status_time` (text): When it reached that status
- `time_in_force` (text): Gtc, Ioc or Alo (post only)
- `trigger_condition` (text): When it triggers, or N/A
- `trigger_price` (number): The trigger price; 0 when there is none
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "cloid": "",
  "coin": "USELESS",
  "found": true,
  "is_position_tpsl": false,
  "is_trigger": false,
  "oid": 582185705796,
  "order_type": "Limit",
  "original_size": 162.0,
  "placed_at": "2026-10-22T04:23:17.908Z",
  "price": 0.15907,
  "reduce_only": false,
  "requested_id": "582185705796",
  "side": "buy",
  "size": 162.0,
  "status": "iocCancelRejected",
  "status_time": "2026-10-22T04:23:17.908Z",
  "time_in_force": "Ioc",
  "trigger_condition": "N/A",
  "trigger_price": 0.0,
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a"
}
```

### Get candles

Get a market's price candles (open, high, low, close, volume and number of trades) for a time range, from one minute to one month each, plus the range's own open, close, high, low and change. Left empty, the range is the last 100 candles; Hyperliquid keeps the latest 5,000.

**Inputs**

- Coin (`coin`, text, required): The market: a perpetual such as BTC, or a spot pair such as HYPE/USDC (Hyperliquid names most spot pairs @ and a number, @107 for HYPE/USDC). Pick one or type a name; a perpetual on a builder-deployed exchange is written with its exchange, such as xyz:XYZ100.
- Candle length (`interval`, text): How long each candle is. Defaults to 1 hour. One of: `1m` (1 minute), `3m` (3 minutes), `5m` (5 minutes), `15m` (15 minutes), `30m` (30 minutes), `1h` (1 hour), `2h` (2 hours), `4h` (4 hours), `8h` (8 hours), `12h` (12 hours), and 4 more. Default: `1h`.
- Start time (`start`, date and time): The start of the range. Defaults to 100 candles before the end.
- End time (`end`, date and time): The end of the range. Defaults to now.

**Outputs**

- `candles` (list): The candles, oldest first
- `coin` (text): The market
- `count` (number): How many are in this result
- `end` (text): The end of the range
- `interval` (text): The candle length, such as 1h
- `period_change_percent` (number): Change from the first open to the last close, in percent
- `period_close` (number): The last candle's close
- `period_high` (number): The highest price in the range
- `period_low` (number): The lowest price in the range
- `period_open` (number): The first candle's open
- `start` (text): The start of the range
- `total_volume` (number): The volume across the range

**Example output**

```json
{
  "candles": [
    {
      "close": 82894.0,
      "close_time": "2026-10-22T02:59:59.999Z",
      "high": 83442.0,
      "low": 82777.0,
      "open": 83368.0,
      "time": "2026-10-22T02:00:00Z",
      "trades": 29471,
      "volume": 4385.55042
    },
    {
      "close": 82920.0,
      "close_time": "2026-10-22T03:59:59.999Z",
      "high": 83054.0,
      "low": 82645.0,
      "open": 82902.0,
      "time": "2026-10-22T03:00:00Z",
      "trades": 15289,
      "volume": 2642.05758
    },
    {
      "close": 82868.0,
      "close_time": "2026-10-22T04:59:59.999Z",
      "high": 82964.0,
      "low": 82810.0,
      "open": 82920.0,
      "time": "2026-10-22T04:00:00Z",
      "trades": 3661,
      "volume": 197.59872
    }
  ],
  "coin": "BTC",
  "count": 3,
  "end": "2026-10-22T04:23:00Z",
  "interval": "1h",
  "period_change_percent": -0.59975050379,
  "period_close": 82868.0,
  "period_high": 83442.0,
  "period_low": 82645.0,
  "period_open": 83368.0,
  "start": "2026-10-18T00:23:00Z",
  "total_volume": 7225.20672
}
```

### Get funding history

Get a perpetual's funding rate hour by hour over a time range, with the average and what it comes to over a year. Rates are fractions paid every hour: 0.0000125 is 0.00125%, and a positive rate means longs pay shorts. Left empty, the range is the last 24 hours; up to 5,000 hours a step.

**Inputs**

- Perpetual (`coin`, text, required): The perpetual, such as BTC or HYPE. Pick one or type a name; one on a builder-deployed exchange is written xyz:XYZ100.
- Start time (`start`, date and time): The start of the range. Defaults to 24 hours before the end.
- End time (`end`, date and time): The end of the range. Defaults to now.

**Outputs**

- `average_annualized_percent` (number): The average over a year, in percent
- `average_funding_rate` (number): The average hourly rate
- `coin` (text): The perpetual
- `count` (number): How many are in this result
- `end` (text): The end of the range
- `has_more` (true/false): True when the range held more than 5,000 hours
- `hours` (list): One entry per hour, oldest first
- `latest_funding_rate` (number): The most recent rate
- `start` (text): The start of the range
- `total_funding_rate` (number): The rates added up across the range

**Example output**

```json
{
  "average_annualized_percent": 8.2198,
  "average_funding_rate": 9.38333333333e-06,
  "coin": "BTC",
  "count": 3,
  "end": "2026-10-22T04:23:00Z",
  "has_more": false,
  "hours": [
    {
      "funding_rate": 3.15e-06,
      "premium": -0.0004747997,
      "time": "2026-10-22T02:00:00.025Z"
    },
    {
      "funding_rate": 1.25e-05,
      "premium": -0.0003598359,
      "time": "2026-10-22T03:00:00Z"
    },
    {
      "funding_rate": 1.25e-05,
      "premium": -0.0002627204,
      "time": "2026-10-22T04:00:00.024Z"
    }
  ],
  "latest_funding_rate": 1.25e-05,
  "start": "2026-10-21T04:23:00Z",
  "total_funding_rate": 2.815e-05
}
```

### Get mid prices

Get the current mid price (halfway between the best bid and ask) of every perpetual, every spot pair, or both, in one step; or of just the coins chosen. Spot pairs come with their readable names, such as HYPE/USDC.

**Inputs**

- Markets (`market`, text): Which markets to price. Defaults to perpetuals. One of: `perp` (Perpetuals), `spot` (Spot pairs), `all` (Everything). Default: `perp`.
- Only these coins (`coins`, list): Only these markets, such as BTC and ETH. Leave it empty for every market of the chosen kind.
- Exchange (`dex`, text): A builder-deployed (HIP-3) perpetual exchange to read instead of Hyperliquid's own, such as xyz. Leave it empty for Hyperliquid's own.

**Outputs**

- `count` (number): How many are in this result
- `dex` (text): The perpetual exchange read; empty for Hyperliquid's own
- `market` (text): perp, spot or all
- `prices` (list): Mid prices, in Hyperliquid's order

**Example output**

```json
{
  "count": 6,
  "dex": "",
  "market": "all",
  "prices": [
    {
      "coin": "BTC",
      "market": "perp",
      "mid_price": 82875.5,
      "name": "BTC"
    },
    {
      "coin": "ETH",
      "market": "perp",
      "mid_price": 2444.05,
      "name": "ETH"
    },
    {
      "coin": "HYPE",
      "market": "perp",
      "mid_price": 78.9925,
      "name": "HYPE"
    },
    {
      "coin": "PURR/USDC",
      "market": "spot",
      "mid_price": 0.0996195,
      "name": "PURR/USDC"
    },
    {
      "coin": "@107",
      "market": "spot",
      "mid_price": 79.0295,
      "name": "HYPE/USDC"
    },
    {
      "coin": "#114910",
      "market": "outcome",
      "mid_price": 0.5,
      "name": "#114910"
    }
  ]
}
```

### Get portfolio history

Get how an address's account value and profit or loss moved over the last day, week or month, or all time, with its trading volume; for everything or perpetuals only.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Period (`period`, text): Which period to read. Defaults to the last week. One of: `day` (Last day), `week` (Last week), `month` (Last month), `allTime` (All time), `perpDay` (Last day, perpetuals only), `perpWeek` (Last week, perpetuals only), `perpMonth` (Last month, perpetuals only), `perpAllTime` (All time, perpetuals only). Default: `week`.

**Outputs**

- `account_value_history` (list): Account value over the period
- `count` (number): How many account value points came back
- `latest_account_value` (number): The latest account value
- `latest_pnl` (number): The latest profit or loss
- `period` (text): day, week, month, allTime, or the perp-only versions
- `pnl_history` (list): Profit or loss over the period
- `user` (text): The address that was read, in lower case
- `volume` (number): Volume traded over the period, in US dollars

**Example output**

```json
{
  "account_value_history": [
    {
      "account_value": 3149291.012367,
      "time": "2026-10-22T00:50:00.005Z"
    },
    {
      "account_value": 3144902.481085,
      "time": "2026-10-22T02:50:00.030Z"
    },
    {
      "account_value": 3147403.738063,
      "time": "2026-10-22T04:23:19.315Z"
    }
  ],
  "count": 3,
  "latest_account_value": 3147403.738063,
  "latest_pnl": -8001.161049,
  "period": "day",
  "pnl_history": [
    {
      "pnl": -6113.886745,
      "time": "2026-10-22T00:50:00.005Z"
    },
    {
      "pnl": -10502.418027,
      "time": "2026-10-22T02:50:00.030Z"
    },
    {
      "pnl": -8001.161049,
      "time": "2026-10-22T04:23:19.315Z"
    }
  ],
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a",
  "volume": 15806863.55
}
```

### Get spot balances

Get an address's spot token balances: each token's total, the part held by open orders, what is free, and what it cost.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.

**Outputs**

- `balances` (list): Token balances
- `count` (number): How many are in this result
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "balances": [
    {
      "available": 1134.29113728,
      "coin": "USDC",
      "entry_value_usd": 0.0,
      "hold": 9999.90405,
      "token": 0,
      "total": 11134.19518728
    },
    {
      "available": 0.62505,
      "coin": "PURR",
      "entry_value_usd": 0.05826966,
      "hold": 0.0,
      "token": 1,
      "total": 0.62505
    },
    {
      "available": 0.9597,
      "coin": "JEFF",
      "entry_value_usd": 2.47679376,
      "hold": 0.0,
      "token": 5,
      "total": 0.9597
    }
  ],
  "count": 3,
  "user": "0xfefefefefefefefefefefefefefefefefefefefe"
}
```

### Get staking

Get an address's HYPE staking: how much is staked and to which validators, how much is unstaked, and withdrawals still on their way.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.

**Outputs**

- `count` (number): How many are in this result
- `delegated` (number): HYPE staked
- `delegations` (list): Stakes, one per validator
- `pending_withdrawal` (number): HYPE on its way out of staking
- `pending_withdrawals` (number): How many withdrawals are pending
- `undelegated` (number): HYPE in the staking account but not staked
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "count": 1,
  "delegated": 10020.95256672,
  "delegations": [
    {
      "amount": 10020.95256672,
      "locked_until": "2024-12-29T19:13:57.888Z",
      "validator": "0x000000000056f99d36b6f2e0c51fd41496bbacb8"
    }
  ],
  "pending_withdrawal": 115.0,
  "pending_withdrawals": 2,
  "undelegated": 1.0,
  "user": "0x000000000056f99d36b6f2e0c51fd41496bbacb8"
}
```

### List fills

List an address's trades (fills) with price, size, direction, realised profit or loss and fee. Without a start time, the latest fills, newest first; with one, the fills from then on, oldest first, up to 2,000 a step and within the latest 10,000.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Start time (`start`, date and time): Only fills at or after this time. Leave it empty for the latest fills.
- End time (`end`, date and time): Only fills at or before this time; needs a start time. Defaults to now.
- Coin (`coin`, text): Only this market, such as BTC. Leave it empty for every one.
- Combine partial fills (`aggregate_by_time`, true/false): Combine the partial fills of one order at one moment into a single fill. Default: `false`.
- Most to return (`limit`, number): The most to return, up to 2,000. Defaults to 100. From 1 to 2000. Default: `100`.

**Outputs**

- `closed_pnl_total` (number): Realised profit or loss across these fills
- `count` (number): How many are in this result
- `fees_total` (number): Fees across these fills
- `fills` (list): Fills: newest first, or from the start time on, oldest first
- `has_more` (true/false): True when more fills match than came back; for a range, start the next step at the last fill's time
- `matched_count` (number): How many matched before the limit
- `order` (text): newest_first, or oldest_first for a time range
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "closed_pnl_total": 0.0,
  "count": 2,
  "fees_total": 0.0,
  "fills": [
    {
      "closed_pnl": 0.0,
      "coin": "MET",
      "crossed": true,
      "direction": "Open Long",
      "fee": 0.0,
      "fee_token": "USDC",
      "hash": "0xb19b3554cd61650fb31404471789b50201d5003a686483e15563e0a78c653efa",
      "oid": 582185691696,
      "price": 0.34846,
      "side": "buy",
      "size": 56.0,
      "start_position": 41498.0,
      "tid": 423327165056519,
      "time": "2026-10-22T04:23:16.425Z",
      "value": 19.51376
    },
    {
      "closed_pnl": 0.0,
      "coin": "ATOM",
      "crossed": true,
      "direction": "Open Long",
      "fee": 0.0,
      "fee_token": "USDC",
      "hash": "0x7226be0d98c753eb73a004471789b00202d400f333ca72bd15ef696057cb2dd6",
      "oid": 582185688281,
      "price": 1.7245,
      "side": "buy",
      "size": 22.64,
      "start_position": 6892.46,
      "tid": 381452755771962,
      "time": "2026-10-22T04:23:16.069Z",
      "value": 39.04268
    }
  ],
  "has_more": false,
  "matched_count": 2,
  "order": "newest_first",
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a"
}
```

### List funding payments

List the funding an address paid or received on its positions, hour by hour and oldest first, with the net total. Left empty, the range is the last 24 hours; up to 5,000 payments a step.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Start time (`start`, date and time): The start of the range. Defaults to 24 hours before the end.
- End time (`end`, date and time): The end of the range. Defaults to now.
- Coin (`coin`, text): Only this market, such as BTC. Leave it empty for every one.

**Outputs**

- `count` (number): How many are in this result
- `end` (text): The end of the range
- `has_more` (true/false): True when the range held more than 5,000 payments; narrow the range
- `payments` (list): Payments, oldest first
- `start` (text): The start of the range
- `total_usdc` (number): Net USDC received across them; negative when paid
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "count": 2,
  "end": "2026-10-22T04:23:00Z",
  "has_more": false,
  "payments": [
    {
      "amount_usdc": -0.757944,
      "coin": "BTC",
      "funding_rate": 1.25e-05,
      "position_size": 0.73118,
      "time": "2026-10-22T04:00:00.024Z"
    },
    {
      "amount_usdc": -0.239041,
      "coin": "ETH",
      "funding_rate": 1.25e-05,
      "position_size": 7.8221,
      "time": "2026-10-22T04:00:00.024Z"
    }
  ],
  "start": "2026-10-21T04:23:00Z",
  "total_usdc": -0.996985,
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a"
}
```

### List open orders

List an address's open orders, including stops and take-profits, with price, size, type, time in force and when each was placed.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Coin (`coin`, text): Only this market, such as BTC. Leave it empty for every one.
- Exchange (`dex`, text): A builder-deployed (HIP-3) perpetual exchange to read instead of Hyperliquid's own, such as xyz. Leave it empty for Hyperliquid's own.

**Outputs**

- `count` (number): How many are in this result
- `dex` (text): The exchange read; empty for Hyperliquid's own
- `orders` (list): Open orders, newest first
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "count": 2,
  "dex": "",
  "orders": [
    {
      "cloid": "",
      "coin": "ETH",
      "is_position_tpsl": false,
      "is_trigger": false,
      "oid": 582185647976,
      "order_type": "Limit",
      "original_size": 0.3388,
      "placed_at": "2026-10-22T04:23:13.012Z",
      "price": 2444.6,
      "reduce_only": false,
      "side": "sell",
      "size": 0.3388,
      "time_in_force": "Alo",
      "trigger_condition": "N/A",
      "trigger_price": 0.0
    },
    {
      "cloid": "",
      "coin": "ETH",
      "is_position_tpsl": false,
      "is_trigger": false,
      "oid": 582185647975,
      "order_type": "Limit",
      "original_size": 0.1645,
      "placed_at": "2026-10-22T04:23:13.012Z",
      "price": 2444.1,
      "reduce_only": false,
      "side": "sell",
      "size": 0.1645,
      "time_in_force": "Alo",
      "trigger_condition": "N/A",
      "trigger_price": 0.0
    }
  ],
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a"
}
```

### List order history

List an address's latest orders, newest first, whatever became of them: filled, canceled, rejected or still open, with when each reached that status. Reads the latest 2,000.

**Inputs**

- Address (`user`, text, required): The account's address: 0x and 40 hex characters. Everything on Hyperliquid is public, so any account can be read; a vault's address works too.
- Coin (`coin`, text): Only this market, such as BTC. Leave it empty for every one.
- Most to return (`limit`, number): The most to return, up to 2,000. Defaults to 100. From 1 to 2000. Default: `100`.

**Outputs**

- `count` (number): How many are in this result
- `matched_count` (number): How many matched before the limit
- `orders` (list): Orders, newest first
- `user` (text): The address that was read, in lower case

**Example output**

```json
{
  "count": 2,
  "matched_count": 2,
  "orders": [
    {
      "cloid": "",
      "coin": "USELESS",
      "is_position_tpsl": false,
      "is_trigger": false,
      "oid": 582185705796,
      "order_type": "Limit",
      "original_size": 162.0,
      "placed_at": "2026-10-22T04:23:17.908Z",
      "price": 0.15907,
      "reduce_only": false,
      "side": "buy",
      "size": 162.0,
      "status": "iocCancelRejected",
      "status_time": "2026-10-22T04:23:17.908Z",
      "time_in_force": "Ioc",
      "trigger_condition": "N/A",
      "trigger_price": 0.0
    },
    {
      "cloid": "",
      "coin": "LAYER",
      "is_position_tpsl": false,
      "is_trigger": false,
      "oid": 582185704855,
      "order_type": "Limit",
      "original_size": 10117.0,
      "placed_at": "2026-10-22T04:23:17.839Z",
      "price": 0.066212,
      "reduce_only": false,
      "side": "sell",
      "size": 10117.0,
      "status": "open",
      "status_time": "2026-10-22T04:23:17.839Z",
      "time_in_force": "Alo",
      "trigger_condition": "N/A",
      "trigger_price": 0.0
    }
  ],
  "user": "0x010461c14e146ac35fe42271bdc1134ee31c703a"
}
```

### List perpetuals

List Hyperliquid's perpetuals with their market: mark, oracle and mid price, 24-hour change and volume, open interest, the hourly funding rate and maximum leverage. Sorted by volume by default; can read a builder-deployed exchange instead.

**Inputs**

- Exchange (`dex`, text): A builder-deployed (HIP-3) perpetual exchange to read instead of Hyperliquid's own, such as xyz. Leave it empty for Hyperliquid's own.
- Sort by (`sort_by`, text): Which perpetuals come first. One of: `volume` (Most traded (24-hour volume)), `open_interest` (Largest open interest), `funding` (Highest funding rate), `change` (Biggest 24-hour rise), `name` (By name). Default: `volume`.
- Most to return (`limit`, number): The most to return, up to 2,000. Defaults to 100. From 1 to 2000. Default: `100`.
- Include delisted (`include_delisted`, true/false): Also list perpetuals that no longer trade. Default: `false`.

**Outputs**

- `count` (number): How many are in this result
- `dex` (text): The exchange read; empty for Hyperliquid's own
- `perpetuals` (list): The perpetuals, in the chosen order
- `sort_by` (text): volume, open_interest, funding, change or name
- `total_count` (number): How many perpetuals the exchange lists
- `total_volume_24h_usd` (number): 24-hour US dollar volume across all of them

**Example output**

```json
{
  "count": 3,
  "dex": "",
  "perpetuals": [
    {
      "change_percent_24h": 0.0881642512077,
      "coin": "BTC",
      "dex": "",
      "funding_annualized_percent": 10.95,
      "funding_rate": 1.25e-05,
      "impact_ask_price": 82875.0,
      "impact_bid_price": 82872.3,
      "is_delisted": false,
      "isolated_only": false,
      "mark_price": 82873.0,
      "max_leverage": 40,
      "mid_price": 82874.5,
      "open_interest": 39974.46542,
      "open_interest_usd": 3312803872.75,
      "oracle_price": 82891.0,
      "premium": -0.0001930246,
      "prev_day_price": 82800.0,
      "size_decimals": 5,
      "volume_24h": 33651.78332,
      "volume_24h_usd": 2821050959.049752
    },
    {
      "change_percent_24h": -0.0286345414383,
      "coin": "ETH",
      "dex": "",
      "funding_annualized_percent": 10.95,
      "funding_rate": 1.25e-05,
      "impact_ask_price": 2444.1,
      "impact_bid_price": 2444.0,
      "is_delisted": false,
      "isolated_only": false,
      "mark_price": 2443.9,
      "max_leverage": 25,
      "mid_price": 2444.05,
      "open_interest": 1107188.2788000002,
      "open_interest_usd": 2705857434.56,
      "oracle_price": 2444.4,
      "premium": -0.0001227295,
      "prev_day_price": 2444.6,
      "size_decimals": 4,
      "volume_24h": 365663.7014000001,
      "volume_24h_usd": 906856149.4796402
    },
    {
      "change_percent_24h": -2.36706795541,
      "coin": "HYPE",
      "dex": "",
      "funding_annualized_percent": 10.5958332,
      "funding_rate": 1.20957e-05,
      "impact_ask_price": 78.9942,
      "impact_bid_price": 78.992,
      "is_delisted": false,
      "isolated_only": false,
      "mark_price": 78.9909,
      "max_leverage": 10,
      "mid_price": 78.9925,
      "open_interest": 20294230.120000005,
      "open_interest_usd": 1603059501.99,
      "oracle_price": 79.0325,
      "premium": -0.0004846108,
      "prev_day_price": 80.906,
      "size_decimals": 2,
      "volume_24h": 6052293.7000000095,
      "volume_24h_usd": 489891773.17798024
    }
  ],
  "sort_by": "volume",
  "total_count": 3,
  "total_volume_24h_usd": 4217798881.71
}
```

### List predicted funding rates

List the next funding rate Hyperliquid predicts for each perpetual on Hyperliquid, Binance and Bybit, with how often each venue pays and the rate per hour, so the venues can be compared.

**Inputs**

- Only these perpetuals (`coins`, list): Only these perpetuals, such as BTC and ETH. Leave it empty for every one.
- Venue (`venue`, text): Only one venue. Leave it unset for all three. One of: `Hyperliquid`, `Binance`, `Bybit`.

**Outputs**

- `count` (number): How many are in this result
- `fundings` (list): One entry per coin and venue
- `venue` (text): The venue kept; empty for all three

**Example output**

```json
{
  "count": 3,
  "fundings": [
    {
      "coin": "BTC",
      "funding_rate": -2.678e-05,
      "hourly_rate": -3.3475e-06,
      "interval_hours": 8,
      "next_funding_time": "2026-10-22T08:00:00Z",
      "venue": "Binance"
    },
    {
      "coin": "BTC",
      "funding_rate": 1.25e-05,
      "hourly_rate": 1.25e-05,
      "interval_hours": 1,
      "next_funding_time": "2026-10-22T04:00:00Z",
      "venue": "Hyperliquid"
    },
    {
      "coin": "BTC",
      "funding_rate": 3.997e-05,
      "hourly_rate": 4.99625e-06,
      "interval_hours": 8,
      "next_funding_time": "2026-10-22T08:00:00Z",
      "venue": "Bybit"
    }
  ],
  "venue": ""
}
```

### List recent trades

List a market's latest trades, newest first, with price, size, the side that took liquidity, and the two accounts that traded.

**Inputs**

- Coin (`coin`, text, required): The market: a perpetual such as BTC, or a spot pair such as HYPE/USDC (Hyperliquid names most spot pairs @ and a number, @107 for HYPE/USDC). Pick one or type a name; a perpetual on a builder-deployed exchange is written with its exchange, such as xyz:XYZ100.

**Outputs**

- `coin` (text): The market
- `count` (number): How many are in this result
- `trades` (list): The latest trades, newest first

**Example output**

```json
{
  "coin": "BTC",
  "count": 2,
  "trades": [
    {
      "coin": "BTC",
      "hash": "0xdea3031f3f51aec2e01c04471789870204b20004da54cd94826bae71fe5588ad",
      "price": 82872.0,
      "side": "sell",
      "size": 0.00024,
      "tid": 812032940548475,
      "time": "2026-10-22T04:23:13.276Z",
      "users": [
        "0xe3230692367e834fc282d1ff996b91896fae2f17",
        "0x27c9fa86c91b84ddfa15de58c482ff662498d65d"
      ],
      "value": 19.88928
    },
    {
      "coin": "BTC",
      "hash": "0xdea3031f3f51aec2e01c04471789870204b20004da54cd94826bae71fe5588ad",
      "price": 82874.0,
      "side": "sell",
      "size": 0.00049,
      "tid": 417980885538715,
      "time": "2026-10-22T04:23:13.276Z",
      "users": [
        "0xcbbaff8826b4723020562c24fb6cc1c38c0c3045",
        "0x27c9fa86c91b84ddfa15de58c482ff662498d65d"
      ],
      "value": 40.60826
    }
  ]
}
```

### List spot markets

List Hyperliquid's spot pairs with their readable names (HYPE/USDC for @107), price, 24-hour change and volume, and the token's supply. Sorted by volume by default.

**Inputs**

- Name contains (`contains`, text): Only pairs whose name or token contains this text, such as HYPE. Leave it empty for every pair.
- Sort by (`sort_by`, text): Which pairs come first. One of: `volume` (Most traded (24-hour volume)), `change` (Biggest 24-hour rise), `name` (By name). Default: `volume`.
- Most to return (`limit`, number): The most to return, up to 2,000. Defaults to 100. From 1 to 2000. Default: `100`.

**Outputs**

- `count` (number): How many are in this result
- `markets` (list): The spot pairs, in the chosen order
- `sort_by` (text): volume, change or name
- `total_count` (number): How many pairs matched before the limit

**Example output**

```json
{
  "count": 2,
  "markets": [
    {
      "base": "HYPE",
      "base_full_name": "Hyperliquid",
      "change_percent_24h": -2.35253416364,
      "circulating_supply": 302028659.64173,
      "coin": "@107",
      "index": 107,
      "is_canonical": false,
      "mark_price": 79.03,
      "mid_price": 79.0295,
      "name": "HYPE/USDC",
      "prev_day_price": 80.934,
      "quote": "USDC",
      "total_supply": 998836459.938415,
      "volume_24h": 706685.4399999998,
      "volume_24h_usd": 57315455.00363999
    },
    {
      "base": "PURR",
      "base_full_name": "",
      "change_percent_24h": 0.240585458169,
      "circulating_supply": 594722376.77893,
      "coin": "PURR/USDC",
      "index": 0,
      "is_canonical": true,
      "mark_price": 0.09958,
      "mid_price": 0.0996195,
      "name": "PURR/USDC",
      "prev_day_price": 0.099341,
      "quote": "USDC",
      "total_supply": 594722388.08545,
      "volume_24h": 12154063.0,
      "volume_24h_usd": 1240922.1816870004
    }
  ],
  "sort_by": "volume",
  "total_count": 2
}
```

### List validators

List Hyperliquid's validators with the HYPE staked to each, their commission, predicted staking APR, uptime and whether they are active or jailed.

**Inputs**

- Sort by (`sort_by`, text): Which validators come first. One of: `stake` (Most staked), `apr` (Highest APR), `name` (By name). Default: `stake`.
- Active only (`active_only`, true/false): Leave out validators that are not in the active set. Default: `true`.

**Outputs**

- `count` (number): How many are in this result
- `sort_by` (text): stake, apr or name
- `total_count` (number): How many validators there are, active or not
- `total_stake` (number): HYPE staked across those listed
- `validators` (list): Validators, in the chosen order

**Example output**

```json
{
  "count": 3,
  "sort_by": "stake",
  "total_count": 3,
  "total_stake": 113242992.521,
  "validators": [
    {
      "apr_percent": 2.16353362,
      "commission_percent": 3.0,
      "description": "Hyper Foundation 2",
      "is_active": true,
      "is_jailed": false,
      "name": "Hyper Foundation 2",
      "recent_blocks": 18,
      "signer": "0xa82fe73bbd768bc15d1ef2f6142a21ff8bd762ad",
      "stake": 54266959.8487,
      "uptime_percent": 100.0,
      "validator": "0xa82fe73bbd768bc15d1ef2f6142a21ff8bd762ad"
    },
    {
      "apr_percent": 2.16353362,
      "commission_percent": 3.0,
      "description": "Hyper Foundation 1",
      "is_active": true,
      "is_jailed": false,
      "name": "Hyper Foundation 1",
      "recent_blocks": 16,
      "signer": "0x5ac99df645f3414876c816caa18b2d234024b487",
      "stake": 52474858.0636,
      "uptime_percent": 100.0,
      "validator": "0x5ac99df645f3414876c816caa18b2d234024b487"
    },
    {
      "apr_percent": 2.14122915,
      "commission_percent": 4.0,
      "description": "The People\u2019s Validator. Zero seed oils. Yours truly. https://validao.xyz",
      "is_active": true,
      "is_jailed": false,
      "name": "ValiDAO",
      "recent_blocks": 0,
      "signer": "0x0000000008b0b558419582041f85740344ae8fde",
      "stake": 6501174.60877,
      "uptime_percent": 100.0,
      "validator": "0x000000000056f99d36b6f2e0c51fd41496bbacb8"
    }
  ]
}
```
