Skip to main content
POST
Cancel working orders on an account

Authorizations

X-API-Key
string
header
required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Path Parameters

accountId
string
required

Trading account ID

Body

application/json
reason
string
required

Why the orders are being cancelled. Recorded on each cancelled order and on the account's event log.

Required string length: 3 - 200
Example:

"Risk review"

contract
string

Only cancel orders on this contract. Omit to cancel on every contract.

Pattern: ^[A-Za-z0-9._-]{1,40}$
Example:

"MNQZ6"

includeExits
boolean
default:false

Also cancel the take-profit and stop-loss orders of open positions, leaving them unprotected. Default false: they stay.

Example:

false

Response

Orders cancelled; positions untouched

success
boolean
Example:

true

data
object