# Data API

> Every read route of https://api.aggre.org: what each does, its parameters and an example.

Page: https://docs.aggre.org/api/data · Section: API reference · All pages: https://docs.aggre.org/llms.txt

The data API is served at `https://api.aggre.org`. It is read-only, takes an API key in `Authorization: Bearer aggre_sk_...` (or `X-API-Key`), sets no cookies and allows no browser (CORS) access; call it from a server, a script or an agent. New to it? Start with the [quickstart](https://docs.aggre.org/quickstart.md).

This reference is generated from the OpenAPI file ([`/openapi/data.yaml`](https://docs.aggre.org/openapi/data.yaml), also as [JSON](https://docs.aggre.org/openapi/data.json)), so it lists exactly the routes the service registers. Row shapes are the JSON Schemas in the [schema reference](https://docs.aggre.org/api/schemas.md).

Rules that apply to every route are in [Concepts](https://docs.aggre.org/concepts/response-format.md): the response envelope, strict query parameters, opaque cursors, freshness (`meta.status`), attribution (`credit`) and the shared error codes.

## Pages

| Page | Routes | Covers |
|---|---|---|
| [Service routes](https://docs.aggre.org/api/data/service.md) | 4 | Health checks, the dataset list and the calling key. |
| [Market data](https://docs.aggre.org/api/data/market.md) | 7 | Candles, funding rates, open interest, instruments and the latest tickers. |
| [Macro data](https://docs.aggre.org/api/data/macro.md) | 5 | The economic calendar, official macro series and their observations, and derived series. |
| [Filings and trades (SEC EDGAR, US Congress)](https://docs.aggre.org/api/data/filings.md) | 9 | Companies, filings, XBRL facts, fundamentals, insider transactions, fails-to-deliver, 13F holdings, 8-K news and Congress trades. |
| [Taiwan equities](https://docs.aggre.org/api/data/equities-tw.md) | 9 | TWSE and TPEx securities, daily closes, valuation, institutional and margin data, revenue, statements and indices. |
| [Legal data](https://docs.aggre.org/api/data/legal.md) | 8 | Statutes, sanctions and exclusion lists, the Taiwan FSC news feed and Taiwan standard-form contracts. |
| [Health: openFDA](https://docs.aggre.org/api/data/health-openfda.md) | 40 | The 19 openFDA datasets (drug labels, NDC, approvals, shortages, recalls, device clearances and more). |
| [Health: registries and statistics](https://docs.aggre.org/api/data/health-registries.md) | 12 | EMA medicines, NPPES providers, ClinicalTrials.gov, FDA 510(k) summaries, WHO GHO and Eurostat mortality. |
| [On-chain data](https://docs.aggre.org/api/data/onchain.md) | 1 | Total value locked in DeFi protocols, by protocol and chain. |

## All routes

| Method | Path | Summary |
|---|---|---|
| `GET` | `/healthz` | [Liveness](https://docs.aggre.org/api/data/service.md#healthz) |
| `GET` | `/readyz` | [Readiness](https://docs.aggre.org/api/data/service.md#readyz) |
| `GET` | `/v1/datasets` | [The datasets and where to read them](https://docs.aggre.org/api/data/service.md#listDatasets) |
| `GET` | `/v1/whoami` | [The calling key and its usage](https://docs.aggre.org/api/data/service.md#whoami) |
| `GET` | `/v1/finance/market/candles_1m` | [Confirmed one-minute candles of one instrument](https://docs.aggre.org/api/data/market.md#candles1M) |
| `GET` | `/v1/finance/market/candles_1h` | [Confirmed one-hour candles of one instrument](https://docs.aggre.org/api/data/market.md#candles1H) |
| `GET` | `/v1/finance/market/candles_1d` | [Confirmed one-day candles of one instrument](https://docs.aggre.org/api/data/market.md#candles1D) |
| `GET` | `/v1/finance/market/funding_rates` | [Settled funding payments of a perpetual](https://docs.aggre.org/api/data/market.md#fundingRates) |
| `GET` | `/v1/finance/market/open_interest` | [Open-interest snapshots of a perpetual](https://docs.aggre.org/api/data/market.md#openInterest) |
| `GET` | `/v1/finance/market/instruments` | [The instrument list](https://docs.aggre.org/api/data/market.md#listInstruments) |
| `GET` | `/v1/finance/market/tickers` | [The latest ticker of every enabled instrument](https://docs.aggre.org/api/data/market.md#listTickers) |
| `GET` | `/v1/finance/macro/calendar_events` | [Scheduled economic releases](https://docs.aggre.org/api/data/macro.md#listCalendarEvents) |
| `GET` | `/v1/finance/macro/series` | [The macro series catalogue](https://docs.aggre.org/api/data/macro.md#listMacroSeries) |
| `GET` | `/v1/finance/macro/observations` | [Observations of one series](https://docs.aggre.org/api/data/macro.md#listMacroObservations) |
| `GET` | `/v1/finance/macro_derived/series` | [The computed macro series catalogue](https://docs.aggre.org/api/data/macro.md#listMacroDerivedSeries) |
| `GET` | `/v1/finance/macro_derived/observations` | [Computed values of one series](https://docs.aggre.org/api/data/macro.md#listMacroDerivedObservations) |
| `GET` | `/v1/finance/filings/companies` | [SEC companies on the coverage list](https://docs.aggre.org/api/data/filings.md#listFilingsCompanies) |
| `GET` | `/v1/finance/filings/filings` | [A company's filings](https://docs.aggre.org/api/data/filings.md#listFilings) |
| `GET` | `/v1/finance/filings/company_facts` | [As-filed XBRL facts of a company](https://docs.aggre.org/api/data/filings.md#listFilingsCompanyFacts) |
| `GET` | `/v1/finance/filings/fundamentals` | [Normalized fundamentals per fiscal period](https://docs.aggre.org/api/data/filings.md#listFilingsFundamentals) |
| `GET` | `/v1/finance/filings/insider_transactions` | [Form 4 insider transactions of an issuer](https://docs.aggre.org/api/data/filings.md#listFilingsInsiderTransactions) |
| `GET` | `/v1/finance/filings/fails_to_deliver` | [SEC fails-to-deliver balances of a symbol](https://docs.aggre.org/api/data/filings.md#listFilingsFailsToDeliver) |
| `GET` | `/v1/finance/filings/holdings_13f` | [SEC Form 13F holdings of a covered company](https://docs.aggre.org/api/data/filings.md#listFilingsHoldings13f) |
| `GET` | `/v1/finance/filings/news_8k` | [SEC 8-K current reports of a covered company, with the file names of their press releases](https://docs.aggre.org/api/data/filings.md#listFilingsNews8k) |
| `GET` | `/v1/finance/filings/congress_trades` | [Stock trades of US members of Congress (Periodic Transaction Reports)](https://docs.aggre.org/api/data/filings.md#listFilingsCongressTrades) |
| `GET` | `/v1/finance/equities_tw/securities` | [Taiwan listed and OTC securities](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwSecurities) |
| `GET` | `/v1/finance/equities_tw/daily_close` | [Daily close of Taiwan securities](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwDailyClose) |
| `GET` | `/v1/finance/equities_tw/valuation_daily` | [Daily valuation ratios of Taiwan securities](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwValuationDaily) |
| `GET` | `/v1/finance/equities_tw/institutional_daily` | [Institutional trades of TPEx securities](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwInstitutionalDaily) |
| `GET` | `/v1/finance/equities_tw/margin_daily` | [Margin balances of TPEx securities](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwMarginDaily) |
| `GET` | `/v1/finance/equities_tw/monthly_revenue` | [Monthly revenue of Taiwan companies](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwMonthlyRevenue) |
| `GET` | `/v1/finance/equities_tw/statements` | [Quarterly statements of Taiwan companies](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwStatements) |
| `GET` | `/v1/finance/equities_tw/indices` | [Index closes of Taiwan exchanges](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwIndices) |
| `GET` | `/v1/finance/equities_tw/sources` | [Registered upstream files of the Taiwan datasets](https://docs.aggre.org/api/data/equities-tw.md#listEquitiesTwSources) |
| `GET` | `/v1/legal/statutes/instruments` | [Statutes across the ten statute datasets](https://docs.aggre.org/api/data/legal.md#listStatuteInstruments) |
| `GET` | `/v1/legal/statutes/instruments/{instrument_id}` | [One statute with its provisions](https://docs.aggre.org/api/data/legal.md#getStatuteInstrument) |
| `GET` | `/v1/legal/statutes/instruments/{instrument_id}/provisions` | [The provisions of one statute, paged](https://docs.aggre.org/api/data/legal.md#listStatuteProvisions) |
| `GET` | `/v1/legal/regulatory/entries` | [Entries of a sanctions or exclusion list](https://docs.aggre.org/api/data/legal.md#listRegulatoryEntries) |
| `GET` | `/v1/legal/regulatory/entry` | [One entry of a sanctions or exclusion list](https://docs.aggre.org/api/data/legal.md#getRegulatoryEntry) |
| `GET` | `/v1/legal/regulatory/fsc_news` | [Taiwan FSC news (five RSS feeds)](https://docs.aggre.org/api/data/legal.md#listFscNews) |
| `GET` | `/v1/onchain/defi/protocol_tvl` | [DeFi protocol total value locked](https://docs.aggre.org/api/data/onchain.md#listOnchainProtocolTvl) |
| `GET` | `/v1/legal/contracts/tw_standard_forms` | [Taiwan standard-form contracts (定型化契約), without text](https://docs.aggre.org/api/data/legal.md#listContractForms) |
| `GET` | `/v1/legal/contracts/tw_standard_forms/{form_id}` | [One standard form with its versions and the text of its files](https://docs.aggre.org/api/data/legal.md#getContractForm) |
| `GET` | `/v1/health/drugs/ema_medicines` | [EMA medicines register](https://docs.aggre.org/api/data/health-registries.md#listEmaMedicines) |
| `GET` | `/v1/health/drugs/ema_medicines/{product_number}` | [One EMA medicine, with its text and source row](https://docs.aggre.org/api/data/health-registries.md#getEmaMedicine) |
| `GET` | `/v1/health/providers/nppes` | [Search the NPPES NPI Registry](https://docs.aggre.org/api/data/health-registries.md#searchNppesProviders) |
| `GET` | `/v1/health/providers/nppes/{npi}` | [One NPPES provider by NPI](https://docs.aggre.org/api/data/health-registries.md#getNppesProvider) |
| `GET` | `/v1/health/trials/clinicaltrials_gov` | [ClinicalTrials.gov studies](https://docs.aggre.org/api/data/health-registries.md#listTrialsStudies) |
| `GET` | `/v1/health/trials/clinicaltrials_gov/{nct_id}` | [One ClinicalTrials.gov study, with its prose](https://docs.aggre.org/api/data/health-registries.md#getTrialsStudy) |
| `GET` | `/v1/health/devices/fda_510k_summary` | [FDA 510(k) summary documents (extracted text)](https://docs.aggre.org/api/data/health-openfda.md#listFdaSummaries) |
| `GET` | `/v1/health/devices/fda_510k_summary/{k_number}` | [One 510(k) summary, with its text](https://docs.aggre.org/api/data/health-openfda.md#getFdaSummary) |
| `GET` | `/v1/health/drugs/fda_label` | [openFDA drug labels (prescribing information)](https://docs.aggre.org/api/data/health-openfda.md#listFdaLabel) |
| `GET` | `/v1/health/drugs/fda_label/{key}` | [One record of: openFDA drug labels (prescribing information)](https://docs.aggre.org/api/data/health-openfda.md#getFdaLabel) |
| `GET` | `/v1/health/drugs/fda_ndc` | [openFDA National Drug Code directory](https://docs.aggre.org/api/data/health-openfda.md#listFdaNdc) |
| `GET` | `/v1/health/drugs/fda_ndc/{key}` | [One record of: openFDA National Drug Code directory](https://docs.aggre.org/api/data/health-openfda.md#getFdaNdc) |
| `GET` | `/v1/health/drugs/fda_drugsfda` | [openFDA Drugs@FDA approvals](https://docs.aggre.org/api/data/health-openfda.md#listFdaDrugsfda) |
| `GET` | `/v1/health/drugs/fda_drugsfda/{key}` | [One record of: openFDA Drugs@FDA approvals](https://docs.aggre.org/api/data/health-openfda.md#getFdaDrugsfda) |
| `GET` | `/v1/health/drugs/fda_orangebook` | [openFDA Orange Book](https://docs.aggre.org/api/data/health-openfda.md#listFdaOrangebook) |
| `GET` | `/v1/health/drugs/fda_orangebook/{key}` | [One record of: openFDA Orange Book](https://docs.aggre.org/api/data/health-openfda.md#getFdaOrangebook) |
| `GET` | `/v1/health/drugs/fda_shortages` | [openFDA drug shortages](https://docs.aggre.org/api/data/health-openfda.md#listFdaShortages) |
| `GET` | `/v1/health/drugs/fda_shortages/{key}` | [One record of: openFDA drug shortages](https://docs.aggre.org/api/data/health-openfda.md#getFdaShortages) |
| `GET` | `/v1/health/drugs/fda_nsde` | [openFDA NDC SPL data elements (NSDE)](https://docs.aggre.org/api/data/health-openfda.md#listFdaNsde) |
| `GET` | `/v1/health/drugs/fda_nsde/{key}` | [One record of: openFDA NDC SPL data elements (NSDE)](https://docs.aggre.org/api/data/health-openfda.md#getFdaNsde) |
| `GET` | `/v1/health/drugs/fda_unii` | [openFDA UNII substance identifiers](https://docs.aggre.org/api/data/health-openfda.md#listFdaUnii) |
| `GET` | `/v1/health/drugs/fda_unii/{key}` | [One record of: openFDA UNII substance identifiers](https://docs.aggre.org/api/data/health-openfda.md#getFdaUnii) |
| `GET` | `/v1/health/drugs/fda_substance` | [openFDA substance data](https://docs.aggre.org/api/data/health-openfda.md#listFdaSubstance) |
| `GET` | `/v1/health/drugs/fda_substance/{key}` | [One record of: openFDA substance data](https://docs.aggre.org/api/data/health-openfda.md#getFdaSubstance) |
| `GET` | `/v1/health/drugs/fda_historicaldocument` | [openFDA historical documents](https://docs.aggre.org/api/data/health-openfda.md#listFdaHistoricaldocument) |
| `GET` | `/v1/health/drugs/fda_historicaldocument/{key}` | [One record of: openFDA historical documents](https://docs.aggre.org/api/data/health-openfda.md#getFdaHistoricaldocument) |
| `GET` | `/v1/health/drugs/fda_enforcement` | [openFDA drug enforcement reports (recalls)](https://docs.aggre.org/api/data/health-openfda.md#listFdaEnforcement) |
| `GET` | `/v1/health/drugs/fda_enforcement/{key}` | [One record of: openFDA drug enforcement reports (recalls)](https://docs.aggre.org/api/data/health-openfda.md#getFdaEnforcement) |
| `GET` | `/v1/health/drugs/fda_crl` | [openFDA complete response letters](https://docs.aggre.org/api/data/health-openfda.md#listFdaCrl) |
| `GET` | `/v1/health/drugs/fda_crl/{key}` | [One record of: openFDA complete response letters](https://docs.aggre.org/api/data/health-openfda.md#getFdaCrl) |
| `GET` | `/v1/health/devices/fda_510k` | [openFDA 510(k) clearances](https://docs.aggre.org/api/data/health-openfda.md#listFda510k) |
| `GET` | `/v1/health/devices/fda_510k/{key}` | [One record of: openFDA 510(k) clearances](https://docs.aggre.org/api/data/health-openfda.md#getFda510k) |
| `GET` | `/v1/health/devices/fda_pma` | [openFDA premarket approvals (PMA)](https://docs.aggre.org/api/data/health-openfda.md#listFdaPma) |
| `GET` | `/v1/health/devices/fda_pma/{key}` | [One record of: openFDA premarket approvals (PMA)](https://docs.aggre.org/api/data/health-openfda.md#getFdaPma) |
| `GET` | `/v1/health/devices/fda_classification` | [openFDA device classification](https://docs.aggre.org/api/data/health-openfda.md#listFdaClassification) |
| `GET` | `/v1/health/devices/fda_classification/{key}` | [One record of: openFDA device classification](https://docs.aggre.org/api/data/health-openfda.md#getFdaClassification) |
| `GET` | `/v1/health/devices/fda_udi` | [openFDA unique device identifiers (UDI)](https://docs.aggre.org/api/data/health-openfda.md#listFdaUdi) |
| `GET` | `/v1/health/devices/fda_udi/{key}` | [One record of: openFDA unique device identifiers (UDI)](https://docs.aggre.org/api/data/health-openfda.md#getFdaUdi) |
| `GET` | `/v1/health/devices/fda_registrationlisting` | [openFDA device registration and listing](https://docs.aggre.org/api/data/health-openfda.md#listFdaRegistrationlisting) |
| `GET` | `/v1/health/devices/fda_registrationlisting/{key}` | [One record of: openFDA device registration and listing](https://docs.aggre.org/api/data/health-openfda.md#getFdaRegistrationlisting) |
| `GET` | `/v1/health/devices/fda_covid19serology` | [openFDA COVID-19 serology tests](https://docs.aggre.org/api/data/health-openfda.md#listFdaCovid19serology) |
| `GET` | `/v1/health/devices/fda_covid19serology/{key}` | [One record of: openFDA COVID-19 serology tests](https://docs.aggre.org/api/data/health-openfda.md#getFdaCovid19serology) |
| `GET` | `/v1/health/devices/fda_recall` | [openFDA device recalls](https://docs.aggre.org/api/data/health-openfda.md#listFdaRecall) |
| `GET` | `/v1/health/devices/fda_recall/{key}` | [One record of: openFDA device recalls](https://docs.aggre.org/api/data/health-openfda.md#getFdaRecall) |
| `GET` | `/v1/health/devices/fda_device_enforcement` | [openFDA device enforcement reports](https://docs.aggre.org/api/data/health-openfda.md#listFdaDeviceEnforcement) |
| `GET` | `/v1/health/devices/fda_device_enforcement/{key}` | [One record of: openFDA device enforcement reports](https://docs.aggre.org/api/data/health-openfda.md#getFdaDeviceEnforcement) |
| `GET` | `/v1/health/statistics/who_gho` | [WHO Global Health Observatory observations of one indicator](https://docs.aggre.org/api/data/health-registries.md#listWhoObservations) |
| `GET` | `/v1/health/statistics/who_gho/indicators` | [The curated WHO GHO indicators](https://docs.aggre.org/api/data/health-registries.md#listWhoIndicators) |
| `GET` | `/v1/health/statistics/eurostat_mortality` | [Eurostat causes of death, cells of one cause](https://docs.aggre.org/api/data/health-registries.md#listEurostatMortality) |
| `GET` | `/v1/health/statistics/eurostat_mortality/causes` | [Cause codes in the Eurostat table](https://docs.aggre.org/api/data/health-registries.md#listEurostatCauses) |
| `GET` | `/v1/health/statistics/eurostat_mortality/places` | [Place codes in the Eurostat table](https://docs.aggre.org/api/data/health-registries.md#listEurostatPlaces) |
| `GET` | `/v1/health/statistics/eurostat_mortality/{year}/{geo}/{icd10}` | [One Eurostat cell](https://docs.aggre.org/api/data/health-registries.md#getEurostatMortality) |