Skip to navigation

Propose a manual execution

Drafts a trade the platform never received from a venue (risk:propose): a missed or off-platform fill, an opening position, a liquidation or ADL, a balancing trade. It books nothing until approved; once approved it is recorded as an execution of provenance MANUAL and applies to the position as any fill. Takes no If-Match. Answers 201 with the manual execution, PENDING_APPROVAL.

Authentication

AuthorizationBearer

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

Headers

Idempotency-KeystringRequired

Required on every write: a URL-safe string of 1 to 64 characters from [A-Za-z0-9._~-] (a UUID fits), scoped to you. It names one operation on one record, ever: a retry replays the stored outcome (Idempotent-Replay: true) or attaches to the live one, and reuse on another record refuses 409 IDEMPOTENCY_KEY_REUSED. Missing or malformed, 400.

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Request

This endpoint expects an object.
accountIdintegerRequired>=1
The account the trade is booked to.
instrumentIdstringRequiredformat: "^[1-9][0-9]*$"
The instrument traded, listed at the account's venue.
sideenumRequired
The account's side of the trade.
Allowed values:
qtystringRequiredformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (a decimal string): the quantity traded, positive, in the instrument’s own unit.

pricestringRequiredformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (a decimal string): the price traded at, positive.

venueTsNsstringRequiredformat: "^[1-9][0-9]*$"

When it traded at the venue or counterparty, epoch nanoseconds; not after the draft.

reasonenumRequired

Why. OTHER needs a remark.

referencestringRequired1-64 characters

The venue’s trade id, or the counterparty’s or desk’s reference: printable US-ASCII, 1 to 64 characters. The account must hold no execution of the instrument under it already (409 REFERENCE_TAKEN).

liquidityenum or nullOptional

Whether the account made or took liquidity; omit it when not known.

Allowed values:
feestring or nullOptionalformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (a decimal string): the fee charged, negative for a rebate; send it with feeAssetId, or neither — a zero fee is sent as neither: a fee of zero beside feeAssetId is refused INVALID_FIELD.

feeAssetIdinteger or nullOptional>=1

The asset the fee is in; send it with a non-zero fee, or neither.

remarkstringOptional<=256 characters

What the trade books, for its approvers; US-ASCII, at most 256 bytes.

Response

The manual execution exists, PENDING_APPROVAL — with the answering change’s position, its ETag and, on a replayed key, Idempotent-Replay.

manualExecutionIdstringformat: "^-?[0-9]+$"

The manual execution’s id, a 64-bit integer as decimal digits.

versionstringformat: "^-?[0-9]+$"

Its version as a decimal string: 1 when drafted, one more for each approval and for the withdrawal; its ETag.

accountIdinteger

The account the trade is booked to (GET /accounts).

instrumentIdstringformat: "^-?[0-9]+$"

The instrument traded, as POST /orders names it by instrumentId, listed at the account’s venue.

sideenum

The account’s side of the trade. The value set is append-only: read an unknown value as UNKNOWN.

Allowed values:
liquidityenum

Whether the account made or took liquidity, when known; UNKNOWN otherwise.

Allowed values:
qtystringformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (an exact decimal string at the scale it was drafted at): the quantity traded, in the instrument’s own unit (contracts for a swap).

pricestringformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (an exact decimal string at the scale it was drafted at): the price traded at.

feestring or nullformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (an exact decimal string at the scale it was drafted at): the fee charged in feeAssetId, negative for a rebate; null when none was drafted.

feeAssetIdinteger or null

The asset the fee is in; null when none was drafted.

venueTsNsstringformat: "^-?[0-9]+$"

When it traded at the venue or counterparty, epoch nanoseconds — the execution’s fillTsNs and venueTsNs.

reasonenum

Why it was booked by hand. The value set is append-only: read an unknown value as UNKNOWN.

referencestring

The venue’s trade id, or the counterparty’s or desk’s reference: the execution’s venueTradeId, which a reconciliation matches.

remarkstring
What it books, as its maker wrote it.
statusenum

PENDING_APPROVAL: drafted, booking nothing until approved. RECORDED: booked as the execution executionId names. WITHDRAWN: withdrawn, never booked. The value set is append-only: read an unknown value as UNKNOWN.

Allowed values:
proposedByobject

The maker — an actor, always a member’s: only members write risk.

proposedAtNsstringformat: "^-?[0-9]+$"
When it was drafted, epoch nanoseconds.
approvalslist of objects

Who approved it and when, in approval order; empty until the first approval. It is recorded when they number the organisation’s risk rule in force at that approval, and at least one (GET /approval-rules?family=RISK).

recordedAtNsstring or nullformat: "^-?[0-9]+$"

When it was recorded, epoch nanoseconds; null until then.

executionIdstring or nullformat: "^-?[0-9]+$"

The execution it was recorded as (GET /executions/{id}); null until then.

withdrawnByobject or null

Who withdrew it; null unless withdrawn.

updatedByobject

Who produced this version, never null: the maker on the draft, an approver on an approval, the withdrawer on the withdrawal.

withdrawalReasonstring

Why it was withdrawn; empty unless withdrawn.

globalSequencestringOptionalformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

Errors

400
Record Manual Execution Risk Request Bad Request Error
401
Record Manual Execution Risk Request Unauthorized Error
403
Record Manual Execution Risk Request Forbidden Error
409
Record Manual Execution Risk Request Conflict Error
413
Record Manual Execution Risk Request Content Too Large Error
422
Record Manual Execution Risk Request Unprocessable Entity Error
429
Record Manual Execution Risk Request Too Many Requests Error
500
Record Manual Execution Risk Request Internal Server Error
503
Record Manual Execution Risk Request Service Unavailable Error