Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Hyperliquid

All Hyperliquid commands live under heat hl.

Hyperliquid is currently the simpler protocol in Heat: your Heat account address is the address you use for Hyperliquid reads and writes.

For the recommended first-time flow, start with Hyperliquid Onboarding.

What needs an account

Read-only market commands do not need a signing account:

  • price
  • perps
  • spot

Account and trading commands do:

  • balance
  • positions
  • orders
  • buy
  • sell
  • cancel
  • leverage
  • send
  • some user-specific streams

Funding

Use heat accounts get <name> to retrieve the account address you need to fund.

Network selection

NetworkFlagDescription
Mainnet(default)Production trading
Testnet--network testnetPaper trading
heat hl price BTC --network testnet

Best first commands

heat hl price BTC
heat hl perps
heat hl balance
heat hl buy ETH 0.1 --price 3500 --dry-run

Commands

price

Show the mid price for an asset.

heat hl price BTC
heat hl price ETH
heat hl price PURR/USDC

Quiet mode emits just the number:

PRICE=$(heat hl price BTC -q)

perps

List perpetual markets.

heat hl perps

Output includes name, index, size decimals, and max leverage.

Filter by HIP-3 DEX:

heat hl perps --dex <dex_name>

spot

List spot markets.

heat hl spot

Output includes name, index, base token, and quote token.

balance

Show account balances.

heat hl balance
heat hl balance --address 0x...

In pretty mode, Heat displays balances per coin. Quiet mode emits the account value.

positions

Show open perpetual positions.

heat hl positions
heat hl positions --address 0x...

orders

Show open orders.

heat hl orders
heat hl orders --address 0x...

buy

Place a buy order. Requires an account.

# limit order
heat hl buy ETH 0.5 --price 3500
 
# market order
heat hl buy ETH 0.5
 
# custom time in force
heat hl buy ETH 0.5 --price 3500 --tif ioc
 
# reduce-only
heat hl buy ETH 0.5 --price 3500 --reduce-only

Market orders use a small internal slippage buffer from the mid price.

Preview without executing:

heat hl buy ETH 0.5 --price 3500 --dry-run

sell

Place a sell order.

heat hl sell BTC 0.01 --price 100000
heat hl sell BTC 0.01 --dry-run

cancel

Cancel orders.

heat hl cancel BTC --oid 12345
heat hl cancel BTC --all
heat hl cancel --all

leverage

View or set leverage.

heat hl leverage show
heat hl leverage set BTC 10
heat hl leverage set ETH 5 --isolated

send

Send USDC or spot tokens.

heat hl send 0xDEST... 100
heat hl send 0xDEST... 50 --token PURR

stream trades

Stream real-time trades.

heat hl stream trades BTC
heat hl stream trades ETH --output ndjson | jq -r '.px'

The connection auto-reconnects. Diagnostics go to stderr.