Skip to main content

Symbol

Endpoint URL

This API Function fetches Quotes from the Broker

Local Host   :  POST http://127.0.0.1:5000/api/v1/symbol
Ngrok Domain : POST https://<your-ngrok-domain>.ngrok-free.app/api/v1/symbol
Custom Domain: POST https://<your-custom-domain>/api/v1/symbol

Sample API Request

{
"apikey": "<your_app_apikey>",
"symbol":"SBIN",
"exchange":"NSE"
}

Sample API Response

{
"data": {
"brexchange": "NSE",
"brsymbol": "ZOMATO-EQ",
"exchange": "NSE",
"expiry": "",
"id": 7162,
"instrumenttype": "",
"lotsize": 1,
"name": "ZOMATO",
"strike": -0.01,
"symbol": "ZOMATO",
"tick_size": 0.01,
"token": "5097"
},
"status": "success"
}

Request Fields

ParametersDescriptionMandatory/OptionalDefault Value
apikeyApp API keyMandatory-
symbolTrading symbolMandatory-
exchangeExchange codeMandatory-

Response Fields

FieldTypeDescription
brexchangeStringBroker exchange name
brsymbolStringBroker-specific symbol
exchangeStringExchange name (e.g., NSE, BSE)
expiryStringExpiry date (empty for equity instruments)
idIntegerUnique instrument identifier
instrumenttypeStringType of instrument (e.g., EQ, FUT, OPT)
lotsizeIntegerLot size (number of units per lot)
nameStringName of the instrument/company
strikeFloatStrike price (used in options, -0.01 here)
symbolStringTrading symbol
tick_sizeFloatMinimum price movement
tokenStringToken ID

Error Responses

  • 401 Unauthorized: Invalid/expired broker session or unauthorized.
  • 403 Forbidden: Invalid OpenAlgo API key or permission error.
  • 429 Too Many Requests: Rate limit exceeded (where detectable).
  • 500 Internal Server Error: Unclassified internal failure.

See also: HTTP Status Codes for detailed meanings.