Exchange endpoint
The exchange endpoint is used to interact with and trade on the Hyperliquid chain. See the Python SDK for code to generate signatures for these requests.
Many of the requests take asset as an input. For perpetuals this is the index in the universe field returned by themeta response. For spot assets, use 10000 + index where index is the corresponding index in spotMeta.universe. For example, when submitting an order for PURR/USDC, the asset that should be used is 10000 because its asset index in the spot metadata is 0.
Place an order
POST https://api.hyperliquid.xyz/exchange
See Python SDK for full featured examples on the fields of the order request.
For limit orders, TIF (time-in-force) sets the behavior of the order upon first hitting the book.
ALO (add liquidity only, i.e. "post only") will be canceled instead of immediately matching.
IOC (immediate or cancel) will have the unfilled part canceled instead of resting.
GTC (good til canceled) orders have no special behavior.
Client Order ID (cloid) is an optional 128 bit hex string, e.g. 0x1234567890abcdef1234567890abcdef
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "order", "orders": [{
"a": Number,
"b": Boolean,
"p": String,
"s": String,
"r": Boolean,
"t": {
"limit": {
"tif": "Alo" | "Ioc" | "Gtc"
} or
"trigger": {
"isMarket": Boolean,
"triggerPx": String,
"tpsl": "tp" | "sl"
}
},
"c": Cloid (optional)
}],
"grouping": "na" | "normalTpsl" | "positionTpsl",
"builder": Optional({"b": "address", "f": Number})
} Meaning of keys: a is asset b is isBuy p is price s is size r is reduceOnly t is type c is cloid (client order id) Meaning of keys in optional builder argument: b is the address the should receive the additional fee f is the size of the fee in tenths of a basis point e.g. if f is 10, 1bp of the order notional will be charged to the user and sent to the builder
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its Onchain address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Cancel order(s)
POST https://api.hyperliquid.xyz/exchange
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "cancel",
"cancels": [
{
"a": Number,
"o": Number
}
]
} Meaning of keys: a is asset o is oid (order id)
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Cancel order(s) by cloid
POST https://api.hyperliquid.xyz/exchange
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "cancelByCloid",
"cancels": [
{
"asset": Number,
"cloid": String
}
]
}
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Schedule Cancel (dead man's switch)
POST https://api.hyperliquid.xyz/exchange
Schedule a cancel-all operation at a future time. Setting time to null will remove any outstanding scheduled cancel operation.
Modify an order
POST https://api.hyperliquid.xyz/exchange
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "modify",
"oid": Number | Cloid,
"order": {
"a": Number,
"b": Boolean,
"p": String,
"s": String,
"r": Boolean,
"t": {
"limit": {
"tif": "Alo" | "Ioc" | "Gtc"
} or
"trigger": {
"isMarket": Boolean,
"triggerPx": String,
"tpsl": "tp" | "sl"
}
},
"c": Cloid (optional)
}
} Meaning of keys: a is asset b is isBuy p is price s is size r is reduceOnly t is type c is cloid (client order id)
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its Onchain address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Modify multiple orders
POST https://api.hyperliquid.xyz/exchange
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "batchModify",
"modifies": [
"oid": Number | Cloid,
"order": {
"a": Number,
"b": Boolean,
"p": String,
"s": String,
"r": Boolean,
"t": {
"limit": {
"tif": "Alo" | "Ioc" | "Gtc"
} or
"trigger": {
"isMarket": Boolean,
"triggerPx": String,
"tpsl": "tp" | "sl"
}
},
"c": Cloid (optional)
}]
} Meaning of keys: a is asset b is isBuy p is price s is size r is reduceOnly t is type c is cloid (client order id)
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its Onchain address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Update leverage
POST https://api.hyperliquid.xyz/exchange
Update cross or isolated leverage on a coin.
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "updateLeverage",
"asset": index of coin,
"isCross": true or false if updating cross-leverage,
"leverage": integer representing new leverage, subject to leverage constraints on that coin
}
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its Onchain address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Update isolated margin
POST https://api.hyperliquid.xyz/exchange
Add or remove margin from isolated position
Note that to target a specific leverage instead of a USDC value of margin change, there is an alternate action {"type": "topUpIsolatedOnlyMargin", "asset": <asset>, "leverage": <float string>}
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "updateIsolatedMargin",
"asset": index of coin,
"isBuy": true, (this parameter won't have any effect until hedge mode is introduced)
"ntli": float representing amount to add or remove,
}
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its Onchain address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
L1 USDC transfer
POST https://api.hyperliquid.xyz/exchange
Send usd to another address. This transfer does not touch the EVM bridge. The signature format is human readable for wallet interfaces.
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "usdSend",
"hyperliquidChain": "Mainnet" (on testnet use "Testnet" instead), "signatureChainId": the id of the chain used when signing in hexadecimal format; e.g. "0xa4b1" for Arbitrum,
"destination": address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000,
"amount": amount of usd to send as a string, e.g. "1" for 1 usd,
"time": current timestamp in milliseconds as a Number, should match nonce
}
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
L1 spot transfer
POST https://api.hyperliquid.xyz/exchange
Send spot assets to another address. This transfer does not touch the EVM bridge. The signature format is human readable for wallet interfaces.
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "spotSend",
"hyperliquidChain": "Mainnet" (on testnet use "Testnet" instead), "signatureChainId": the id of the chain used when signing in hexadecimal format; e.g. "0xa4b1" for Arbitrum,
"destination": address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000, "token": tokenName:tokenId, e.g. "PURR:0xc4bf3f870c0e9465323c0b6ed28096c2"
"amount": amount of token to send as a string, e.g. "0.01",
"time": current timestamp in milliseconds as a Number, should match nonce
}
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
Initiate a Withdrawal Request
POST https://api.hyperliquid.xyz/exchange
This method is used to initiate the withdrawal flow. After making this request, the L1 validators will sign and send the withdrawal request to the bridge contract. There is a $1 fee for withdrawing at the time of this writing and withdrawals take approximately 5 minutes to finalize.
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{ "type": "withdraw3",
"hyperliquidChain": "Mainnet" (on testnet use "Testnet" instead), "signatureChainId": the id of the chain used when signing in hexadecimal format; e.g. "0xa4b1" for Arbitrum,
"amount": amount of usd to send as a string, e.g. "1" for 1 usd,
"time": current timestamp in milliseconds as a Number, should match nonce,
"destination": address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
}
nonce*
Number
Recommended to use the current timestamp in milliseconds, must match the nonce in the action Object above
signature*
Object
Transfer from Spot account to Perp account (and vice versa)
POST https://api.hyperliquid.xyz/exchange
This method is used to transfer USDC from the user's spot wallet to perp wallet and vice versa.
Headers
Content-Type*
"application/json"
Body
action*
Object
{
"type": "usdClassTransfer",
"hyperliquidChain": "Mainnet" (on testnet use "Testnet" instead), "signatureChainId": the id of the chain used when signing in hexadecimal format; e.g. "0xa4b1" for Arbitrum,
"amount": amount of usd to tranfer as a string, e.g. "1" for 1 usd. If you want to use this action for a subaccount, you can include subaccount: address after the amount, e.g. "1 subaccount:0x0000000000000000000000000000000000000000,
"toPerp": True if (spot -> perp) else False,
"nonce": current timestamp in milliseconds as a Number, must match nonce in outer request body
}
nonce*
Number
Recommended to use the current timestamp in milliseconds, must match the nonce in the action Object above
signature*
Object
Response
Deposit or Withdraw from a Vault
POST https://api.hyperliquid.xyz/exchange
Add or remove funds from a vault.
Headers
Content-Type*
application/json
Body
action*
Object
{
"type": "vaultTransfer",
"vaultAddress": address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000, "isDeposit": boolean,
"usd": number
}
nonce*
number
Recommended to use the current timestamp in milliseconds
signature*
Object
Response
Approve an API Wallet
POST https://api.hyperliquid.xyz/exchange
Approves an API Wallet (also sometimes referred to as an Agent Wallet). See here for more details.
Headers
Content-Type*
application/json
Body
action*
Object
{ "type": "approveAgent",
"hyperliquidChain": "Mainnet" (on testnet use "Testnet" instead), "signatureChainId": the id of the chain used when signing in hexadecimal format; e.g. "0xa4b1" for Arbitrum,
"agentAddress": address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000,
"agentName": Optional name for the API wallet. An account can have 1 unnamed approved wallet and up to 3 named ones. And additional 2 named agents are allowed per subaccount,
"nonce": current timestamp in milliseconds as a Number, must match nonce in outer request body
}
nonce*
number
Recommended to use the current timestamp in milliseconds
signature*
Object
Response
Approve a Builder Fee
POST https://api.hyperliquid.xyz/exchange
Approve a maximum fee rate for a builder.
Headers
Content-Type*
application/json
Body
action*
Object
{ "type": "approveBuilderFee",
"hyperliquidChain": "Mainnet" (on testnet use "Testnet" instead), "signatureChainId": the id of the chain used when signing in hexadecimal format; e.g. "0xa4b1" for Arbitrum,
"maxFeeRate": the maximum allowed builder fee rate as a percent string; e.g. "0.001%",
"builder": address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000,
"nonce": current timestamp in milliseconds as a Number, must match nonce in outer request body
}
nonce*
number
Recommended to use the current timestamp in milliseconds
signature*
Object
Response
Place a TWAP order
POST https://api.hyperliquid.xyz/exchange
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "twapOrder", "twap": {
"a": Number,
"b": Boolean,
"s": String,
"r": Boolean,
"m": Number,
"t": Boolean
}
} Meaning of keys: a is asset b is isBuy s is size r is reduceOnly
m is minutes t is randomize
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its Onchain address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Cancel a TWAP order
POST https://api.hyperliquid.xyz/exchange
Headers
Content-Type*
String
"application/json"
Request Body
action*
Object
{
"type": "twapCancel",
"a": Number,
"t": Number
} Meaning of keys: a is asset t is twap_id
nonce*
Number
Recommended to use the current timestamp in milliseconds
signature*
Object
vaultAddress
String
If trading on behalf of a vault, its address in 42-character hexadecimal format; e.g. 0x0000000000000000000000000000000000000000
Last updated