What is Groww Mcp

The groww-mcp is a Multi-Channel Platform server designed for interacting with the Groww trading API. It provides a unified API interface to access various trading functionalities such as fetching portfolio data, obtaining live stock quotes, and managing orders.

Use cases

Use cases for groww-mcp include personal investment tracking, automated trading systems, and applications that require integration with the Groww trading API for portfolio management and order execution.

How to use

To use groww-mcp, clone the repository from GitHub, install the necessary dependencies, set up your environment variables with a valid Groww API key, and start the server. You can then interact with the available endpoints for portfolio management, live quotes, and order operations.

Key features

Key features of groww-mcp include fetching current portfolio data, retrieving live stock quotes and OHLC data, placing, modifying, and canceling stock orders, and ensuring full type validation with Zod schemas.

Where to use

groww-mcp can be utilized in financial applications, trading platforms, and investment tools where real-time stock data and order management are essential.

Groww MCP Server

This project provides an MCP (Multi-Channel Platform) server for interacting with the Groww trading API. It allows you to fetch portfolio data, get live quotes, place/cancel/modify orders, and more, all via a unified API interface.

Features

• Fetch your current portfolio
• Get live stock quotes and OHLC data
• Place, modify, and cancel stock orders
• Fully typed and validated with Zod schemas

Available Tools

• get-portfolio: Get the current portfolio of the user
• get-live-quote: Get live quote data for a specific stock
• get-last-traded-price: Get the last traded price for one or more stocks
• get-ohlc: Get OHLC (Open, High, Low, Close) data for stocks
• get-historical-candle: Fetch historical candle data (Open, High, Low, Close, Volume) for a stock for a given time range and interval
• place-order: Place a new stock order (buy/sell)
• modify-order: Modify an existing stock order
• cancel-order: Cancel an existing stock order
• get-order-status: Get the status of an order

Requirements

• Node.js v18 or later
• A valid Groww API key

Setup (Local)

1. Clone the repository:

   git clone https://github.com/venkatakaushikvemani/groww-mcp
   cd groww-mcp
   

2. Install dependencies:

   npm install
   # or
   pnpm install
   

3. Set environment variables:
   Create a .env file in the root directory and add:

   GROWW_API_KEY=your_groww_api_key_here
   PORT=3000 # or your preferred port
   

4. Start the server:

   npm start
   # or
   pnpm start
   

Use with Cursor / Claude / Windsurf

mcp.json

{
  "mcpServers": {
    "groww-mcp": {
      "command": "pnpm",
      "args": [
        "dlx",
        "groww-mcp"
      ],
      "env": {
        "GROWW_API_KEY": "YOUR_GROWW_API_KEY"
      }
    }
  }
}

Usage

• The server exposes endpoints/tools for portfolio, quotes, and order management.
• See the code in src/groww/tools.ts for available tools and their parameters.

Sample Prompts

Here are some example prompts you can use to interact with the tools:

• Get your portfolio:

  Fetch my portfolio

• Get a live quote:

  Get the live quote for TATAMOTORS

• Get last traded price:

  What is the last traded price of BPL and HFCL?

• Get OHLC data:

  Show me the OHLC data for TATAMOTORS

• Get historical candle data:

  Show me the historical candle data for TATAMOTORS for the last 1 day
  Fetch 5-minute historical candles for TATAMOTORS from 2024-06-01 09:15:00 to 2024-06-01 15:30:00

• Place a buy order:

  Buy 10 shares of SADHNANIQ

• Place a sell order:

  Sell 5 shares of TATAMOTORS

• Modify an order:

  Modify my order for BPL to 20 shares

• Cancel an order:

  Cancel my latest order for BPL

• Get order status:

  What is the status of my last order?

Contributing

Pull requests and issues are welcome! Please open an issue to discuss your ideas or report bugs.

License

MIT