Instruments
This guide explains how to download and use instrument data with the Groww API SDK.
Instruments
Instruments are the financial assets that can be traded on exchanges through the Groww API. These include stocks, futures, options, indices and other tradable securities. The Instruments API provides essential data about these trading instruments that you'll need for many operations in the Groww API. You can download the instruments csv file from here.
CSV Format
The full CSV file contains instrument details in the following format. Each individual column is explained below.
All prices in rupees.
Python SDK Usage
Example: You can directly use the get_instrument_by_groww_symbol method to get instrument details.
Output
Other ways to get instrument data are by trading_symbol
and exchange_token
.
You can also get all the instruments' data as a dataframe.
Output
Using CSV Data
Create a structured model from the CSV data and use it for various purposes in the SDK.
Python SDK Usage
Example: fetch live data or place an order.
Output
Instrument CSV Columns
The CSV contains the following columns (separated by commas):
Name | Type | Description |
---|---|---|
exchange | string | The Exchange where the instrument is traded |
exchange_token | string | The unique token assigned to the instrument by the exchange |
trading_symbol | string | The trading symbol of the instrument to place orders with |
groww_symbol | string | The symbol used by Groww to identify the instrument |
name | string | The name of the instrument |
instrument_type | string | The type of the instrument |
segment | string | Segment of the instrument such as CASH, FNO etc. |
series | string | The series of the instrument (e.g., EQ, A, B, etc.) |
isin | string | The ISIN (International Securities Identification number) (International Securities Identification Number) of the instrument |
underlying_symbol | string | The symbol of the underlying asset (for derivatives). Empty for stocks and indices |
underlying_exchange_token | string | The exchange token of the underlying asset |
lot_size | number | The minimum lot size for trading the instrument |
expiry_date | string | The expiry date of the instrument (for Derivatives) |
strike_price | number | The strike price of the instrument (for Options) |
tick_size | number | The minimum price movement for the instrument |
freeze_quantity | number | The quantity that is frozen for trading |
is_reserved | boolean | Whether the instrument is reserved for trading |
buy_allowed | boolean | Whether buying the instrument is allowed |
sell_allowed | boolean | Whether selling the instrument is allowed |
Advanced uses
You can also download the csv file and use it for your own purposes. Here is an example of how you can load the csv file and use it in your code.