Groww Trade API

https://groww.in/trade-api/docs/
Admin
Groww Trade API provides developers with tools and SDKs (Python, cURL) to build and implement their...
Tokens:116,279
Snippets:585
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET Request Example with curl

Source: https://groww.in/trade-api/docs/curl

Shows how to make a GET request to the Groww API using curl. The request includes required headers: Accept, Authorization, and X-API-VERSION. The example uses the order detail endpoint with a groww_order_id and segment query parameter.

```bash
# You can also use wget
curl -X GET https://api.groww.in/v1/order/detail/{groww_order_id}?segment=CASH \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'X-API-VERSION: 1.0'
```

--------------------------------

### GET Request Response Example

Source: https://groww.in/trade-api/docs/curl

Example JSON response from a GET request. Shows the structure of the response with status and payload fields, including order details such as groww_order_id, order_status, quantity, price, and other order attributes.

```json
{
  "status": "SUCCESS",
  "payload": {
    "groww_order_id": "GMK39038RDT490CCVRO",
    "trading_symbol": "RELIANCE-EQ",
    "order_status": "OPEN",
    "remark": "Order placed successfully",
    "quantity": 100,
    "price": 2500,
    "trigger_price": 2450,
    "filled_quantity": 100,
    "remaining_quantity": 10,
    "average_fill_price": 2500,
    "deliverable_quantity": 10,
    "amo_status": "PENDING",
    "validity": "DAY",
    "exchange": "NSE",
    "order_type": "MARKET",
    "transaction_type": "BUY",
    "segment": "CASH",
    "product": "CNC",
    "created_at": "2023-10-01T10:15:30",
    "exchange_time": "2023-10-01T10:15:30",
    "trade_date": "2019-08-24T14:15:22Z",
    "order_reference_id": "Ab-654321234-1628190"
  }
}
```

--------------------------------

### Install pyotp for TOTP Flow

Source: https://groww.in/trade-api/docs/python-sdk

Install the pyotp library, required for the TOTP authentication flow.

```bash
pip install pyotp
```

--------------------------------

### Install growwapi Python SDK

Source: https://groww.in/trade-api/docs/python-sdk

Install the Groww Python SDK using pip. Requires Python 3.9+ and an active Trading API Subscription.

```bash
pip install growwapi
```

--------------------------------

### Response JSON for Get Order List

Source: https://groww.in/trade-api/docs/curl/orders

Example response showing a successful order list retrieval. Contains order details such as groww_order_id, order_status, quantity, price, and timestamps.

```json
{
  "status": "SUCCESS",
  "payload": {
    "order_list": [
      {
        "groww_order_id": "GMK39038RDT490CCVRO",
        "trading_symbol": "WIPRO",
        "order_status": "OPEN",
        "remark": "Order placed successfully",
        "quantity": 100,
        "price": 2500,
        "trigger_price": 2450,
        "filled_quantity": 100,
        "remaining_quantity": 10,
        "average_fill_price": 2500,
        "deliverable_quantity": 10,
        "amo_status": "PENDING",
        "validity": "DAY",
        "exchange": "NSE",
        "order_type": "MARKET",
        "transaction_type": "BUY",
        "segment": "CASH",
        "product": "CNC",
        "created_at": "2023-10-01T10:15:30",
        "exchange_time": "2023-10-01T10:15:30",
        "trade_date": "2019-08-24T14:15:22Z",
        "order_reference_id": "Ab-654321234-1628190"
      }
    ]
  }
}
```

--------------------------------

### FNO Backtesting Workflow: Get Expiries, Contracts, and Candles

Source: https://groww.in/trade-api/docs/curl/backtesting

Three-step workflow for FNO backtesting: first get available expiries, then get contracts for a specific expiry, then fetch historical candles for a specific contract. Each step requires an access token.

```bash
# Get NIFTY expiries for January 2024
curl -X GET 'https://api.groww.in/v1/historical/expiries?exchange=NSE&underlying_symbol=NIFTY&year=2024&month=1' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

```bash
# Get all NIFTY contracts for 4th January 2024 expiry
curl -X GET 'https://api.groww.in/v1/historical/contracts?exchange=NSE&underlying_symbol=NIFTY&expiry_date=2024-01-04' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

```bash
# Get historical candles for NIFTY 19200 CE option
curl -X GET 'https://api.groww.in/v1/historical/candles?exchange=NSE&segment=FNO&groww_symbol=NSE-NIFTY-04Jan24-19200-CE&start_time=2024-01-01 09:15:00&end_time=2024-01-10 15:30:00&candle_interval=15minute' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

--------------------------------

### POST Request Example with curl

Source: https://groww.in/trade-api/docs/curl

Shows how to make a POST request to the Groww API using curl. The request includes required headers and sends parameters as a JSON body in the -d flag. The example uses the order create endpoint with order details such as validity, exchange, transaction_type, order_type, price, product, quantity, segment, and trading_symbol.

```bash
    curl -X POST https://api.groww.in/v1/order/create \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'Authorization: Bearer {ACCESS_TOKEN}' \
      -H 'X-API-VERSION: 1.0' \
      -d '{
        "validity": "DAY",
        "exchange": "NSE",
        "transaction_type": "BUY",
        "order_type": "MARKET",
        "price": 0,
        "product": "CNC",
        "quantity": 1,
        "segment": "CASH",
        "trading_symbol": "IDEA"
    }'
```

--------------------------------

### Live Data Output Example

Source: https://groww.in/trade-api/docs/python-sdk/feed

Example JSON output from the feed, showing the structure with exchange, segment, and exchange token keys, containing timestamp and last traded price.

```json
{
  "ltp": {
    "NSE": {
      "CASH": {
        "2885": {
          "tsInMillis": 1746174479582.0,
          "ltp": 1419.1
        }
      },
      "FNO": {
        "35241": {
          "tsInMillis": 1746174479582.0,
          "ltp": 26111.10
        }
      }
    }
  }
}
```

--------------------------------

### Response JSON: order_list example

Source: https://groww.in/trade-api/docs/python-sdk/orders

Example JSON response from get_order_list, showing a single order object with fields like groww_order_id, trading_symbol, order_status, and prices in rupees.

```json
{
    "order_list": [
        {
            "groww_order_id": "GMK39038RDT490CCVRO",
            "trading_symbol": "WIPRO",
            "order_status": "OPEN",
            "remark": "Order placed successfully",
            "quantity": 100,
            "price": 250,
            "trigger_price": 245,
            "filled_quantity": 100,
            "remaining_quantity": 10,
            "average_fill_price": 250,
            "deliverable_quantity": 10,
            "amo_status": "PENDING",
            "validity": "DAY",
            "exchange": "NSE",
            "order_type": "MARKET",
            "transaction_type": "BUY",
            "segment": "CASH",
            "product": "CNC",
            "created_at": "2019-08-24T14:15:22Z",
            "exchange_time": "2019-08-24T14:15:22Z",
            "trade_date": "2019-08-24T14:15:22Z",
            "order_reference_id": "Ab-654321234-1628190"
        }
    ]
}
```

--------------------------------

### Output of live data fetch

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Shows the printed output from the previous example, displaying the latest price data as a JSON object with an 'ltp' key.

```json
# The latest price data for the selected instrument is printed
{"ltp" : 149.5}
```

--------------------------------

### Example output for get_instrument_by_exchange_and_trading_symbol

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Shows the printed output of the get_instrument_by_exchange_and_trading_symbol call for RELIANCE on NSE. The output is a dictionary with instrument details.

```text
# The instrument details are printed
Instrument: {'exchange': 'NSE', 'exchange_token': 2885, 'trading_symbol': 'RELIANCE', 
'groww_symbol': 'NSE-RELIANCE', 'name': 'Reliance Industries', 'instrument_type': 'EQ', 
'segment': 'CASH', 'series': 'EQ', 'isin': 'INE002A01018', 'underlying_symbol': nan, 
'underlying_exchange_token': nan, 'lot_size': 1, 'expiry_date': nan, 'strike_price': nan, 
'tick_size': 5, 'freeze_quantity': nan, 'is_reserved': 0, 'buy_allowed': 1, 'sell_allowed': 1}
```

--------------------------------

### Get Smart Order - Response (200)

Source: https://groww.in/trade-api/docs/curl/smart-orders

Example response for a successful fetch request. Returns status SUCCESS and payload containing the full smart order object (schema referenced separately).

```json
{
  "status": "SUCCESS",
  "payload": { /* Full smart order object: see schema below */ }
}
```

--------------------------------

### JSON response for available user margin

Source: https://groww.in/trade-api/docs/curl/margin

Example response from the GET /v1/margins/detail/user endpoint. All prices are in rupees. Contains fields like clear_cash, net_margin_used, and nested FnO and equity margin details.

```json
{
  "status": "SUCCESS",
  "payload": {
    "clear_cash": 5000,
    "net_margin_used": 35000,
    "brokerage_and_charges": 200,
    "collateral_used": 3000,
    "collateral_available": 7000,
    "adhoc_margin": 1500,
    "fno_margin_details": {
      "net_fno_margin_used": 15000,
      "span_margin_used": 7000,
      "exposure_margin_used": 4000,
      "future_balance_available": 3000,
      "option_buy_balance_available": 11000,
      "option_sell_balance_available": 1000
    },
    "equity_margin_details": {
      "net_equity_margin_used": 10000,
      "cnc_margin_used": 5000,
      "mis_margin_used": 3000,
      "cnc_balance_available": 9000,
      "mis_balance_available": 1000
    }
  }
}
```

--------------------------------

### Place order response (JSON)

Source: https://groww.in/trade-api/docs/python-sdk/orders

Example response returned by the place_order method. Contains the groww_order_id, order_status, order_reference_id, and a remark indicating success.

```json
{
    "groww_order_id": "GMK39038RDT490CCVRO",
    "order_status": "OPEN",
    "order_reference_id": "Ab-654321234-1628190",
    "remark": "Order placed successfully"
}
```

--------------------------------

### Get all instruments as dataframe

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Fetches all instruments' data as a pandas dataframe. Requires a valid API auth token. The example prints the first few rows using head().

```python
from growwapi import GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
instruments_df = groww.get_all_instruments()
print(instruments_df.head())
```

--------------------------------

### Response JSON for user positions

Source: https://groww.in/trade-api/docs/curl/portfolio

Example response showing a successful position retrieval with fields like trading_symbol, quantity, and realised_pnl.

```json
{
  "status": "SUCCESS",
  "payload": {
    "positions": [
      {
        "trading_symbol": "RELIANCE",
        "credit_quantity": 10,
        "credit_price": 12500,
        "debit_quantity": 5,
        "debit_price": 12000,
        "carry_forward_credit_quantity": 8,
        "carry_forward_credit_price": 12300,
        "carry_forward_debit_quantity": 3,
        "carry_forward_debit_price": 11800,
        "exchange": "NSE",
        "symbol_isin": "INE123A01016",
        "quantity": 15,
        "product": "CNC",
        "net_carry_forward_quantity": 10,
        "net_price": 12400,
        "net_carry_forward_price": 12200,
        "realised_pnl": 500
      }
    ]
  }
}
```

--------------------------------

### Smart Order List Response Example

Source: https://groww.in/trade-api/docs/python-sdk/smart-orders

Example JSON response from the smart order list endpoint. Contains an orders array with smart order details such as smart_order_id, type, status, trading symbol, exchange, and quantity.

```json
{
  "orders": [
    {
      "smart_order_id": "gtt_91a7f4",
      "smart_order_type": "GTT",
      "status": "ACTIVE",
      "trading_symbol": "TCS",
      "exchange": "NSE",
      "quantity": 10
    }
  ]
}
```

--------------------------------

### OCO smart order response example

Source: https://groww.in/trade-api/docs/python-sdk/smart-orders

Example response from creating an OCO smart order. Shows the smart_order_id, status ACTIVE, and the target/stop_loss legs. If one leg executes, the other cancels automatically.

```json
{
  "smart_order_id": "oco_a12bc3",
  "smart_order_type": "OCO",
  "status": "ACTIVE",
  "trading_symbol": "NIFTY25OCT24000CE",
  "exchange": "NSE",
  "quantity": 50,
  "product_type": "NRML",
  "duration": "DAY",
  "target": {
    "trigger_price": "120.50",
    "order_type": "LIMIT",
    "price": "121.00"
  },
  "stop_loss": {
    "trigger_price": "95.00",
    "order_type": "SL_M",
    "price": null
  },
  "is_cancellation_allowed": true,
  "is_modification_allowed": true,
  "created_at": "2025-09-30T07:00:00",
  "expire_at": null,
  "triggered_at": null,
  "updated_at": "2025-09-30T07:00:00"
}
```

--------------------------------

### LTP response payload example

Source: https://groww.in/trade-api/docs/python-sdk/live-data

Example JSON response from get_ltp showing LTP values in rupees for each requested symbol.

```json
{
  "NSE_RELIANCE": 2500.5,
  "NSE_NIFTY": 22962.10
}
```

--------------------------------

### Response JSON: trade list example

Source: https://groww.in/trade-api/docs/python-sdk/orders

Example JSON response returned by the get_trade_list_for_order method. Contains a trade_list array with fields such as price, isin, quantity, groww_order_id, exchange_trade_id, trade_status, and more. All prices are in rupees.

```json
{
    "trade_list": [
      {
        "price": 250,
        "isin": "INE075A01022",
        "quantity": 1,
        "groww_order_id": "GMK39038RDT490CCVRO",
        "groww_trade_id": "",
        "exchange_trade_id": "202402120123456789",
        "exchange_order_id": "1100000057528630",
        "trade_status": "EXECUTED",
        "trading_symbol": "WIPRO",
        "remark": "Order placed successfully",
        "exchange": "NSE",
        "segment": "CASH",
        "product": "CNC",
        "transaction_type": "BUY",
        "created_at": "2019-08-24T14:15:22Z",
        "trade_date_time": "2019-08-24T14:15:22Z",
        "settlement_number": "2024052"
      }
    ]
  }
```

--------------------------------

### Market depth output example

Source: https://groww.in/trade-api/docs/python-sdk/feed

Example JSON response from feed.get_market_depth(). It shows the structure with exchange, segment, and exchange_token keys, each containing tsInMillis, buyBook, and sellBook. The buyBook and sellBook are dictionaries keyed by price level (1-5) with price and qty values.

```json
{
  "NSE": {
    "CASH": {
      "2885": {
        "tsInMillis": 1746156600.0,
        "buyBook": {
          "2": {
            "price": 1418.7,
            "qty": 23.0
          },
          "3": {
            "price": 1418.6,
            "qty": 206.0
          },
          "1": {
            "price": 1418.8,
            "qty": 113.0
          },
          "4": {
            "price": 1418.5,
            "qty": 774.0
          },
          "5": {
            "price": 1418.4,
            "qty": 1055.0
          }
        },
        "sellBook": {
          "2": {
            "price": 1419.0,
            "qty": 472.0
          },
          "3": {
            "price": 1419.3,
            "qty": 212.0
          },
          "1": {
            "price": 1418.9,
            "qty": 3.0
          },
          "4": {
            "price": 1419.4,
            "qty": 138.0
          },
          "5": {
            "price": 1419.5,
            "qty": 895.0
          }
        }
      }
    },
    "FNO": {
      "35241": {
        "tsInMillis": 1746156600.0,
        "buyBook": {
          "2": {
            "price": 1420.1,
            "qty": 30.0
          },
          "3": {
            "price": 1419.9,
            "qty": 190.0
          },
          "1": {
            "price": 1420.2,
            "qty": 120.0
          },
          "4": {
            "price": 1419.8,
            "qty": 800.0
          },
          "5": {
            "price": 1419.7,
            "qty": 1100.0
          }
        },
        "sellBook": {
          "2": {
            "price": 1420.5,
            "qty": 450.0
          },
          "3": {
            "price": 1420.8,
            "qty": 200.0
          },
          "1": {
            "price": 1420.4,
            "qty": 5.0
          },
          "4": {
            "price": 1421.0,
            "qty": 150.0
          },
          "5": {
            "price": 1421.2,
            "qty": 900.0
          }
        }
      }
    }
  }
}
```

--------------------------------

### Response: User Profile JSON

Source: https://groww.in/trade-api/docs/python-sdk/user

Example JSON response from the get_user_profile endpoint, showing vendor_user_id, ucc, exchange enablement flags, ddpi_enabled, and active_segments.

```json
{
  "vendor_user_id": "d86890d1-c60d-4ebd-9730-4feee5451670",
  "ucc": "924189",
  "nse_enabled": true,
  "bse_enabled": true,
  "ddpi_enabled": false,
  "active_segments": [
    "CASH",
    "FNO"
  ]
}
```

--------------------------------

### Python SDK: Get Expiries

Source: https://groww.in/trade-api/docs/python-sdk/backtesting

Initializes GrowwAPI and calls get_expiries with exchange, underlying_symbol, year, and month. Requires API_AUTH_TOKEN. Returns a list of expiry dates.

```python
from growwapi import GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
expiries_response = groww.get_expiries(
    exchange=groww.EXCHANGE_NSE,
    underlying_symbol="NIFTY",
    year=2024,
    month=1
)
print(expiries_response)
```

--------------------------------

### Response payload for get_positions_for_user

Source: https://groww.in/trade-api/docs/python-sdk/portfolio

Example JSON response showing the positions array with fields like trading_symbol, segment, credit_quantity, and realised_pnl. All prices are in rupees.

```json

"positions": [
  {
    "trading_symbol": "RELIANCE",
    "segment": "CASH",
    "credit_quantity": 10,
    "credit_price": 12500,
    "debit_quantity": 5,
    "debit_price": 12000,
    "carry_forward_credit_quantity": 8,
    "carry_forward_credit_price": 12300,
    "carry_forward_debit_quantity": 3,
    "carry_forward_debit_price": 11800,
    "exchange": "NSE",
    "symbol_isin": "INE123A01016",
    "quantity": 15,
    "product": "CNC",
    "net_carry_forward_quantity": 10,
    "net_price": 12400,
    "net_carry_forward_price": 12200,
    "realised_pnl": 500,
  }
]
```

--------------------------------

### Get Holdings Response Example

Source: https://groww.in/trade-api/docs/curl/portfolio

Example JSON response from the Get Holdings API, showing a successful request with a single holding.

```json
{
  "status": "SUCCESS",
  "payload": {
    "holdings": [
      {
        "isin": "INE545U01014",
        "trading_symbol": "RELIANCE",
        "quantity": 10,
        "average_price": 100,
        "pledge_quantity": 2,
        "demat_locked_quantity": 1,
        "groww_locked_quantity": 1.5,
        "repledge_quantity": 0.5,
        "t1_quantity": 3,
        "demat_free_quantity": 5,
        "corporate_action_additional_quantity": 1,
        "active_demat_transfer_quantity": 1
      }
    ]
  }
}
```

--------------------------------

### Fetch live data using GrowwAPI

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Initializes GrowwAPI with an auth token, selects an instrument by groww symbol, and fetches its latest price (LTP). Replace 'your_token' with actual credentials.

```python
import pandas as pd
from growwapi import GrowwAPI
# Initialize GrowwAPI and load instruments
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
# Select an instrument (example: Reliance Industries)
selected = groww.get_instrument_by_groww_symbol("NSE-RELIANCE")
 
# Fetch latest price data for the selected instrument
ltp_response = groww.get_ltp(
    exchange_trading_symbols="NSE_" + selected['trading_symbol'],
    segment=selected['segment'],
)
print("Live Data:", ltp_response)
```

--------------------------------

### Get Expiries API Response (JSON)

Source: https://groww.in/trade-api/docs/curl/backtesting

Example JSON response from the Get Expiries API. The payload contains an array of expiry dates in YYYY-MM-DD format.

```json
{
  "status": "SUCCESS",
  "payload": {
    "expiries" : [
      "2024-01-25",
      "2024-01-31",
      "2024-02-29",
      "2024-03-28"
    ]
  }
}
```

--------------------------------

### Place an order with place_order (Python)

Source: https://groww.in/trade-api/docs/python-sdk/orders

Initializes the GrowwAPI client with an API auth token and calls place_order with required and optional parameters. The response contains a groww_order_id and initial order status. Use the constants like VALIDITY_DAY, EXCHANGE_NSE, SEGMENT_CASH, PRODUCT_CNC, ORDER_TYPE_LIMIT, and TRANSACTION_TYPE_BUY. Optional parameters include price, trigger_price, and order_reference_id.

```python
from growwapi import GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
place_order_response = groww.place_order(
    trading_symbol="WIPRO",
    quantity=1, 
    validity=groww.VALIDITY_DAY,
    exchange=groww.EXCHANGE_NSE,
    segment=groww.SEGMENT_CASH,
    product=groww.PRODUCT_CNC,
    order_type=groww.ORDER_TYPE_LIMIT, # You can also use ORDER_TYPE_MARKET, ORDER_TYPE_STOP_LOSS, ORDER_TYPE_STOP_LOSS_MARKET for different order types
    transaction_type=groww.TRANSACTION_TYPE_BUY,
    price=250,               # Optional: Price of the stock (for Limit orders)
    trigger_price=245,       # Optional: Trigger price (if applicable)
    order_reference_id="Ab-654321234-1628190"  # Optional: User provided 8 to 20 length alphanumeric reference ID to track the order
)
print(place_order_response)
```

--------------------------------

### Python: get_instrument_by_groww_symbol example

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Initializes the Groww API with an auth token and fetches instrument details for a given groww symbol (e.g., NSE-RELIANCE). Replace the token with your actual credentials.

```python
from growwapi import GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
get_instrument_by_groww_symbol_response = groww.get_instrument_by_groww_symbol(
    groww_symbol="NSE-RELIANCE"
)
print(get_instrument_by_groww_symbol_response)
```

--------------------------------

### GET /v1/holdings/user

Source: https://groww.in/trade-api/docs/curl/portfolio

This code snippet documents the GET /v1/holdings/user endpoint, which retrieves the current stock holdings of the user from their DEMAT account. It includes the request headers, a curl example, and the response schema with all fields.

```APIDOC
## [GET] /v1/holdings/user

### Description
This API retrieves the current stock holdings of the user stored in the user's DEMAT account.

### Method
GET

### Endpoint
https://api.groww.in/v1/holdings/user

### Parameters
#### Headers
- **Accept** (string) - Required - Must be set to `application/json`.
- **Authorization** (string) - Required - Bearer token for authentication. Format: `Bearer {ACCESS_TOKEN}`.
- **X-API-VERSION** (string) - Required - API version. Must be set to `1.0`.

### Request Example
```
curl -X GET https://api.groww.in/v1/holdings/user \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

### Response
#### Success Response (200)
- **status** (string) - SUCCESS if request is processed successfully, FAILURE if the request failed.
- **payload** (object) - Contains the holdings array.
  - **holdings** (array) - List of holdings.
    - **isin** (string) - The ISIN (International Securities Identification number) of the symbol.
    - **trading_symbol** (string) - The trading symbol of the holding.
    - **quantity** (integer) - The net quantity of the holding.
    - **average_price** (decimal) - The average price of the holding in Rupees.
    - **pledge_quantity** (decimal) - The pledged quantity of the holding.
    - **demat_locked_quantity** (decimal) - The demat locked quantity of the holding.
    - **groww_locked_quantity** (decimal) - The Groww locked quantity of the holding.
    - **repledge_quantity** (decimal) - The repledged quantity of the holding.
    - **t1_quantity** (decimal) - The T1 quantity of the holding.
    - **demat_free_quantity** (decimal) - The demat free quantity of the holding.
    - **corporate_action_additional_quantity** (integer) - The corporate action additional quantity of the holding.
    - **active_demat_transfer_quantity** (integer) - The active demat transfer quantity of the holding.

#### Response Example
```
{
  "status": "SUCCESS",
  "payload": {
    "holdings": [
      {
        "isin": "INE545U01014",
        "trading_symbol": "RELIANCE",
        "quantity": 10,
        "average_price": 100,
        "pledge_quantity": 2,
        "demat_locked_quantity": 1,
        "groww_locked_quantity": 1.5,
        "repledge_quantity": 0.5,
        "t1_quantity": 3,
        "demat_free_quantity": 5,
        "corporate_action_additional_quantity": 1,
        "active_demat_transfer_quantity": 1
      }
    ]
  }
}
```
```

--------------------------------

### curl GET request for Get Quote API

Source: https://groww.in/trade-api/docs/curl/live-data

Use this curl command to fetch live data for an instrument. Replace {ACCESS_TOKEN} with your bearer token. The example uses exchange=NSE, segment=CASH, and trading_symbol=NIFTY. The Accept and X-API-VERSION headers are required.

```bash
curl -X GET https://api.groww.in/v1/live-data/quote?exchange=NSE&segment=CASH&trading_symbol=NIFTY \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

--------------------------------

### Sample JSON response from Get Quote API

Source: https://groww.in/trade-api/docs/curl/live-data

Example response payload showing the structure returned by the Get Quote endpoint. The status field is SUCCESS. All prices are in rupees. The depth object contains buy and sell book entries.

```json
{
  "status": "SUCCESS",
  "payload": {
    "average_price": 150.25,
    "bid_quantity": 1000,
    "bid_price": 150,
    "day_change": -0.5,
    "day_change_perc": -0.33,
    "upper_circuit_limit": 151,
    "lower_circuit_limit": 148.5,
    "ohlc": "{open: 149.50,high: 150.50,low: 148.50,close: 149.50}",
    "depth": {
      "buy": [
        {
          "price": 100.5,
          "quantity": 1000
        }
      ],
      "sell": [
        {
          "price": 100.5,
          "quantity": 1000
        }
      ]
    },
    "high_trade_range": 150.5,
    "implied_volatility": 0.25,
    "last_trade_quantity": 500,
    "last_trade_time": 1633072800000,
    "low_trade_range": 148.25,
    "last_price": 149.5,
    "market_cap": 5000000000,
    "offer_price": 150.5,
    "offer_quantity": 2000,
    "oi_day_change": 100,
    "oi_day_change_percentage": 0.5,
    "open_interest": 2000,
    "previous_open_interest": 1900,
    "total_buy_quantity": 5000,
    "total_sell_quantity": 4000,
    "volume": 10000,
    "week_52_high": 160,
    "week_52_low": 140
  }
}
```

--------------------------------

### Subscribe to Live Data for Equity and Derivatives

Source: https://groww.in/trade-api/docs/python-sdk/feed

Shows how to create a GrowwFeed client, subscribe to live LTP data for multiple instruments, receive data via callback or polling, and unsubscribe. Requires a valid API auth token and exchange tokens from instruments.csv. The consume() method is blocking.

```python
from growwapi import GrowwFeed, GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
groww = GrowwAPI(API_AUTH_TOKEN)
feed = GrowwFeed(groww)
 
def on_data_received(meta): # callback function which gets triggered when data is received
    print("Data received")
    print(feed.get_ltp())
 
# you can fetch exchange_token from instruments.csv file
instruments_list = [{"exchange": "NSE", "segment": "CASH", "exchange_token": "2885"}, {"exchange": "NSE", "segment": "FNO", "exchange_token": "35241"}]
 
feed.subscribe_ltp(instruments_list, on_data_received=on_data_received)
 
 # This is a blocking call. Nothing after this will run.
feed.consume()
 
# OR
 
# you can also fetch data synchronously
feed.subscribe_ltp(instruments_list)
 
# live data can also be continuously polled using this method
for i in range(10):
  time.sleep(3)
  print(feed.get_ltp())
 
feed.unsubscribe_ltp(instruments_list)
```

--------------------------------

### Get Order Status by groww_order_id - Response

Source: https://groww.in/trade-api/docs/curl/orders

Example JSON response for the order status endpoint. Shows a successful response with order details.

```json
{
  "status": "SUCCESS",
  "payload": {
    "groww_order_id": "GMK39038RDT490CCVRO",
    "order_status": "OPEN",
    "remark": "Order placed successfully",
    "filled_quantity": 100,
    "order_reference_id": "Ab-654321234-1628190"
  }
}
```

--------------------------------

### Example output for get_all_instruments

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Shows the first few rows of the dataframe returned by get_all_instruments(). The output is a tabular representation with columns like exchange, exchange_token, trading_symbol, groww_symbol, and more.

```text
  exchange exchange_token          trading_symbol                   groww_symbol  ... is_reserved buy_allowed sell_allowed internal_trading_symbol
0      NSE          35154      ASIANPAINT25FEBFUT       NSE-ASIANPAINT-Feb25-FUT  ...           0           1            1      ASIANPAINT25FEBFUT
1      NSE          35158          ABB25APR9600PE          NSE-ABB-Apr25-9600-PE  ...           1           1            1          ABB25APR9600PE
2      NSE          35044       NIFTY25MAR29050PE     NSE-NIFTY-27Mar25-29050-PE  ...           1           1            1       NIFTY25MAR29050PE
3      NSE          35093    FINNIFTY25MAR29600PE    NSE-FINNIFTY-Mar25-29600-PE  ...           1           1            1    FINNIFTY25MAR29600PE
4      NSE          35047  NIFTYNXT5025FEB56600CE  NSE-NIFTYNXT50-Feb25-56600-CE  ...           0           1            1  NIFTYNXT50Feb25-56600-CE
```

--------------------------------

### Response JSON for Get Trades for Order

Source: https://groww.in/trade-api/docs/curl/orders

Example response showing a successful trade list. The payload contains an array of trade objects with fields like price, quantity, groww_order_id, and trade_status.

```json
{
  "status": "SUCCESS",
  "payload": {
    "trade_list": [
      {
        "price": 0,
        "isin": "ISN378331005",
        "quantity": 100,
        "groww_order_id": "GROW123456",
        "groww_trade_id": "TRADE123456",
        "exchange_trade_id": "EXCH123456",
        "exchange_order_id": "EXORD123456",
        "trade_status": "COMPLETED",
        "trading_symbol": "AAPL",
        "remark": "Trade executed successfully",
        "exchange": "NSE",
        "segment": "CASH",
        "product": "CNC",
        "transaction_type": "BUY",
        "created_at": "2024-08-24T14:15:22Z",
        "trade_date_time": "2024-08-24T14:15:22Z",
        "settlement_number": "SETTLE123456"
      }
    ]
  }
}
```

--------------------------------

### Subscribe to live index data with GrowwFeed

Source: https://groww.in/trade-api/docs/python-sdk/feed

Initializes GrowwAPI and GrowwFeed, subscribes to index values with a callback, and demonstrates both blocking and synchronous polling. The consume() method is blocking, so code after it will not run. Unsubscribe is shown at the end.

```python
from growwapi import GrowwFeed, GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
groww = GrowwAPI(API_AUTH_TOKEN)
feed = GrowwFeed(groww)
 
def on_data_received(meta): # callback function which gets triggered when data is received
    print("Data received")
    print(feed.get_index_value())
 
# you can fetch exchange_token from instruments.csv file
instruments_list = [{"exchange": "NSE", "segment": "CASH", "exchange_token": "NIFTY"}, {"exchange": "BSE", "segment": "CASH", "exchange_token": "1"}]
feed.subscribe_index_value(instruments_list, on_data_received=on_data_received)
 
# This is a blocking call. Nothing after this will run.
feed.consume()
 
# OR
 
# you can also fetch data synchronously
feed.subscribe_index_value(instruments_list)
# live data can also be continuously polled using this method
for i in range(10):
    print(feed.get_index_value())
 
feed.unsubscribe_index_value(instruments_list)
```

--------------------------------

### Response JSON for Get Greeks API

Source: https://groww.in/trade-api/docs/curl/live-data

Example response showing a successful request with status SUCCESS and a payload containing Greek values: delta, gamma, theta, vega, rho, and iv.

```json
{
  "status": "SUCCESS",
  "payload": {
    "greeks": {
      "delta": 0.6006,
      "gamma": 0.0014,
      "theta": -8.1073,
      "vega": 13.1433,
      "rho": 2.7333,
      "iv": 8.2383
    }
  }
}
```

--------------------------------

### Python SDK Usage: get_option_chain

Source: https://groww.in/trade-api/docs/python-sdk/live-data

Initializes GrowwAPI with an auth token and calls get_option_chain for NIFTY with a specific expiry date. Requires replacing API_AUTH_TOKEN with actual credentials.

```python
from growwapi import GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
# Get option chain for NIFTY with specific expiry date
option_chain_response = groww.get_option_chain(
    exchange=groww.EXCHANGE_NSE,
    underlying="NIFTY",
    expiry_date="2025-11-28"
)
print(option_chain_response)
```

--------------------------------

### GET /v1/historical/contracts

Source: https://groww.in/trade-api/docs/curl/backtesting

Fetches all contracts for a specific underlying symbol and expiry date. Used to get the groww_symbol for a specific contract.

```APIDOC
## [GET] /v1/historical/contracts

### Description
Get all contracts for a specific underlying symbol and expiry date. This is used to obtain the groww_symbol for a specific contract.

### Method
GET

### Endpoint
https://api.groww.in/v1/historical/contracts

### Parameters
#### Query Parameters
- **exchange** (string) - Required - Stock exchange (NSE, BSE)
- **underlying_symbol** (string) - Required - Underlying symbol (e.g., NIFTY)
- **expiry_date** (string) - Required - Expiry date in yyyy-MM-dd format

### Request Example
```
curl -X GET 'https://api.groww.in/v1/historical/contracts?exchange=NSE&underlying_symbol=NIFTY&expiry_date=2024-01-04' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

### Response
No response schema provided in the source.
```

--------------------------------

### GET /v1/live-data/ltp

Source: https://groww.in/trade-api/docs/curl/live-data

Get the latest price (LTP) of up to 50 instruments. Use segment CASH for stocks and indices, FNO for derivatives.

```APIDOC
## GET /v1/live-data/ltp

### Description
Get the latest price (LTP) of up to 50 instruments. Use segment CASH for stocks and indices, FNO for derivatives.

### Method
GET

### Endpoint
https://api.groww.in/v1/live-data/ltp

### Parameters
#### Query Parameters
- **segment** (string) - Required - Segment of the instrument such as CASH and FNO etc.
- **exchange_symbols** (array[string]) - Required - String of trading symbols with their respective exchanges. For example `NSE_RELIANCE` `BSE_SENSEX` `NSE_NIFTY25APR24100PE` `MCX_CRUDEOIL25JAN25FUT`

### Request Example
```
curl -X GET https://api.groww.in/v1/live-data/ltp?segment=CASH&exchange_symbols=NSE_RELIANCE,BSE_SENSEX \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'X-API-VERSION: 1.0'
```

### Response
#### Success Response (200)
- **status** (string) - SUCCESS if request is processed successfully, FAILURE if the request failed
- **ltp** (decimal) - Last traded price (in rupees)

#### Response Example
```
{
  "status": "SUCCESS",
  "payload": {
    "NSE_RELIANCE": 2334.2,
    "BSE_SENSEX": 73243.4
  }
}
```
```

--------------------------------

### Load instrument CSV with pandas and GrowwAPI

Source: https://groww.in/trade-api/docs/python-sdk/instruments

Shows how to load the instrument CSV file into a pandas DataFrame. The first method uses groww.INSTRUMENT_CSV_URL, which points to the URL for downloading the instrument CSV. The alternative method calls groww._load_instruments() directly. The example prints the first few rows with head().

```python
from growwapi import GrowwAPI
import pandas as pd
# Load the CSV file
instrument_df = pd.read_csv(groww.INSTRUMENT_CSV_URL) # groww.INSTRUMENT_CSV_URL points to the url to download the instrument csv file
 
# OR you can also do this
instrument_df = groww._load_instruments()
print(instrument_df.head())
```

--------------------------------

### OHLC response payload example

Source: https://groww.in/trade-api/docs/python-sdk/live-data

Example JSON response from get_ohlc showing open, high, low, and close prices in rupees for each requested symbol.

```json
{
  "NSE_NIFTY": {
    "open": 22516.45,
    "high": 22613.3,
    "low": 22526.4,
    "close": 22547.55
  },
  "NSE_RELIANCE": {
    "open": 1212.8,
    "high": 1215.0,
    "low": 1201.0,
    "close": 1204.0
  }
}
```

--------------------------------

### Python SDK: get_trade_list_for_order usage

Source: https://groww.in/trade-api/docs/python-sdk/orders

Initializes the GrowwAPI client and calls get_trade_list_for_order with required parameters groww_order_id and segment, plus optional page and page_size. The page_size maximum is 50; if not provided, it defaults to 50.

```python
from growwapi import GrowwAPI
 
# Groww API Credentials (Replace with your actual credentials)
API_AUTH_TOKEN = "your_token"
 
# Initialize Groww API
groww = GrowwAPI(API_AUTH_TOKEN)
 
trade_list_response = groww.get_trade_list_for_order(
    groww_order_id="GMK39038RDT490CCVRO",
    segment=groww.SEGMENT_CASH,
    page=0, # Optional: Page number for paginated results
    page_size=50 # Optional: Number of trades to fetch per page (default is 50)
)
print(trade_list_response)
```
Tokens:
Raw