GET
/
api
/
in
/
v0
/
documents
/
announcement

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ticker
string

Exchange:Ticker of companies. Multiple tickers can be provided separated by commas. Example - NSE:ZOMATO, BSE:TCS. Get tickers from Company Details.

from_date
string

Start date in YYYY-MM-DD format. Use this parameter to filter data from a specific start date.

to_date
string

End date in YYYY-MM-DD format. Use this parameter to filter data till a specific end date.

announcement_type_id
string

Comma-separated Announcement Category IDs (Allowed Values - 1 to 26). Check the corporate-announcements-types mapping.

sentiment
string

Comma-separated sentiment values (Allowed values - positive, negative, neutral).

sector
string

Sector classification of the companies. Multiple values can be provided separated by commas. Get valid sector values from Company Details.

industry
string

Industry classification of the companies. Multiple values can be provided separated by commas. Check valid industry values from Company Details.

limit
integer

The number of results to return per page. This parameter is optional and defaults to 20 if not specified. Maximum value is 50.

page
integer

Page number for pagination. This parameter is optional and defaults to 1 if not specified.

Response

200 - application/json
status
enum<string>
Available options:
success
data
object[]
meta
object