API Version 1.0 (Stable)

Market Data API

Access high-fidelity market data through our REST endpoints and ultra-low latency WebSocket streams.

REST Base URL
https://ws.brokeredge.co/v1
WebSocket URL
wss://ws.brokeredge.co/v1/ws

Authentication

All requests require a valid JWT access token. Secure your connection by passing the token in the Authorization header for REST calls or via an auth frame for WebSockets.

POST/auth/login
Header Example
Authorization: Bearer <your_jwt_token>
GET

Instruments List

/instruments

Retrieve a comprehensive list of all tradable instruments. Use query parameters to filter by exchange or paginate through large datasets.

ParamTypeDescription
exchangestringFilter by segment (NSE, BSE, NFO)
pageintegerDefaults to 1
Response Schema
{
  "status": "success",
  "data": {
    "instruments": [
      {
        "instrument_token": "249406980",
        "tradingsymbol": "RELIANCE",
        "name": "RELIANCE INDUSTRIES",
        "exchange": "NSE"
      },
      ...
    ],
    "pagination": { "total": 1240, "page": 1 }
  }
}
GET

Instrument Details

/instruments/{instrument_token}

Fetch specific metadata for a single instrument. Essential for retrieving tick sizes, lot sizes, and contract expiry dates before placing orders.

GET .../instruments/249406980
{
  "status": "success",
  "data": {
    "instrument_token": "249406980",
    "tradingsymbol": "RELIANCE",
    "tick_size": 0.05,
    "lot_size": 1,
    "expiry": "2026-02-26",
    "instrument_type": "EQ"
  }
}

WebSocket Streaming

Connection Lifecycle

1

Establish WSS connection to /v1/ws

2

Send an auth frame with your JWT within 5 seconds.

3

Send a subscribe action to start receiving ticks.

Client Message Example
// 1. Authenticate
socket.send(JSON.stringify({
  "type": "auth",
  "access_token": "JWT_HERE"
}));

// 2. Subscribe
socket.send(JSON.stringify({
  "action": "subscribe",
  "instrument_token": "249406980",
  "mode": "full"
}));