Place Order

POST 
/v1.2/order/create

Supported Order Types

Equity

Request Body

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

Field Name   accountNumber required securityType optional   symbol required   exchange required quantity optional   orderType required orderSide required price required selectively tif required

Field Name   expiryDate required selectively (GTD) tradingSession optional orderValue optional   externalOrderId optional stopPrice Optional trailByValue Optional trailType Optional instrumentType optional (Possible values: 0,60,61,86)

Option

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

Request Body

    {
    "externalOrderId": "ext-ord-001",
    "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 OPT symbol required   exchange required quantity optional orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) externalOrderId optional stopPrice optional instrumentType optional (Possible values: 10)

Fixed Income

Request Body

{
 "externalOrderId": "ext-ord-001",
  "accountNumber": "P000284369",
  "securityType": "BND",
  "symbol": "ANF 8 ¾ 07/15/25",
  "exchange": "BOND",
  "amount": 2000,
  "orderType": "2",
  "orderSide": 1,
  "price": 50,
  "tif": 0,
  "expireTime": "2023/11/10"
  }

Field Name   accountNumber required securityType BND   symbol required   exchange required orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) amount required externalOrderId optional instrumentType optional (Possible values: 75)

Fund

Request Body

  {
  "externalOrderId": "ext-ord-003",
  "accountNumber": "P001133137",
  "symbol": "AFB007013406",
  "exchange": "MFSFUNDS",
  "orderSide": 2,
  "securityType": "FND",
  "amount": 5000,
  "isPartialRedemption": 0,
  "investmentId": "FO240313-2-000024"
  }

Field Name   accountNumber required securityType FND   symbol required   exchange required orderSide required

Field Name   externalOrderId optional amount required for buy or partially redeem orders isPartialRedemption required for redeem(sell) orders investmentId required for redeem(sell) orders instrumentType optional (Possible values: 2)

Spot

Request Body

{
"externalOrderId": "ext-ord-001",
"accountNumber": "P000128310",
"symbol": "XAU/USD",
"exchange": "GTNSPOT",
"quantity": 1,
"orderType": "2",
"orderSide": 1,
"price": 2,
"tif": 0,
"tradingSession": "REG",
"orderValue": 100,
"securityType": "CS",
"instrumentType": "60"
}

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   externalOrderId optional instrumentType optional (Possible values: 0,60,61,86)

Request

Header Parameters

Throttle-Key string

application/json

Body

externalOrderId string

Fintech order id

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

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

boundary value - 15 digits including decimals

orderType string

For Order types - Master Data > Get Exchange Order Types

orderSide integer

Possible values: [1, 2]

1 (Buy) | 2 (Sell)

price number

boundary value - 16 digits including decimals

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

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

This is invest amount for fixed income.

boundary value - 16 digits including decimals

securityType string

Possible values: [CS, OPT, BND, FND]

Default value: CS

CS(Equity), OPT(Option), BND(Fixed Income), FND(Mutual Fund)

expiryDate string

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

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

amount number

This Field is required when orderside value is 1 or when orderside value is 2 and isPartiallyRedemption value is 0.

isPartialRedemption number

Possible values: [0, 1]

0 (Partial Redemption) 1 (Fully Redemption)

investmentId string

This is required for orderside is 2 and security type is FND

instrumentType string
stopPrice number

only applicable for Trailing stop orders. only support in ASIA region for equity and option orders.

trailByValue number

only applicable for Trailing stop orders. only support in ASIA region for equity.

trailType string

Possible values: [TYPE:%, TYPE:$]

only applicable for Trailing stop orders. only support in ASIA region for equity.

Responses

200

OK

application/json

Schema

Schema

status stringrequired
reason stringrequired
orderReferenceId stringrequired

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "orderReferenceId": "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.2/order/create",
  "rejectCode": "1008"
}

Expired Token

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

Loading...