Cancel a paper order
Cancels a resting paper order and returns its hold. Kalshi's path and answer (the order and reducedBy). Query execution=kalshi cancels a live Kalshi order instead (scope trade:write:kalshi) and does not touch the paper book. Query execution=poly-intl cancels a Polymarket International order (scope trade:write:poly-intl). Polymarket US is not offered. Send X-Arena-Org to cancel a paper order on that organization's paper sandbox; without the header the paper cancel is on the personal account. An unknown or forbidden organization cancels nothing. An order that already filled or closed answers unchanged with reducedBy 0, so a paper cancel is safe to send twice. No ticker, title or price in the paper answer while the venue-data switch is off.
Request
- Base URL: https://arena-predictions.com/api/v1
- URL: https://arena-predictions.com/api/v1/portfolio/orders/{orderId}
- Auth: one of:
- HTTP bearer
- HTTP bearer
- HTTP bearer
Path parameters
The order's id (orderId in GET /portfolio).
Headers
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.
Response
The order, and how many contracts came off the book.
Changes
No recorded changes to this operation across all 1 revision of this API.