Skip to main content
POST
Place Phoenix order

Authorizations

Authorization
string
header
required

API key issued by a Hedgin administrator, in the form hv1_<id>_<secret>. <id> is 1 to 48 characters and <secret> is 32 to 128 characters, both from [A-Za-z0-9_-].

Body

application/json
vault
string
required

Vault the transaction acts on.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
Example:

"So11111111111111111111111111111111111111112"

symbol
string
required

Market symbol from GET /vaults/{vault}/phoenix.

Required string length: 1 - 32
side
enum<string>
required
Available options:
long,
short
size
string
required

Whole asset units, such as "0.5". Not base units.

Pattern: ^\d{1,15}(\.\d{1,12})?$
Example:

"0.5"

reduceOnly
boolean
required
order
Market · object
required

Response

Build result. One step.

vault
string
required

Base58 Solana public key. The server decodes it and rejects anything that is not 32 bytes.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
Example:

"So11111111111111111111111111111111111111112"

result
object
required

One unsigned transaction and its ticket. Builders can add action metadata fields next to these.