/nseindia/shareholding_patterns/search

POST /api/nseindia/shareholding_patterns/search

Price: 20 credits

Search quarterly shareholding pattern filings on NSE by company symbol, submission window and market segment: period end, promoter and public holding percentages, employee trusts, revision status, notes and the XBRL filing link

How to use it

With symbol and no dates it returns every filing of the company; without symbol the window defaults to the last 30 days of submissions. A date_to alone ends the window; a window with no filings returns an empty list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string nullable — NSE trading symbol of one company (examples: "RELIANCE", "INFY")
• date_from integer nullable — Earliest day, as unix seconds; day-granular (examples: 1788220800)
• date_to integer nullable — Latest day, as unix seconds; day-granular (examples: 1790812800)
• segment string — Market segment of the issuers (default: "equities"; one of: "equities", "sme", "debt", "mutual_funds", "invits_reits", "municipal_bonds", "social_stock_exchange")
• count integer required — Max number of shareholding filings to return (min: 1; max: 5000)

Response

• @type string (default: "NseindiaShareholdingPattern")
• id string required
• symbol string nullable
• company_name string nullable
• isin string nullable
• period_end_date integer nullable
• promoter_percent number nullable
• public_percent number nullable
• employee_trusts_percent number nullable
• submission_date integer nullable
• broadcast_at integer nullable
• disseminated_at integer nullable
• is_revised boolean nullable
• revision_date integer nullable
• revision_remark string nullable
• remarks string nullable
• promoter_demat_notes string nullable
• public_shareholding_notes string nullable
• notes string nullable
• xbrl_url string nullable
• xbrl_size string nullable

Errors

• 422 — date_to is before date_from or an invalid symbol 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 — The entity was not found, or a precondition failed 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.