Filings Keyword Search

Authorizations

Authorization

string

header

required

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

Body

application/json

filters

object

required

Filters to narrow the search scope. For example, the search can be limited to few companies only. Without filters, search will be performed across all the filings.

filters.types

string[]

required

Type of document (e.g., earnings-transcript)

filters.industries

string[]

Industries (based on Industry Classification) to filter by. Check the valid values - https://docs.google.com/spreadsheets/d/17-Zq8E6G7hAq4-3QdjLj_b1EGghFcM9OB7Om5AXSLRI/edit?gid=582731802#gid=582731802

filters.quarters

string[]

Quarters to filter by

filters.sectors

string[]

Sectors (based on Industry Classification) to filter by. Check the valid values - https://docs.google.com/spreadsheets/d/17-Zq8E6G7hAq4-3QdjLj_b1EGghFcM9OB7Om5AXSLRI/edit?gid=0#gid=0

filters.tickers

string[]

Company Tickers. Format: exchange:ticker values. Example - [NSE:ZOMATO, BSE:TCS]

filters.years

string[]

Years to filter by

query

string

required

Keyword/Phrase to Search

Response

200 - application/json

data

object

Search Result

data.ai_insights

object

Contains either the url or the data of AI Insights based on API invoked

data.ai_insights.url

string

If insights are present for the document, the url provides the API Path to the AI insights. Else the object is empty or null. Note: The url attribute is not present in AI Insights API response. Its present only in the Document Feed API Response

data.company_id

string

Internal Company ID

data.company_name

string

data.exchange_tickers

object[]

data.exchange_tickers.exchange

enum<string>

Exchange Name

Available options:

BSE,

NSE

data.exchange_tickers.id

string

Company ID/Code in the exchange. Not present for NSE

data.exchange_tickers.ticker

string

Company ticker in the exchange

data.exchange_tickers.url

string

Company URL in the exchange

data.highlights

object

Text in the document matching with the query

data.highlights.highlight_term

string[]

query term and other similar terms

data.highlights.highlight_text

string

matching text

data.html_link

string

HTML Link of the document. A document can have either a pdf_link or html_link

data.id

string

Internal Document ID

data.month

string

Document associated month

data.pdf_link

string

PDF Link of the document. A document can have either a pdf_link or html_link

data.published_date

string

UTC Timestamp of the document published date-time

data.quarter

string

Document associated Quarter

data.ticker

string

data.type

enum<string>

Represents the type of document

Available options:

earnings-transcript,

annual-report,

announcement

data.year

string

Document associated year

status

enum<string>

Available options:

success

API Documentation

India Market Data

US Market Data

Sample Scripts

Authorizations

Body

Response