Skip to main content
POST

Authorizations

Authorization
string
header
required

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

FlowAuthorization Code
Authorization URL
https://app.aries.com/oauth2/authorize
Token URL
https://api.aries.com/v1/oauth2/token
Refresh URL
https://api.aries.com/v1/oauth2/token
FlowClient Credentials
Token URL
https://api.aries.com/v1/oauth2/token
Refresh URL
https://api.aries.com/v1/oauth2/token
Scopes1
order:execution
Place, modify, and cancel orders

Body

application/json

Which order to cancel. Required: origClOrdId (the ID returned when the order was placed), tradingAccountId, symbol. side is required; add securityType to disambiguate; for option cancels also include putCall, strikePrice, and maturity, or send an OSI option symbol in symbol and let the backend derive them.

Request body for canceling an open order through the core trading API. Use this when the user wants to stop an order that has not fully filled.

accountId
string
required

Account identifier; provide accountId or tradingAccountId. Both may be supplied.

Required string length: 1 - 50
origClOrdId
string
required

Client order ID of the original order you want to cancel. Use the clOrdId returned by Place Order or List active orders.

Required string length: 1 - 100
Example:

"ORDER-123456"

side
enum<string>
required

Which direction to trade in. Pick one:

  • BUY — buying shares or contracts (opens a long position or closes an existing short).
  • SELL — selling shares or contracts you already hold (closes a long position).
  • SELL_SHORT — selling shares you do not own (opens a short position). Subject to short-sale regulations.
  • BUY_TO_COVER — buying shares to close an open short position.
Available options:
BUY,
SELL,
SELL_SHORT,
BUY_TO_COVER
Example:

"BUY"

symbol
string
required

Symbol on the original order. Use the exact symbol from the order record.

Required string length: 1 - 21
Example:

"AAPL"

maturity
string<date>

Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-01-17"

putCall
enum<string>

Option contract type for option cancels. Use CALL for calls and PUT for puts. Omit for equity cancels.

Available options:
PUT,
CALL,
P,
C
Example:

"CALL"

securityType
enum<string>

What kind of instrument the order is for. Pick one:

  • CS — Common Stock (equity / ETF).
  • OPT — Option contract (call or put).
Available options:
CS,
OPT
Example:

"CS"

strikePrice
string

Option strike price as a decimal string. Send this for option cancels when the original order was an option order.

Example:

"150.00"

tradingAccountId
string

Trading account identifier that owns the order being canceled. It must match the account on the original order.

Required string length: 1 - 50
Example:

"TEST-ACCOUNT-001"

Response

Cancel request submitted successfully

Response returned after requesting an order cancel. Treat it as the cancel result and continue monitoring if the status is pending.

clOrdId
string

Client order ID associated with the cancel action. Store it for audit and status matching.

Example:

"ORDER-123456"

origClOrdId
string

Client order ID of the original order being canceled. Use it to connect this cancel result to the user's order.

Example:

"ORDER-123456"

status
enum<string>

Order status after the cancel request. Typical values after a successful cancel:

  • PENDING_CANCEL — cancel request accepted by the broker but not yet final. Keep monitoring; will move to CANCELED once confirmed.
  • CANCELED — order is fully cancelled; no further fills will occur.
  • REJECTED — the cancel was refused (e.g. the order had already fully filled). The original order is unchanged.

The full FIX OrdStatus enum is supported — see the Place Order response for the complete list of possible values.

Available options:
NEW,
PARTIALLY_FILLED,
FILLED,
DONE_FOR_DAY,
CANCELED,
REPLACED,
PENDING_CANCEL,
STOPPED,
REJECTED,
SUSPENDED,
PENDING_NEW,
CALCULATED,
EXPIRED,
ACCEPTED_FOR_BID,
PENDING_REPLACE,
SUPERSEDED
Example:

"CANCELED"

success
boolean

Whether Aries or the broker accepted the cancel request for processing.

Example:

true

text
string

Broker or platform message about the cancel result. Show it when the cancel is rejected or needs explanation.