Skip to main content
POST
Mass cancel prediction orders
This endpoint is in closed beta. It is available only to accounts enrolled in the beta, and only on staging (https://api.tradearies.dev). Request and response shapes may change before general availability.

Overview

A mass cancel is one request to the venue. The endpoint returns 202 Accepted with the request, normally in status pending. A 202 does not mean any order is canceled. The venue then does two things:
  • It answers the request. The request’s status becomes accepted or rejected, with rejectReason and rejectText when refused. Read it with Get Prediction Mass Cancel.
  • It cancels each matching order separately. Each one arrives as an ordinary order update with state canceled, on the order stream and in List Prediction Orders. The order’s canceled event carries the request’s massCancelId.
Orders that fill before the venue reaches them are not canceled.

Request

Response

status is one of:

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.

Body

application/json

Unknown fields are rejected with 400.

accountId
string
required

The account whose working orders to cancel.

Example:

"ACCOUNT-0001"

outcome
enum<string>

Cancel only this outcome's orders. Requires symbol.

Available options:
YES,
NO
symbol
string

Cancel only orders in this contract. Omit to cancel every working order on the account.

Example:

"HORC_1126_Republican"

Response

Mass cancel sent. The venue has not answered yet.

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

success
boolean
required
Example:

true

data
object

A mass cancel request and whether the venue accepted it. It does not list the orders canceled: each arrives as an order update.