/nseindia/companies

POST /api/nseindia/companies

Price: 1 credit

Get an NSE-listed security by trading symbol: name, ISIN, series, listing date, sector and industry classification, index memberships, P/E, face value, issued shares, market capitalisation, the day's price, range, traded volume and value, delivery, volatility, margins, price band and the order book

How to use it

Find a symbol with nseindia/companies/search. Money values are in Indian rupees.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string required — NSE trading symbol or quote page URL (examples: "RELIANCE", "https://www.nseindia.com/get-quotes/equity?symbol=TCS")

Response

• @type string (default: "NseindiaCompany")
• symbol string required
• name string nullable
• url string required
• isin string nullable
• series string nullable
• active_series array (default: [])
• status string nullable
• board string nullable
• trading_segment string nullable
• share_class string nullable
• listing_date integer nullable
• is_fno_security boolean nullable
• is_slb_security boolean nullable
• is_etf boolean nullable
• is_suspended boolean nullable
• is_delisted boolean nullable
• has_debt_securities boolean nullable
• macro_sector string nullable
• sector string nullable
• industry string nullable
• basic_industry string nullable
• sector_index string nullable
• indices array (default: [])
• pe number nullable
• sector_pe number nullable
• face_value number nullable
• issued_shares number nullable
• market_cap number nullable
• free_float_market_cap number nullable
• last_price number nullable
• change number nullable
• change_percent number nullable
• open number nullable
• day_high number nullable
• day_low number nullable
• previous_close number nullable
• close number nullable
• vwap number nullable
• year_high number nullable
• year_high_date integer nullable
• year_low number nullable
• year_low_date integer nullable
• lower_price_band number nullable
• upper_price_band number nullable
• tick_size number nullable
• nav number nullable
• nav_date integer nullable
• indicative_nav number nullable
• maturity_date integer nullable
• issue_description string nullable
• traded_volume number nullable
• traded_value number nullable
• delivery_quantity number nullable
• delivery_percent number nullable
• impact_cost number nullable
• daily_volatility number nullable
• annual_volatility number nullable
• security_var number nullable
• index_var number nullable
• var_margin number nullable
• extreme_loss_margin number nullable
• adhoc_margin number nullable
• applicable_margin number nullable
• total_buy_quantity number nullable
• total_sell_quantity number nullable
• bids array (default: [])
  • @type string (default: "NseindiaOrderLevel")
  • price number required
  • quantity integer nullable
• asks array (default: [])
  • @type string (default: "NseindiaOrderLevel")
  • price number required
  • quantity integer nullable
• updated_at integer 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 — No NSE-listed security under that symbol 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.