For Developers

Integrate FinRace into your own stack

A separate, versioned partner API — not an afterthought bolted onto the consumer app. Built for banks, NBFCs, and fintechs who need our analysis engine inside their own product.

🔑 Authentication

Every request needs either an API key or a session JWT — the same auth used across the whole platform, nothing partner-specific to relearn.

# Generate a key from Settings, or:
POST /api/v1/organization/api-keys
# Then on every request:
X-API-Key: your_key_here

🪝 Webhooks

Register a webhook URL and secret in your organization settings to receive HMAC-signed event payloads the moment an async research job completes — no polling required.

PUT /api/v1/organization/settings
{ webhook_url, webhook_secret }
# Verify with the X-FinRace-Signature header

Endpoint Reference

Analysis

GET/analyze/{symbol}

Full decision + prediction + risk assessment for a symbol

POST/intelligence/analyze

Same engine, with optional natural-language query context

POST/intelligence/explain

Explainability trace only — the reasoning behind a verdict

Knowledge Base

POST/knowledge/upload

Ingest a PDF/Excel/CSV into your tenant's document index

POST/knowledge/search

Semantic search across your uploaded documents

Tax & GST Tools

POST/tools/tax

Old vs. New regime tax liability comparison

POST/tools/gst

Reconcile a purchase register against GSTR-2B entries

📦 Official SDKs

Typed client libraries generated directly from the API’s OpenAPI spec — no drift between docs and code.

📖 Live Interactive Docs

The partner API ships its own always-on Swagger UI, ReDoc, and raw OpenAPI schema — separate from the main app’s internal (debug-only) docs.

/api/external/v1/docs
/api/external/v1/redoc
/api/external/v1/openapi.json

Partner API access is included from the Institutional plan, with full webhook + team-seat support. Every response carries the same SEBI risk-disclosure language as the terminal — this is informational output, not investment advice, whether a human or your system reads it.