Place Order

POST 
/v1.1/order/create

Order status will change according to following sequence.

1. Send to OMS new
2. Pending new (for some exchanges)
3. Queued
4. Rejected
5. Partially Filled
6. Filled
7. Expire (depending on the TIF type of the order)

Supported Asset Classes

Equity

Request Body

  {
  "accountNumber": "P000128310",
  "securityType": "CS",
  "symbol": "AAPL",
  "exchange": "NSDQ",
  "quantity": 100,
  "orderType": "2",
  "orderSide": 1,
  "price": 2,
  "tif": 0,
 "tradingSession": "REG"
}

Field Name   accountNumber required securityType optional   symbol required   exchange required quantity optional   orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) tradingSession optional orderValue optional   amount N/A

Option

Fractional trading is not supported for option orders; therefore, option orders cannot be placed using order value.

Request Body

    {
    "accountNumber": "P000128310",
    "securityType": "OPT",
    "symbol": "AAPL\\23F30\\65.0",
    "exchange": "OPRA",
    "quantity": 100,
    "orderType": "2",
    "orderSide": 1,
    "price": 2,
    "tif": 0,
    }

Field Name   accountNumber required securityType required   symbol required   exchange required quantity optional orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) tradingSession N/A orderValue N/A amount N/A

Fixed Income

Request Body

  {
  "accountNumber": "P000284369",
  "securityType": "BND",
  "symbol": "ANF 8 ¾ 07/15/25",
  "exchange": "GTNFI",
  "amount": 2000,
  "orderType": "2",
  "orderSide": 1,
  "price": 50,
  "tif": 0,
  }

Field Name   accountNumber required securityType required   symbol required   exchange required quantity N/A orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) tradingSession N/A orderValue N/A   amount required

Request

application/json

Body

accountNumber string

Security account number of the customer.

symbol string

The symbol code of the symbol/ticker which need to be traded.

exchange string

Find exchange codes. Master Data > Get Exchange List

quantity number

Possible values: <= 10 characters

Quantity or Order Value is required. if quantity > 0, order will place using quantity not order value.

orderType string

For Order types - Master Data > Get Exchange Order Types

orderSide integer

Possible values: [1, 2]

1 (Buy) | 2 (Sell)

price number

Possible values: <= 16 characters

order price

tif integer

For Time in force. Master Data > Get Exchange Tif Types

tradingSession string

Default value: REG

For trading Sessions - Master data > Get Support Trading Sessions

orderValue number

Possible values: <= 16 characters

Quantity or Order Value is required. if quantity > 0, order will place using quantity not order value.

This is invest amount for fixed income.

securityType string

Possible values: [CS, OPT, BND]

Default value: CS

CS (Equity), OPT (Option), BND (Fixed Income)

expiryDate string

Possible values: Value must match regular expression YYYY/MM/DD

Expiry date will be recorded in Coordinated Universal Time (UTC)

amount number

order amount

Responses

200

OK

application/json

Schema

Schema

status stringrequired
reason stringrequired
orderReferenceId stringrequired
rejectCode string

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "orderReferenceId": "string",
  "rejectCode": "string"
}

example

{
  "status": "SUCCESS",
  "reason": "Order sent to OMS",
  "orderReferenceId": "a38d849845cf"
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status stringrequired
error stringrequired
message string
path string
rejectCode stringrequired

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/order/create",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/order/create",
  "rejectCode": "1007"
}

Loading...