Skip to main content
GET
Get a hedge request

Authorizations

Authorization
string
header
required

A workspace API key (mk_…), made under Settings → Administration → API.

Path Parameters

id
string
required

Mercora's id for the hedge, from the POST response.

Response

The hedge request.

id
string
required

Mercora's id for the hedge: GET /hedge-requests/{id}.

external_id
string
required

The caller's own id it was sent with.

state
enum<string>
required

processing: being planned · awaiting_approval: planned, waiting for an operator to send, accumulate or dismiss it · accumulated: parked to go out with a later hedge on the same month · merged: folded into another hedge's order · sending: the broker order is going out · awaiting_fill: order sent, waiting for the broker's fill · filled: fill recorded · closed: closed without a recorded fill · dismissed: an operator dismissed it · failed: could not be planned or sent; reason says why

Available options:
processing,
awaiting_approval,
accumulated,
merged,
sending,
awaiting_fill,
filled,
closed,
dismissed,
failed
reason
string | null
required

Why it failed, when state is failed.

plan
object | null
required

The order Mercora planned. Null while processing and when planning failed.

fill
object | null
required

The broker's fill, once recorded.

futures_trade_id
string | null
required

The executed trade in Mercora's futures ledger, once filled.

agiboo
object | null
required

Only for a workspace that books hedges in Agiboo; null when the hedge names no Agiboo position.

created_at
string
required

ISO 8601 timestamp.

url
string
required

The hedge in the Mercora Inbox.