/bseindia/companies/shareholding

POST /api/bseindia/companies/shareholding

Price: 1 credit

Get the shareholding pattern a BSE-listed company filed for its latest or a chosen quarter, one row per holder category: shareholders, fully and partly paid shares, total and percentage held, voting rights, convertibles, warrants and ESOPs, locked-in, pledged and encumbered shares and demat holdings

How to use it

Without quarter_id it returns the latest filing; each row carries the quarter_id it belongs to.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• scrip_code string required — BSE scrip code or quote page URL (examples: "500325", "https://www.bseindia.com/stock-share-price/reliance-industries-ltd/RELIANCE/500325/")
• count integer required — Max number of results (min: 1; max: 1000)
• quarter_id string nullable — BSE quarter id of an earlier shareholding filing (examples: "125", "130")

Response

• @type string (default: "BseindiaShareholding")
• scrip_code string required
• company_name string nullable
• quarter_id string nullable
• quarter string nullable
• period_start_date integer nullable
• period_end_date integer nullable
• category_code string nullable
• category string nullable
• level string nullable
• subcategory string nullable
• shareholder_count integer nullable
• fully_paid_shares number nullable
• partly_paid_shares number nullable
• depository_receipt_shares number nullable
• total_shares number nullable
• percent number nullable
• voting_rights_class_x number nullable
• voting_rights_class_y number nullable
• voting_rights number nullable
• voting_rights_percent number nullable
• convertible_securities number nullable
• warrants number nullable
• esops number nullable
• percent_after_full_conversion number nullable
• locked_in_shares number nullable
• locked_in_percent number nullable
• pledged_shares number nullable
• pledged_percent number nullable
• non_disposal_undertaking_shares number nullable
• non_disposal_undertaking_percent number nullable
• other_encumbered_shares number nullable
• other_encumbered_percent number nullable
• total_encumbered_shares number nullable
• total_encumbered_percent number nullable
• demat_shares number nullable
• subcategory_i_shares number nullable
• subcategory_ii_shares number nullable
• subcategory_iii_shares number nullable
• is_irregular_filing boolean 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 shareholding filing for that scrip code and quarter 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.