Skip to main content
POST
/
v1
/
orders
/
replace
curl --request POST \ --url https://api.aries.com/v1/orders/replace \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "origClOrdId": "ORDER-123456", "accountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "20", "price": "150.00", "timeInForce": "DAY" } '
{
  "success": true,
  "clOrdId": "ORDER-123457",
  "origClOrdId": "ORDER-123456",
  "status": "REPLACED",
  "qty": "20",
  "price": "150.00",
  "text": "<string>",
  "transactTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
origClOrdId
string
required

Original client order ID to replace

Required string length: 1 - 100
Example:

"ORDER-123456"

​
accountId
string
required

Account identifier

Required string length: 1 - 50
Example:

"TEST-ACCOUNT-001"

​
symbol
string
required

Trading symbol

Required string length: 1 - 20
Example:

"AAPL"

​
clientId
string

New client identifier

Maximum string length: 50
​
side
enum<string>

Order side

Available options:
BUY,
SELL,
SELL_SHORT,
BUY_TO_COVER
Example:

"BUY"

​
type
enum<string>

Order type

Available options:
MARKET,
LIMIT,
STOP,
STOP_LIMIT
Example:

"LIMIT"

​
qty
string

New order quantity

Example:

"20"

​
price
string

New limit price

Example:

"148.50"

​
stopPrice
string

New stop price

Example:

"145.00"

​
timeInForce
enum<string>

Time in force

Available options:
DAY,
GTC,
IOC,
FOK
Example:

"DAY"

Response

Replace request submitted successfully

​
success
boolean

Whether the replace was accepted

Example:

true

​
clOrdId
string

New client order ID

Example:

"ORDER-123457"

​
origClOrdId
string

Original client order ID

Example:

"ORDER-123456"

​
status
string

Order status

Example:

"REPLACED"

​
qty
string

Order quantity

Example:

"20"

​
price
string

Order price

Example:

"150.00"

​
text
string

Additional text/message

​
transactTime
string<date-time>

Transaction timestamp