latestOpenAPI 3.0.32026-08-101461131.1 MB

ad6f143e43aa

reference:stocks

Stock Financials vX

Get historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined <a rel="noopener noreferrer nofollow" target="_blank" href="http://xbrl.squarespace.com/understanding-sec-xbrl-financi/">here</a>.

get/vX/reference/financials

Query parameters

tickerstring

Query by company ticker.

cikstring

Query by central index key (<a rel="noopener noreferrer nofollow" target="_blank" href="https://www.sec.gov/edgar/searchedgar/cik.htm">CIK</a>) Number

company_namestring

Query by company name.

sicstring

Query by standard industrial classification (<a rel="noopener noreferrer nofollow" target="_blank" href="https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list">SIC</a>)

filing_datestring date

Query by the date when the filing with financials data was filed in YYYY-MM-DD format.

Best used when querying over date ranges to find financials based on filings that happen in a time period.

Examples:

To get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01

To get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01

period_of_report_datestring date

The period of report for the filing with financials data in YYYY-MM-DD format.

timeframe'annual' | 'quarterly' | 'ttm'

Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4

include_sourcesboolean

Whether or not to include the xpath and formula attributes for each financial data point. See the xpath and formula response attributes for more info. False by default.

company_name.searchstring

Search by company_name.

filing_date.gtestring date

Search by filing_date.

filing_date.gtstring date

Search by filing_date.

filing_date.ltestring date

Search by filing_date.

filing_date.ltstring date

Search by filing_date.

period_of_report_date.gtestring date

Search by period_of_report_date.

period_of_report_date.gtstring date

Search by period_of_report_date.

period_of_report_date.ltestring date

Search by period_of_report_date.

period_of_report_date.ltstring date

Search by period_of_report_date.

order'asc' | 'desc'
Example:asc

Order results based on the sort field.

limitinteger
Example:10

Limit the number of results returned, default is 10 and max is 100.

sort'filing_date' | 'period_of_report_date'
Example:filing_date

Sort field used for ordering.

Response

FIXME

countinteger required

The total number of results for this request.

next_urlstring

If present, this value can be used to fetch the next page of data.

request_idstring required

A request id assigned by the server.

statusstring required

The status of this request's response.