Skip to main content
POST
/
v1
/
orders
curl --request POST \ --url https://api.aries.com/v1/orders \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "accountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "MARKET", "qty": "10", "timeInForce": "DAY" } '
{
  "success": true,
  "clOrdId": "ORDER-123456",
  "status": "NEW",
  "symbol": "AAPL",
  "side": "BUY",
  "qty": "10",
  "cumQty": "0",
  "leavesQty": "10",
  "avgPrice": "0",
  "text": "<string>",
  "ordRejReason": "<string>",
  "transactTime": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Order payload: accountId, symbol, side, type, qty, timeInForce; optional price/legs for limit and options.

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"

side
enum<string>
required

Order side

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

"BUY"

type
enum<string>
required

Order type

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

"LIMIT"

qty
string
required

Order quantity (decimal string)

Example:

"10"

timeInForce
enum<string>
required

Time in force

Available options:
DAY,
GTC,
IOC,
FOK,
EXTENDED_HOURS,
AT_THE_OPENING,
AT_THE_CLOSE
Example:

"DAY"

clientId
string

Optional client identifier

Maximum string length: 50
Example:

"CLIENT-001"

price
string

Limit price (required for LIMIT and STOP_LIMIT orders)

Example:

"150.00"

stopPrice
string

Stop price (required for STOP and STOP_LIMIT orders)

Example:

"145.00"

currency
string

Currency code (3 characters)

Required string length: 3
Example:

"USD"

legs
object[]

Option legs array. Order type is derived from this:

  • Empty/omitted = Equity order
  • 1 leg = Single-leg option
  • 2-4 legs = Multi-leg option
Maximum array length: 4

Response

Order placed successfully

success
boolean

Whether the order was accepted

Example:

true

clOrdId
string

Client order ID

Example:

"ORDER-123456"

status
string

Order status

Example:

"NEW"

symbol
string

Trading symbol

Example:

"AAPL"

side
string

Order side

Example:

"BUY"

qty
string

Order quantity

Example:

"10"

cumQty
string

Cumulative filled quantity

Example:

"0"

leavesQty
string

Remaining quantity

Example:

"10"

avgPrice
string

Average fill price

Example:

"0"

text
string

Additional text/message

ordRejReason
string

Order rejection reason (if rejected)

transactTime
string<date-time>

Transaction timestamp