WebSocket Streaming¶

Our WebSocket API provides a fast, efficient, and low-latency way to receive real-time data, including market quotes and order status updates. This is the preferred method for streaming high-frequency data.

We offer two distinct WebSocket endpoints for different types of real-time data:

• Price Feed WebSocket - For live market data including LTP (Last Traded Price) and real-time quotes
• Order Updates WebSocket - For real-time updates on your order statuses and trade confirmations

Authentication for both endpoints is handled via an Authorization header passed during the initial connection handshake.

Authorization: YOUR_ACCESS_TOKEN

Price Feed¶

Use this endpoint to stream live market data for instruments.

Endpoint: wss://ws-prices.indstocks.com/api/v1/ws/prices

Subscription

Once connected, you send JSON messages to subscribe to or unsubscribe from instrument feeds.

Request Structure A subscription message consists of an action, a mode, and an array of instruments.

Instrument Format Instrument tokens are strings that identify a specific security or index, formatted as SEGMENT:TOKEN.

Subscription Examples

• To subscribe to LTP mode for an instrument:

  JSON

  {
      "action":"subscribe",
      "mode": "ltp",
      "instruments": ["NSE:2885"]
  }
  

• To subscribe to Quote mode:

  JSON

  {
      "action":"subscribe",
      "mode": "quote",
      "instruments": ["NSE:2885"]
  }
  

Data Response

The data from the server will be a JSON string. You will need to parse this string to get the JSON object.

• LTP Response Format:
  JSON

  {
      "mode": "ltp",
      "instrument": "2885",
      "timestamp": 1750138351089,
      "data": {
          "ltp": 1426
      }
  }
  

Order Updates Feed¶

This endpoint streams all real-time updates for your orders.

Endpoint: wss://ws-order-updates.indstocks.com/api/v1/ws/trades

Subscription

To start receiving order updates, send a single subscription message after connecting.

• Subscription Message:
  JSON

  {
      "action": "subscribe",
      "mode": "order_update"
  }
  

  Once subscribed, all updates for your orders (e.g., placement, execution, cancellation) will be pushed to you automatically.

Order Update Response

Updates are published as a JSON-encoded string. Decode the frame to obtain the string, then decode that string to obtain the update object.

The example below is an execution update, which carries every field this feed sends. Updates earlier in the order's life carry a subset; the When sent column in the field table states which.

• Example frame:

  Text Only

  "{\"mode\":\"order_update\",\"timestamp\":1789628366550,\"data\":{\"order_id\":\"97603202\",\"entity_name\":\"SENSEX 17 SEP 74400 CE\",\"lot\":1,\"order_type\":\"BUY\",\"order_status\":\"S\",\"executed_price\":306.45,\"elapsed_time\":8,\"error_message\":\" \",\"timestamp\":1789628366544,\"req_quantity\":20,\"requested_lot\":1}}"
  

• The same frame, decoded:

  JSON

  {
    "mode": "order_update",
    "timestamp": 1789628366550,
    "data": {
      "order_id": "97603202",
      "entity_name": "SENSEX 17 SEP 74400 CE",
      "lot": 1,
      "order_type": "BUY",
      "order_status": "S",
      "executed_price": 306.45,
      "elapsed_time": 8,
      "error_message": " ",
      "timestamp": 1789628366544,
      "req_quantity": 20,
      "requested_lot": 1
    }
  }
  

Message envelope

data fields

data omits a field rather than sending it at its default value, so check that a field is present before reading it. elapsed_time and error_message are sent together.

order_status values

The order_status field carries a short code for the order's state at the moment the update was generated. This feed uses the short codes below; the long-form status names listed under Order Status Types are returned by the REST order endpoints.

Order lifecycle

An order publishes a sequence of updates as it progresses. A market order that fills moves through R → P → S:

{
  "mode": "order_update",
  "timestamp": 1789628366508,
  "data": {
    "order_id": "97603202",
    "entity_name": "SENSEX 17 SEP 74400 CE",
    "order_type": "BUY",
    "order_status": "R",
    "timestamp": 1789628366508,
    "req_quantity": 20,
    "requested_lot": 1
  }
}

{
  "mode": "order_update",
  "timestamp": 1789628366540,
  "data": {
    "order_id": "97603202",
    "entity_name": "SENSEX 17 SEP 74400 CE",
    "order_type": "BUY",
    "order_status": "P",
    "elapsed_time": 11,
    "error_message": " ",
    "timestamp": 1789628366537,
    "req_quantity": 20,
    "requested_lot": 1
  }
}

{
  "mode": "order_update",
  "timestamp": 1789628366550,
  "data": {
    "order_id": "97603202",
    "entity_name": "SENSEX 17 SEP 74400 CE",
    "lot": 1,
    "order_type": "BUY",
    "order_status": "S",
    "executed_price": 306.45,
    "elapsed_time": 8,
    "error_message": " ",
    "timestamp": 1789628366544,
    "req_quantity": 20,
    "requested_lot": 1
  }
}

See Also¶

• Market Quotes — REST alternative for on-demand (rather than streaming) quotes
• Orders — reconcile order state via Get Order Book instead of blindly retrying after a dropped connection
• Glossary & Constants — SEGMENT:TOKEN instrument format used only on WebSocket