Exchange
Signed exchange-action client.
agent_enable_dex_abstraction
Enable HIP-3 DEX abstraction (agent, deprecated).
References
Source code in pkg/src/hyperliquid/exchange/agent_enable_dex_abstraction.py
agent_set_abstraction
Set user abstraction (agent).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
abstraction
|
AgentAbstraction
|
Agent abstraction mode to set. |
required |
References
Source code in pkg/src/hyperliquid/exchange/agent_set_abstraction.py
approve_agent
Approve an API wallet (agent).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
agent_address
|
str
|
API wallet address to approve. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
agent_name
|
str | None
|
Optional display name for the API wallet. |
None
|
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/approve_agent.py
approve_builder_fee
Approve a maximum builder fee rate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
max_fee_rate
|
str
|
Maximum fee rate to approve. |
required |
builder
|
str
|
Builder address. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/approve_builder_fee.py
cancel
Cancel one or more orders.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cancels
|
Cancel
|
Cancel wire objects with asset + order id. |
()
|
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/cancel.py
cancel_by_cloid
Cancel one or more orders by cloid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cancels
|
CancelByCloid
|
Cancel wire objects with asset + cloid. |
()
|
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/cancel_by_cloid.py
modify_order
Modify a single order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
oid
|
int | str
|
Order id or cloid. |
required |
order
|
Order
|
Order wire object. |
required |
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/modify_order.py
modify_orders
Modify multiple orders.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
modifies
|
Modify
|
Modify wire objects. |
()
|
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/modify_orders.py
noop
Invalidate a pending nonce (noop).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/noop.py
order
Place one or more orders.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
orders
|
Order
|
Order wire objects. |
()
|
grouping
|
Grouping
|
Grouping mode for normal or TPSL orders. |
'na'
|
builder
|
BuilderInfo | None
|
Optional builder fee information. |
None
|
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/order.py
reserve_request_weight
Reserve additional actions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
weight
|
int
|
Additional request weight to reserve. |
required |
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/reserve_request_weight.py
schedule_cancel
Schedule a cancel-all operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
int | None
|
UTC millis when all open orders should be canceled. If |
None
|
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/schedule_cancel.py
send_asset
Send assets between DEXs, spot, users, or subaccounts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str
|
Destination user, subaccount, spot account, or DEX address. |
required |
source_dex
|
str
|
Source DEX name. Use an empty string for the main DEX. |
required |
destination_dex
|
str
|
Destination DEX name. Use an empty string for the main DEX. |
required |
token
|
str
|
Token symbol or token id to send. |
required |
amount
|
str
|
Decimal amount string. |
required |
from_subaccount
|
str
|
Source subaccount name, or empty string for the main account. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/send_asset.py
send_to_evm_with_data
Send to EVM with data payload.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
token
|
str
|
Token symbol or token id to send. |
required |
amount
|
str
|
Decimal amount string. |
required |
source_dex
|
str
|
Source DEX name. Use an empty string for the main DEX. |
required |
destination_recipient
|
str
|
Recipient on the destination EVM chain. |
required |
address_encoding
|
Literal['hex', 'base58']
|
Encoding used for the destination recipient. |
required |
destination_chain_id
|
int
|
Destination EVM chain id. |
required |
gas_limit
|
int
|
Gas limit for the destination call. |
required |
data
|
str
|
Hex-encoded calldata. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/send_to_evm_with_data.py
spot_transfer
Core spot transfer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str
|
Destination address. |
required |
token
|
str
|
Spot token to transfer. |
required |
amount
|
str
|
Decimal amount string. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
time
|
int | None
|
Optional action timestamp. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/spot_transfer.py
staking_deposit
Deposit native token into staking.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
wei
|
int
|
Amount to deposit in wei. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/staking_deposit.py
staking_withdraw
Withdraw native token from staking.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
wei
|
int
|
Amount to withdraw in wei. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/staking_withdraw.py
token_delegate
Delegate or undelegate stake to a validator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
validator
|
str
|
Validator address. |
required |
is_undelegate
|
bool
|
Whether to undelegate instead of delegate. |
required |
wei
|
int
|
Stake amount in wei. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/token_delegate.py
twap_cancel
Cancel a TWAP order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
asset
|
int
|
Asset index. |
required |
twap_id
|
int
|
TWAP order id. |
required |
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/twap_cancel.py
twap_order
Place a TWAP order.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
twap
|
TwapWire
|
TWAP order wire object. |
required |
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/twap_order.py
update_isolated_margin
Add or remove margin from an isolated position.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
asset
|
int
|
Asset index. |
required |
is_buy
|
bool
|
Position side; true for long, false for short. |
required |
ntli
|
int
|
Margin delta in native token lots. |
required |
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/update_isolated_margin.py
top_up_isolated_only_margin
Target leverage for isolated margin with an alternate action.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
asset
|
int
|
Asset index. |
required |
leverage
|
str
|
Target leverage as a decimal string. |
required |
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/update_isolated_margin.py
update_leverage
Update cross or isolated leverage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
asset
|
int
|
Asset index. |
required |
is_cross
|
bool
|
Whether to use cross margin. |
required |
leverage
|
int
|
Target leverage. |
required |
vault_address
|
str | None
|
Optional vault address for the signed action. |
None
|
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/update_leverage.py
usd_class_transfer
Transfer USDC between spot and perp accounts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
amount
|
str
|
Decimal amount string. |
required |
to_perp
|
bool
|
Whether to transfer from spot to perp. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
subaccount
|
str | None
|
Optional subaccount address. |
None
|
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/usd_class_transfer.py
usdc_transfer
Core USDC transfer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
destination
|
str
|
Destination address. |
required |
amount
|
str
|
Decimal amount string. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
time
|
int | None
|
Optional action timestamp. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/usdc_transfer.py
user_dex_abstraction
Enable HIP-3 DEX abstraction (deprecated).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user
|
str
|
User address. |
required |
enabled
|
bool
|
Whether DEX abstraction is enabled. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/user_dex_abstraction.py
user_set_abstraction
Set user abstraction.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user
|
str
|
User address. |
required |
abstraction
|
Abstraction
|
Abstraction mode to set. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
nonce
|
int | None
|
Optional action nonce. Defaults to the current timestamp. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/user_set_abstraction.py
validator_l1_stream
Vote on risk-free rate for aligned quote asset.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
risk_free_rate
|
str
|
Risk-free rate vote as a decimal string. |
required |
References
Source code in pkg/src/hyperliquid/exchange/validator_l1_stream.py
vault_transfer
Deposit or withdraw from a vault.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vault_address
|
str
|
Vault address. |
required |
is_deposit
|
bool
|
Whether to deposit into the vault. |
required |
usd
|
float
|
USD amount. |
required |
expires_after
|
int | None
|
Optional expiration timestamp for the signed action. |
None
|
References
Source code in pkg/src/hyperliquid/exchange/vault_transfer.py
withdraw3
Initiate a withdrawal request.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
amount
|
str
|
Decimal USDC amount string. |
required |
destination
|
str
|
Destination address. |
required |
signature_chain_id
|
str
|
Chain id used for the user-signed action. |
required |
time
|
int | None
|
Optional action timestamp. Defaults to the current timestamp. |
None
|