Skip to content

Orders

Trading API V3 New

This is the REST V3 trading track for the upgraded UAT rollout.

Use these pages when validating the newer V3 intent-order payload structure in the upgraded UAT environment.

Use these pages for Trading API V3 REST order workflows. Trading API V3 uses intent orders for single orders, grouped multi-order requests, and strategy orders.

Authenticated REST requests in this V3 track should include Authorization, x-device-id, x-app-version, x-device-os: sdk, and Cookie: deviceId=<device_id>.

This section is intentionally aligned to the Python SDK V3 trading flow, but each page uses REST request and response payloads instead of SDK code. Use it when you want to validate or integrate the raw Trading API V3 request shape directly.

Basic Usage

Use this section as the entry point when deciding which Trading API V3 REST workflow page to follow.

Main Endpoints

Workflow Endpoint
Place single order POST sentinel/orders/create
Place multi order POST sentinel/orders/create
Place strategy order POST sentinel/orders/create
Modify order POST sentinel/orders/modify
Modify multi order POST sentinel/orders/modify
Cancel order POST sentinel/orders/cancel
Get orders GET sentinel/orders
Get order margin POST sentinel/orders/funds_required

Page Map

Order ID Model

Trading API V3 uses intentOrderId as the order identifier for create responses, get-order retrieval, modify flows, cancel flows, and realtime updates.

For strategy orders:

  • one strategy returns one strategy-level intentOrderId
  • the same strategy response can also include legs[]
  • modify and cancel flows still use the strategy-level intentOrderId

Trading API V3 Field Groups

Group Common fields
Single order fields refId, qty, side, deliveryType, priceType, validityType, entryPrice
Entry control fields entryConfig, entryConfig.triggers, entryConfig.entryTime
Exit control fields exitConfig, stoplossParams, targetParams, exitTime
Strategy fields isMultiLeg, legs, legs[].refId, legs[].unitQty
Tracking fields stratTags, intentOrderId, timestamps, status

Major Areas To Review

  • Place Single Order: single-instrument payload families such as market, limit, AMO, trigger, iceberg, timed, and GTE
  • Place Multi Order: several independent single-order payloads in one request
  • Place Strategy Order: one multi-leg strategy payload with shared top-level quantity and per-leg multipliers
  • Modify Order: single-order and strategy-order modify payloads using the V3 orders[] wrapper
  • Get Order Margin: pre-placement funds and charges using the same payload shape as placement

Trading API V3 Enum Values

Field Typical values
side BUY, SELL
deliveryType IDAY, CNC
priceType LIMIT, MARKET
validityType DAY, IOC, GTE
executionMode ENTRY, ENTRY_AND_EXIT, EXIT

Important Rules

Important Rules

  • Trading API V3 order placement uses camel-case field names such as refId, deliveryType, entryPrice, and isMultiLeg.
  • Use isMultiLeg: false for single-instrument order items.
  • Use isMultiLeg: true with legs[] for one strategy order.
  • Multi-order placement groups independent single-order items; it does not create one leg-based strategy.
  • Strategy orders return one strategy-level intentOrderId.
  • Modify and cancel workflows use the same intentOrderId model for single orders, multi-order items, and strategy orders.
  • Review Rate Limits & API Usage before automating order placement.
NEO Assistant