Skip to main content
POST
Create an arbitrage order

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
hedge
CreateArbitrageOrderLeg · object
required

The hedging leg, placed once the primary leg fills. Fires immediately alongside the primary when both legs are market orders.

​
primary
CreateArbitrageOrderLeg · object
required

The leg placed first. Its fill triggers the hedge leg.

​
hedgeFailurePolicy
enum<string>

What happens when the hedge leg fails after the primary filled. Only alertAndHold — leave the naked leg and mark the order failed — is supported today.

Available options:
alertAndHold
​
partialFillPolicy
enum<string>

When a partially filled primary leg gets hedged. Only fullFill — hedge after the primary leg fills completely — is supported today.

Available options:
fullFill

Response

​
createdAt
string<date-time>
required

When the order was accepted.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
​
finishedAt
string<date-time> | null
required

When the order reached a terminal state. For fully hedged orders this is the moment both legs opened, so it doubles as the position start time.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
​
hedgeFailurePolicy
enum<string>
required

What happens when the hedge leg fails after the primary filled. alertAndHold — the naked leg is left in place and the order is marked failed. autoUnwind — the primary leg is closed with a market order.

Available options:
alertAndHold,
autoUnwind
Example:

"alertAndHold"

​
id
string<uuid>
required

Arbitrage order identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"019d5cbe-6980-7193-a80e-38a45eda36d8"

​
partialFillPolicy
enum<string>
required

When a partially filled primary leg gets hedged. fullFill — only after the primary leg fills completely. immediate — every fill is hedged as it arrives. threshold — hedged once unhedged size crosses a threshold.

Available options:
fullFill,
immediate,
threshold
Example:

"fullFill"

​
status
enum<string>
required

new — accepted, nothing on the exchange yet. primary_sent — the primary limit was sent to the exchange. primary_placed — the primary limit rests in the book. primary_partially_filled — the primary limit is partially filled. primary_full_filled — the primary is done, the hedge leg is being placed. hedge_sent — the hedge order was sent to the exchange. hedge_placed — the hedge order rests on the exchange. hedge_partially_filled — the hedge order is partially filled. hedge_full_filled — the hedge is fully filled, both legs are open and the order is finalized. canceled — canceled before any fill. failed — needs manual handling; the legs may be directionally exposed.

Available options:
canceled,
failed,
hedge_full_filled,
hedge_partially_filled,
hedge_placed,
hedge_sent,
new,
primary_full_filled,
primary_partially_filled,
primary_placed,
primary_sent
Example:

"primary_placed"

​
strategy
enum<string>
required

Leg types in execution order. marketMarket — both legs fire immediately. limitMarket — primary limit rests, hedge hedges with a market order once it fills. limitLimit — both legs are limit orders.

Available options:
limitLimit,
limitMarket,
marketMarket
Example:

"limitMarket"

​
unifiedSymbol
string
required

Cross-exchange asset key — an alias (alias:1000bonk) when defined, otherwise the base symbol.

Example:

"ETH"

​
updatedAt
string<date-time>
required

When the order last changed.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
​
legs
ArbitrageOrderLegs · object