screens

Fundamental stock screen

Screen listed companies with a ratio expression over 325 fundamental ratios. Grammar: one or more conditions {Ratio name} {> < = >= <=} {value} joined with AND / OR; the value is a plain decimal (optionally with %) or another ratio name for a cross-field comparison (Current price > DMA 200). Ratio names come from /v1/screens/fundamental/fields (matched case-insensitively). A malformed expression or unknown ratio is a 400 naming the offending token and the closest valid names. Example: Market Capitalization > 5000 AND Return on capital employed > 22. Ranked by sort (a ratio name; default market capitalisation) in order (default desc); rank is continuous across pages. Set latest=true to keep only companies that have already published results for the latest quarter (useful mid results season, when quarterly ratios otherwise mix two quarters); omitted or false screens every company. A page can hold fewer than limit rows; follow next_cursor until it is null, keeping query, sort, order and latest unchanged. Data is end-of-day from the latest published results.

get/v1/screens/fundamental

Request

  • Base URL: https://api.tapetide.com
  • URL: https://api.tapetide.com/v1/screens/fundamental
  • Auth: HTTP bearer

Query parameters

querystring required

Ratio expression (max 1500 chars).

sortstring

Ratio name to order by, e.g. Return on equity. Default: Market Capitalization.

order'asc' | 'desc'

Sort direction by date.

latestboolean

true keeps only companies whose latest-quarter results are out. true/false (or 1/0); any other value is a 400. Default: every company.

limitinteger

Items per page (default 25, max 50). Values over the max are rejected, never clamped.

cursorstring

Opaque cursor from meta.next_cursor of the previous page.

Response

OK. Costs one request unit.

Example response

{
  "data": [
    {
      "rank": 1,
      "symbol": "TCS",
      "name": "TCS",
      "ltp": 2433.1,
      "pe": 17.68,
      "market_cap_cr": 880316.87,
      "dividend_yield_pct": 4.1,
      "net_profit_qtr_cr": 12760,
      "profit_growth_qtr_pct": 1.4,
      "sales_qtr_cr": 65799,
      "sales_growth_qtr_pct": 2.4,
      "roce_pct": 64.6,
      "roe_pct": 52.4,
      "sort_value": null,
      "ratio_values": {
        "Market Capitalization": 880316.87,
        "Return on capital employed": 64.6
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.