GETTING STARTED

Authentication & Access

How to authenticate with the INDvest API.

Base URL

https://api.indvested.com

All endpoints are relative to this base URL.

Getting an API Token

API tokens are provided free of charge upon request and are subject to manual review.

Request an API token

Authentication

Include your token in the x-api-token header on every request:

curl -s https://api.indvested.com/api/mf/get_all_amcs \
  -H "x-api-token: YOUR_TOKEN"

Requests without a valid token return 403:

{ "reason": "API token missing." }

Expired or invalid tokens return:

{ "reason": "Invalid or expired API token. Please contact us at https://indvest.io/request-api-access/." }

Token-Exempt Endpoints

Some endpoints do not require an API token:

  • All calculator endpoints (/api/calculator/*)
  • Fund comparison (/api/mf/compare_mutual_funds)
  • Portfolio return (/api/mf/compute_portfolio_return)
  • Fund screener (/api/mf/screen)
  • Fund overlap (/api/mf/fund_overlap)
  • Portfolio overlap (/api/mf/portfolio_overlap)

Rate Limiting

All endpoints are rate-limited to 60 requests per minute per IP address. Exceeding this limit returns 429 Too Many Requests.

Response Format

All responses are JSON unless otherwise noted (historical data endpoints return streaming CSV). Standard conventions:

  • Dates are formatted as YYYY-MM-DD
  • Percentages are returned as numbers (e.g., 12.5 means 12.5%)
  • Currency values are in Indian Rupees (INR)
  • Duration keys in metric objects are in months as strings (e.g., "12" = 1 year, "36" = 3 years, "60" = 5 years)