/nseindia/corporate_actions/search

POST /api/nseindia/corporate_actions/search

Price: 10 credits

Search corporate actions announced on NSE (dividends, bonus issues, splits, rights, buybacks, AGMs and more) by company symbol, ex-date window and market segment: subject, face value, ex-date, record date, book closure and no-delivery periods

How to use it

The window filters on the ex-date and may reach into the future. With symbol and no dates it returns the company's full history; without symbol the window defaults to the last 30 days. A date_to alone ends the window; a window with no actions 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 corporate actions to return (min: 1; max: 5000)

Response

• @type string (default: "NseindiaCorporateAction")
• symbol string nullable
• company_name string nullable
• isin string nullable
• series string nullable
• subject string nullable
• face_value number nullable
• ex_date integer nullable
• record_date integer nullable
• book_closure_start_date integer nullable
• book_closure_end_date integer nullable
• no_delivery_start_date integer nullable
• no_delivery_end_date integer 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.