Skip to main content
GET
Python (SDK)
This endpoint is in closed beta. It is available only to accounts enrolled in the beta. Request and response shapes may change before general availability.

Overview

Place Prediction Order returns before the venue answers. Use the returned orderId and its accountId here to see what happened. data.order is the order’s current state, data.reports lists its fills, and data.events is every step that got it there. All three are read from one snapshot, so they agree. accountId is required. Orders belong to the account: any user acting on it can read every order on it, and placedBy says who placed each.

Reading the order

Optional decimals and timestamps are omitted when absent, never sent as zero. Every decimal is an exact value serialized as a JSON string.

Contract

Every order carries contract, read from the event catalogue, so you can show an order without looking its symbol up: contract is null when the catalogue does not have the contract, or cannot be read at that moment. The order is returned either way.

Execution reports

Each entry in data.reports is one venue report. For a fill, lastQty and lastPx give the quantity and price of that fill. bustedAt is set if the venue later cancelled the trade.

History

data.events has one entry per change to the order, in version order. kind says what happened: A cancel the venue made for a mass cancel carries the request’s massCancelId. An event with applied false is a venue report the order recorded without changing, for example a fill reported after the order was already closed.

Example

Errors

Authorizations

Authorization
string
header
required

OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.

Path Parameters

orderId
string<uuid>
required

orderId returned by Place Prediction Order or List Prediction Orders.

Query Parameters

accountId
string
required

The account the order is on.

Response

The order and its reports.

Standard success envelope used by all success responses. data is endpoint-specific.

success
boolean
required
Example:

true

data
object

An order and every venue report against it, read from one snapshot.