Skip to content
Aggre Docs

Loading…

Console

API reference

Data API

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

View as Markdown

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.

This reference is generated from the OpenAPI file (/openapi/data.yaml, also as JSON), so it lists exactly the routes the service registers. Row shapes are the JSON Schemas in the schema reference.

Rules that apply to every route are in Concepts: the response envelope, strict query parameters, opaque cursors, freshness (meta.status), attribution (credit) and the shared error codes.

Pages#

PageRoutesCovers
Service routes4Health checks, the dataset list and the calling key.
Market data7Candles, funding rates, open interest, instruments and the latest tickers.
Macro data5The economic calendar, official macro series and their observations, and derived series.
Filings and trades (SEC EDGAR, US Congress)9Companies, filings, XBRL facts, fundamentals, insider transactions, fails-to-deliver, 13F holdings, 8-K news and Congress trades.
Taiwan equities9TWSE and TPEx securities, daily closes, valuation, institutional and margin data, revenue, statements and indices.
Legal data8Statutes, sanctions and exclusion lists, the Taiwan FSC news feed and Taiwan standard-form contracts.
Health: openFDA40The 19 openFDA datasets (drug labels, NDC, approvals, shortages, recalls, device clearances and more).
Health: registries and statistics12EMA medicines, NPPES providers, ClinicalTrials.gov, FDA 510(k) summaries, WHO GHO and Eurostat mortality.
On-chain data1Total value locked in DeFi protocols, by protocol and chain.

All routes#

MethodPathSummary
GET/healthzLiveness
GET/readyzReadiness
GET/v1/datasetsThe datasets and where to read them
GET/v1/whoamiThe calling key and its usage
GET/v1/finance/market/candles_1mConfirmed one-minute candles of one instrument
GET/v1/finance/market/candles_1hConfirmed one-hour candles of one instrument
GET/v1/finance/market/candles_1dConfirmed one-day candles of one instrument
GET/v1/finance/market/funding_ratesSettled funding payments of a perpetual
GET/v1/finance/market/open_interestOpen-interest snapshots of a perpetual
GET/v1/finance/market/instrumentsThe instrument list
GET/v1/finance/market/tickersThe latest ticker of every enabled instrument
GET/v1/finance/macro/calendar_eventsScheduled economic releases
GET/v1/finance/macro/seriesThe macro series catalogue
GET/v1/finance/macro/observationsObservations of one series
GET/v1/finance/macro_derived/seriesThe computed macro series catalogue
GET/v1/finance/macro_derived/observationsComputed values of one series
GET/v1/finance/filings/companiesSEC companies on the coverage list
GET/v1/finance/filings/filingsA company's filings
GET/v1/finance/filings/company_factsAs-filed XBRL facts of a company
GET/v1/finance/filings/fundamentalsNormalized fundamentals per fiscal period
GET/v1/finance/filings/insider_transactionsForm 4 insider transactions of an issuer
GET/v1/finance/filings/fails_to_deliverSEC fails-to-deliver balances of a symbol
GET/v1/finance/filings/holdings_13fSEC Form 13F holdings of a covered company
GET/v1/finance/filings/news_8kSEC 8-K current reports of a covered company, with the file names of their press releases
GET/v1/finance/filings/congress_tradesStock trades of US members of Congress (Periodic Transaction Reports)
GET/v1/finance/equities_tw/securitiesTaiwan listed and OTC securities
GET/v1/finance/equities_tw/daily_closeDaily close of Taiwan securities
GET/v1/finance/equities_tw/valuation_dailyDaily valuation ratios of Taiwan securities
GET/v1/finance/equities_tw/institutional_dailyInstitutional trades of TPEx securities
GET/v1/finance/equities_tw/margin_dailyMargin balances of TPEx securities
GET/v1/finance/equities_tw/monthly_revenueMonthly revenue of Taiwan companies
GET/v1/finance/equities_tw/statementsQuarterly statements of Taiwan companies
GET/v1/finance/equities_tw/indicesIndex closes of Taiwan exchanges
GET/v1/finance/equities_tw/sourcesRegistered upstream files of the Taiwan datasets
GET/v1/legal/statutes/instrumentsStatutes across the ten statute datasets
GET/v1/legal/statutes/instruments/{instrument_id}One statute with its provisions
GET/v1/legal/statutes/instruments/{instrument_id}/provisionsThe provisions of one statute, paged
GET/v1/legal/regulatory/entriesEntries of a sanctions or exclusion list
GET/v1/legal/regulatory/entryOne entry of a sanctions or exclusion list
GET/v1/legal/regulatory/fsc_newsTaiwan FSC news (five RSS feeds)
GET/v1/onchain/defi/protocol_tvlDeFi protocol total value locked
GET/v1/legal/contracts/tw_standard_formsTaiwan standard-form contracts (定型化契約), without text
GET/v1/legal/contracts/tw_standard_forms/{form_id}One standard form with its versions and the text of its files
GET/v1/health/drugs/ema_medicinesEMA medicines register
GET/v1/health/drugs/ema_medicines/{product_number}One EMA medicine, with its text and source row
GET/v1/health/providers/nppesSearch the NPPES NPI Registry
GET/v1/health/providers/nppes/{npi}One NPPES provider by NPI
GET/v1/health/trials/clinicaltrials_govClinicalTrials.gov studies
GET/v1/health/trials/clinicaltrials_gov/{nct_id}One ClinicalTrials.gov study, with its prose
GET/v1/health/devices/fda_510k_summaryFDA 510(k) summary documents (extracted text)
GET/v1/health/devices/fda_510k_summary/{k_number}One 510(k) summary, with its text
GET/v1/health/drugs/fda_labelopenFDA drug labels (prescribing information)
GET/v1/health/drugs/fda_label/{key}One record of: openFDA drug labels (prescribing information)
GET/v1/health/drugs/fda_ndcopenFDA National Drug Code directory
GET/v1/health/drugs/fda_ndc/{key}One record of: openFDA National Drug Code directory
GET/v1/health/drugs/fda_drugsfdaopenFDA Drugs@FDA approvals
GET/v1/health/drugs/fda_drugsfda/{key}One record of: openFDA Drugs@FDA approvals
GET/v1/health/drugs/fda_orangebookopenFDA Orange Book
GET/v1/health/drugs/fda_orangebook/{key}One record of: openFDA Orange Book
GET/v1/health/drugs/fda_shortagesopenFDA drug shortages
GET/v1/health/drugs/fda_shortages/{key}One record of: openFDA drug shortages
GET/v1/health/drugs/fda_nsdeopenFDA NDC SPL data elements (NSDE)
GET/v1/health/drugs/fda_nsde/{key}One record of: openFDA NDC SPL data elements (NSDE)
GET/v1/health/drugs/fda_uniiopenFDA UNII substance identifiers
GET/v1/health/drugs/fda_unii/{key}One record of: openFDA UNII substance identifiers
GET/v1/health/drugs/fda_substanceopenFDA substance data
GET/v1/health/drugs/fda_substance/{key}One record of: openFDA substance data
GET/v1/health/drugs/fda_historicaldocumentopenFDA historical documents
GET/v1/health/drugs/fda_historicaldocument/{key}One record of: openFDA historical documents
GET/v1/health/drugs/fda_enforcementopenFDA drug enforcement reports (recalls)
GET/v1/health/drugs/fda_enforcement/{key}One record of: openFDA drug enforcement reports (recalls)
GET/v1/health/drugs/fda_crlopenFDA complete response letters
GET/v1/health/drugs/fda_crl/{key}One record of: openFDA complete response letters
GET/v1/health/devices/fda_510kopenFDA 510(k) clearances
GET/v1/health/devices/fda_510k/{key}One record of: openFDA 510(k) clearances
GET/v1/health/devices/fda_pmaopenFDA premarket approvals (PMA)
GET/v1/health/devices/fda_pma/{key}One record of: openFDA premarket approvals (PMA)
GET/v1/health/devices/fda_classificationopenFDA device classification
GET/v1/health/devices/fda_classification/{key}One record of: openFDA device classification
GET/v1/health/devices/fda_udiopenFDA unique device identifiers (UDI)
GET/v1/health/devices/fda_udi/{key}One record of: openFDA unique device identifiers (UDI)
GET/v1/health/devices/fda_registrationlistingopenFDA device registration and listing
GET/v1/health/devices/fda_registrationlisting/{key}One record of: openFDA device registration and listing
GET/v1/health/devices/fda_covid19serologyopenFDA COVID-19 serology tests
GET/v1/health/devices/fda_covid19serology/{key}One record of: openFDA COVID-19 serology tests
GET/v1/health/devices/fda_recallopenFDA device recalls
GET/v1/health/devices/fda_recall/{key}One record of: openFDA device recalls
GET/v1/health/devices/fda_device_enforcementopenFDA device enforcement reports
GET/v1/health/devices/fda_device_enforcement/{key}One record of: openFDA device enforcement reports
GET/v1/health/statistics/who_ghoWHO Global Health Observatory observations of one indicator
GET/v1/health/statistics/who_gho/indicatorsThe curated WHO GHO indicators
GET/v1/health/statistics/eurostat_mortalityEurostat causes of death, cells of one cause
GET/v1/health/statistics/eurostat_mortality/causesCause codes in the Eurostat table
GET/v1/health/statistics/eurostat_mortality/placesPlace codes in the Eurostat table
GET/v1/health/statistics/eurostat_mortality/{year}/{geo}/{icd10}One Eurostat cell

Generated from contracts/data.openapi.yaml when the site is built, so it matches the API contract.