Skip to main content

Public Python client for the hosted Stockwaale Indian equities intelligence API and MCP endpoint

Project description

Stockwaale MCP

PyPI Version npm Scoped Version

Stockwaale is a hosted intelligence layer for Indian equities. It exposes verified market context through REST APIs and a remote Model Context Protocol endpoint for AI agents, builders, and research workflows.

The public PyPI and npm packages are thin clients. They do not contain the private FastAPI server, Lambda handler, MongoDB code, database credentials, or business deployment logic.

Hosted Endpoints

  • MCP Streamable HTTP: https://api.stockwaale.com/mcp
  • MCP SSE: https://api.stockwaale.com/mcp/sse
  • Discovery manifest: https://api.stockwaale.com/.well-known/mcp.json
  • Product site: https://stockwaale.com

Install

Python:

pip install stockwaale-mcp

Node.js:

npm install @stockwaale/stockwaale-mcp

Python Usage

from stockwaale import StockwaaleClient

client = StockwaaleClient(api_key="sk_live_xxx")
print(client.price("RELIANCE"))
print(client.screen(regime="Bullish Expansion", min_rsi=55))

The client also reads:

export STOCKWAALE_API_KEY=sk_live_xxx
export STOCKWAALE_BASE_URL=https://api.stockwaale.com

CLI:

stockwaale-mcp manifest
stockwaale-mcp mcp-config
stockwaale-mcp price RELIANCE

Node.js Usage

const { StockwaaleClient } = require("@stockwaale/stockwaale-mcp");

const client = new StockwaaleClient({ apiKey: "sk_live_xxx" });

async function main() {
  console.log(await client.price("RELIANCE"));
  console.log(await client.screen({ regime: "Bullish Expansion", min_rsi: 55 }));
}

main();

CLI:

npx @stockwaale/stockwaale-mcp manifest
npx @stockwaale/stockwaale-mcp mcp-config
npx @stockwaale/stockwaale-mcp price RELIANCE

MCP Client Config

Use the hosted remote endpoint from Claude Desktop, Cursor, VS Code extensions, or any MCP client that supports Streamable HTTP:

{
  "mcpServers": {
    "stockwaale": {
      "http": {
        "url": "https://api.stockwaale.com/mcp"
      }
    }
  }
}

For protected plans, send the API key as Authorization: Bearer <key> or X-API-Key: <key> where the client supports custom headers.

API Keys

Do not publish fixed API keys in package code, README examples, GitHub, PyPI, or npm.

Production API keys are created per user or organization in the hosted backend after Firebase login. The free plan defaults to 50 API calls per day. Keys are stored hashed in the database and shown only once at creation time.

Fixed keys in STOCKWAALE_API_KEYS are only for admin/test bootstrap access and private smoke checks. They should not be customer keys.

Lambda environment variables or AWS Secrets Manager should hold platform secrets such as MongoDB credentials, Firebase service-account configuration, JWT signing secrets, webhook secrets, and bootstrap admin credentials.

Private Deployment Boundary

The private Lambda deployment can include:

  • lambda_handler.py
  • FastAPI application code
  • MCP server implementation
  • MongoDB integration
  • AWS Secrets Manager integration
  • CloudFront and Lambda deployment templates

Those files should stay in a private repository or private deployment artifact. PyPI and npm package artifacts should ship only the public clients and documentation needed by customers.

Compliance

Stockwaale provides market data context, derived indicators, and research infrastructure. It does not provide investment advice, guaranteed returns, financial planning, stock tips, or SEBI-registered advisory services.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stockwaale_mcp-1.0.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stockwaale_mcp-1.0.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file stockwaale_mcp-1.0.0.tar.gz.

File metadata

  • Download URL: stockwaale_mcp-1.0.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for stockwaale_mcp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2728986889d8bc40adfc54432ffc09e757c346ad365e7fd375c4a0a72ed2439e
MD5 131f203644776486bc751053067d8c89
BLAKE2b-256 2c1b4335f458b7be87acdc672c7d0b655535812586dd563b9084f883e8f1cc64

See more details on using hashes here.

File details

Details for the file stockwaale_mcp-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: stockwaale_mcp-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for stockwaale_mcp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ab9eef92b6b546adaada00238160fb08dea10c8a925c4b6d739c8b0550fe29c
MD5 5ca14eb575ff942217fabdaa605cae82
BLAKE2b-256 38f88b0a3b00b41cceb97e5feb847c68e528d5bfcb614f70dd18472cb3760e5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page