Skip to main content
POST
Execute a perps action

Authorizations

Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json

Request body for POST /actions.

providerId
string
required
Example:

"hyperliquid"

address
string
required
Example:

"0x1234567890abcdef1234567890abcdef12345678"

action
enum<string>
required

Action to execute. Portal validates this against the fixed set below and rejects other values with a 400; new action types require Portal support. This is separate from venue and per-action args discovery via GET /providers, which is provider-driven — a new venue reusing these actions needs no change.

Available options:
open,
close,
updateLeverage,
stopLoss,
takeProfit,
cancelOrder,
editOrder,
fund,
withdraw,
approveAgent,
approveBuilderFee,
updateMargin,
setTpAndSl,
setUnifiedAccount
Example:

"open"

args
object
required

Action arguments. Documented fields are typed; unknown keys pass through to the venue untouched (the venue's argumentSchemas from GET /providers/{providerId} is the source of truth for which args an action requires). network values here are venue slugs or CAIP-2 chains.

Response

Action created with unsigned transactions ready for signing

data
object
required

An action with its unsigned transactions and status. signedMetadata is opaque passthrough (returned untouched) for client-side verification.