MCP Server Upstox Api

🚀 Upstox API MCP Server

An MCP server for integrating with the Upstox trading API.

🚀 Quick Start

Setup

1. Clone the repository:

git clone https://github.com/yourusername/mcp-server-upstox-api.git
cd mcp-server-upstox-api

2. Install dependencies:

npm install

Run the Server

Start the MCP server:

npm run start

Your MCP server will run at http://localhost:8787.

✨ MCP Configuration

Claude Desktop Configuration

To use this MCP server with Claude Desktop, add the following configuration in Claude Desktop settings:

{
  "mcpServers": {
    "mcp-server-upstox-api": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://localhost:8787/sse"
      ]
    }
  }
}

Cursor MCP Configuration

To use this MCP server with Cursor, add the following configuration in Cursor's MCP settings (usually located at ~/.cursor/mcp.json):

{
  "mcpServers": {
    "mcp-server-upstox-api": {
      "url": "http://localhost:8787/sse"
    }
  }
}

These configurations allow Claude Desktop and Cursor to connect to your local MCP server and use the Upstox API endpoints.

💻 Usage with Claude and Cursor

You can interact with the Upstox API through natural language prompts. Here are some example prompts for each command:

Profile Information

• "What is my Upstox profile information?"
• "Show my current active segments and products."
• "What are my user ID and email?"

Funds and Margin

• "How much available margin do I have?"
• "Show my equity segment funds and margin details."
• "What is my commodity segment margin availability?"

Holdings

• "Which stocks do I currently hold?"
• "Show my long-term holdings and their current values."
• "What is the total value of my holdings?"

Orders

• "What are my current open orders?"
• "Show my intraday orders and their profit and loss (P&L)."
• "What is the total unrealized P&L of my open orders?"

MTF Orders

• "What are my Margin Trade Funding orders?"
• "Show my MTF orders and their current values."
• "What is my total MTF exposure in the account?"

Order Book

• "Show my orders on Upstox today."
• "What are my pending orders?"
• "Show my order history today."
• "What is the status of my orders?"
• "List my completed orders today."

Order Details

• "Show the detailed information of order ID xxxxxxxxxxxxxxx."
• "What is the status of order ID xxxxxxxxxxxxxxx?"
• "Get the full information of order xxxxxxxxxxxxxxx."
• "Check the execution status of order xxxxxxxxxxxxxxx."
• "View the details of the recent order xxxxxxxxxxxxxxx."

Order History

• "Show the history of order ID xxxxxxxxxxxxxxx."
• "Get all status updates of order xxxxxxxxxxxxxxx."
• "What is the progress of order xxxxxxxxxxxxxxx?"
• "Show all stages of order xxxxxxxxxxxxxxx."
• "Get the order history with tag xxxxxxxxxxxxxxx."

Trade Orders

• "Show the trades corresponding to order ID xxxxxxxxxxxxxxx."
• "Which trades were executed for order ID xxxxxxxxxxxxxxx?"
• "Get the trade details of order xxxxxxxxxxxxxxx."
• "List all trades associated with order xxxxxxxxxxxxxxx."
• "Show the execution details of order xxxxxxxxxxxxxxx."

Trades

• "Show my trades today."
• "Which trades were executed today?"
• "Get my daily trade history."
• "List my completed intraday trades."
• "Show my trade details and their execution prices."

📚 Available Endpoints

Request Examples

Submit a Buy Order

{
  "type": "submit_order",
  "order": {
    "exchange": "SSE",
    "symbol": "600028",
    "side": "buy",
    "order_type": "limit",
    "price": 10.5,
    "quantity": 100
  }
}

Query Order Status

{
  "type": "get_order_status",
  "order_id": "123456"
}

Response Format

All API requests return a unified JSON format:

{
  "success": boolean, // Whether the request is successful
  "data": any,       // Data part
  "error": {
    "code": string,
    "message": string
  } // Error information (only returned on failure)
}

Error Handling

Common error codes and messages:

• invalid_params: Invalid parameters
• order_not_found: Order not found
• insufficient_balance: Insufficient balance
• symbol_not_found: Instrument not found
• invalid_order_type: Invalid order type
• network_error: Network error

Please ensure that when handling API requests, you check the returned status code and error information and handle exceptions accordingly.