/nseindia/deals/search

POST /api/nseindia/deals/search

Price: 10 credits

Search bulk deals, block deals or short-selling disclosures on NSE by day window and symbol, newest day first: date, symbol, security name, client, buy or sell, quantity and the trade or weighted average price

How to use it

Without dates the window is the last 30 days. Short-selling rows carry only the quantity. A window with no deals 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)
• deal_type string — Kind of deal (default: "bulk"; one of: "bulk", "block", "short_selling")
• count integer required — Max number of deals to return (min: 1; max: 20000)

Response

• @type string (default: "NseindiaDeal")
• deal_type string required
• date integer required
• symbol string nullable
• security_name string nullable
• client_name string nullable
• side string nullable
• quantity number nullable
• price number nullable
• remarks 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.