Skip to content

US Stock Endpoints

Query endpoints for US stock and SEC data.

GET /api/v1/us/companies

US public company metadata.

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
exchangestringexactExchange (NYSE, NASDAQ, etc.)
industrystringexactIndustry
sectorstringexactSector
namestringlikeCompany name (fuzzy)

Example:

Terminal window
curl -H "F-API-KEY: fk-xxxxx" \
"https://finance-api.xp-java.workers.dev/api/v1/us/companies?ticker=AAPL"

GET /api/v1/us/filings

SEC filings (10-K, 10-Q, 8-K, etc.).

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
filing_typestringexactFiling type
accession_numberstringexactAccession number
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date

GET /api/v1/us/financial-facts

Standardized US GAAP financial facts (XBRL).

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
standard_namestringexactStandardized concept name
fiscal_yearstringexactFiscal year
fiscal_periodstringexactFiscal period (FY, Q1, Q2, Q3, Q4)
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date

GET /api/v1/us/financial-statements

Full financial statement line items.

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
accession_numberstringexactAccession number
statement_typestringexactBalanceSheet, IncomeStatement, CashFlow
conceptstringexactXBRL concept
fiscal_yearstringexactFiscal year
fiscal_periodstringexactFiscal period
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date

GET /api/v1/us/financial-metrics

Pre-calculated financial metrics.

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
metric_namestringexactMetric name
fiscal_yearstringexactFiscal year
fiscal_periodstringexactFiscal period

GET /api/v1/us/insider-trades

Insider trading transactions.

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
insider_namestringexactInsider name
transaction_typestringexactTransaction type
transaction_codestringexactTransaction code
accession_numberstringexactAccession number
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date

GET /api/v1/us/13f-holdings

Institutional 13F holdings.

Query Parameters:

ParameterTypeFilter TypeDescription
cikstringexactSEC CIK
tickerstringexactStock ticker
filing_typestringexactFiling type
accession_numberstringexactAccession number
cusipstringexactCUSIP
manager_namestringlikeManager name (fuzzy)
date_fromstringdate rangeStart date
date_tostringdate rangeEnd date