/screener/companies

POST /api/screener/companies

Price: 10 credits

Get a company's Screener.in profile by NSE symbol, BSE code or company URL: market cap, price, 52-week range, P/E, book value, dividend yield, ROCE, ROE, face value, business description, key points, pros and cons, sector classification, NSE and BSE codes, website and links to announcements, annual reports, credit ratings and concall transcripts

How to use it

Market cap is in crore rupees. Find a company with screener/companies/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — NSE symbol, BSE scrip code or screener.in company URL (examples: "RELIANCE", "500325", "https://www.screener.in/company/TCS/consolidated/")
• consolidated boolean nullable — Consolidated figures instead of standalone; a company URL decides by default

Response

• @type string (default: "ScreenerCompany")
• company_id string required
• warehouse_id string nullable
• name string nullable
• url string required
• nse_symbol string nullable
• bse_code string nullable
• website string nullable
• is_consolidated boolean required
• market_cap number nullable
• current_price number nullable
• price_change_percent number nullable
• price_date integer nullable
• year_high number nullable
• year_low number nullable
• pe number nullable
• book_value number nullable
• dividend_yield number nullable
• roce number nullable
• roe number nullable
• face_value number nullable
• description string nullable
• key_points string nullable
• pros array (default: [])
• cons array (default: [])
• classification array (default: [])
  • @type string (default: "ScreenerClassification")
  • code string required
  • name string required
  • level integer required
• documents array (default: [])
  • @type string (default: "ScreenerDocument")
  • kind string required
  • url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Screener has no company under that symbol or code Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.