Skip to content

TOOL REFERENCE

get_returns

Mechanically-computed returns, volatility and drawdown. This is a read-only research or operational tool. It does not place trades or issue investment recommendations.

get_returns

Mechanically-computed returns, volatility and drawdown

USE WHEN

1W/1M/3M/6M/1Y/YTD returns, CAGR, volatility and max drawdown — computed from the price series, not opinion.

PARAMETERS

get_returns parameters
NameTypeRequiredDefaultDescription
querystringYesCompany name, symbol, code or ISIN.

RESPONSE DATA

  • returns (1W/1M/3M/6M/1Y/YTD/max), cagr, annualized_volatility, max_drawdown, high_52w, low_52w.

NOTES

  • A window spanning a major corporate action (e.g. a demerger) is nulled rather than reported as a distorted figure.

EXAMPLE PROMPTS

  • What's the 1-year and 3-year return for this stock, and its max drawdown?
Also available via REST: /stocks/{q}/returns

KEEP EXPLORING

Connect your AI to Indian stock market data

Sign in to DalalOS and connect your AI in one line of config. Free to start.