Place Order

POST 
/v1.2/order/create

Supported Order Types

Equity

Request Body

  {
  "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   info symbol required   info exchange required quantity optional   info orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) tradingSession optional orderValue optional   info externalOrderId optional

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 OPT symbol required   info 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 externalOrderId optional

Fixed Income

Request Body

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

Field Name   accountNumber required securityType BND   info symbol required   info 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 externalOrderId optional

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   info symbol required   info exchange required quantity N/A orderType N/A orderSide required price N/A tif N/A

Field Name   expiryDate N/A tradingSession N/A orderValue N/A externalOrderId optional amount required for buy or partially redeem orders isPartialRedemption required for redeem(sell) orders investmentId required for redeem(sell) orders

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   info symbol required   info exchange required quantity optional   info orderType required orderSide required

Field Name   price required selectively tif required expiryDate required selectively (GTD) tradingSession optional orderValue optional   info externalOrderId optional

Asset	security type	instrument type
equity	CS	0,60,61,86
option	OPT	10
fixed income	BND	75
mutual fund	FND	2

Request

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

Responses

200

OK

Order status will change according to following sequence.

	Order Status Reason
01	Send to OMS new
02	Pending new (for some exchanges)
03	Queued
04	Rejected
05	Partially Filled
06	Filled
07	Expire (depending on the TIF type of the order)

During market closure, only limit orders will be queued at GTN.

Quantity or orderValue is required(for equity/option type orders). if quantity > 0, order will place using quantity not orderValue.

Equity, Option and Spot orders can be placed using equity type security account.

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...