Skip to main content
DELETE
Cancel a paper order

Authorizations

Authorization
string
header
required

Authorization: Bearer arena_sk_... (the x-arena-key header is accepted too). Keys are made in Settings (https://arena-predictions.com/settings#api-keys) or with arena keys create, shown once, stored hashed.

Headers

X-Arena-Org
string

Organization id. When present, this call uses that organization's paper sandbox. When absent, the key owner's personal paper account. A value that is not an organization id is 400 invalid_request. An unknown organization is 404 organization_not_found and one this key cannot use is 403 organization_forbidden. The personal account is never the fallback. Paper only. This header does not select a Combine evaluation account.

Maximum string length: 63

Path Parameters

orderId
string<uuid>
required

The order's id (orderId in GET /portfolio).

Response

The order, and how many contracts came off the book.

order
object
required
reducedBy
integer
required

Contracts taken off the book. 0 when the order had already filled or closed.

Required range: x >= 0
mode
string
required
Allowed value: "paper"
venueData
boolean
required
organization
object

Present when X-Arena-Org selected an organization sandbox. Absent on the personal account.