English

Python SDK

Install:

pip install agentdata

(During the private beta, if we ship you a wheel directly, just pip install that file.) Pure standard library (Python 3.10+), zero third-party dependencies. Per-area sub-objects hang off Client: c.company.*, c.healthcare.*, c.esg.*, c.legal.*, c.research.*, c.security.*, c.procurement.*.

Quick start

from agentdata import Client

c = Client()                                  # zero config: realtime queries (local execution) work immediately
c.company.gleif_lei_records_search(filter_entity_legal_name="Siemens", page_size=3)   # realtime, zero config
c.healthcare.rxnav_rxcui_by_name(name="atorvastatin")
c.healthcare.ctgov_studies(filter_advanced='AREA[LeadSponsorName]("AstraZeneca") AND AREA[OverallStatus](RECRUITING)', page_size=3)

c2 = Client(base_url="https://…", api_key="mk_live_…")  # corpus queries: hosted API (PAT from us)
c2.company.search(filters={"company_registration_country": "US"}, limit=5)

Method overview

Method	Applies to	Description
`afdb_debarred_entities(self, name=None, *, type=None, basis=None, limit=20, execution=None, no_cache=None)`	legal	legal afdb_debarred_entities: African Development Bank debarment register (afdb.org json-feed,
`au_tga_artg(self, *, query=None, limit=20, skip=0, execution=None, no_cache=None)`	healthcare	healthcare au_tga_artg: search of the AU ARTG register (the TGA eBS Domino face;
`au_tga_manufacturers(self, *, state=None, limit=100, execution=None, no_cache=None)`	healthcare	healthcare au_tga_manufacturers: the AU manufacturer licence register (MIS: 444 licences in one full shot + a state filter; limit ≤500 is the upstream single-page hard limit).
`biorxiv_details(self, *, from_date=None, to_date=None, cursor=0, execution=None, no_cache=None)`	research	research biorxiv_details: bioRxiv preprint interval metadata stream
`bis_sdmx_series(self, *, flow=None, key=None, start=None, end=None, execution=None, no_cache=None)`	economy	economy bis_sdmx_series: one BIS dataflow series (/api/v1/data/{flow}/{key}/all, the
`bls_series(self, *, series=None, start_year=None, end_year=None, execution=None, no_cache=None)`	economy	economy bls_series: BLS v2 series observations (POST /publicAPI/v2/timeseries/data/
`br_pncp_contracts(self, data_inicial, data_final, *, pagina=1, cnpj_orgao=None, execution=None, no_cache=None)`	procurement	procurement br_pncp_contracts: Brazil national procurement contract window
`ca_dpd_companies(self, *, limit=200, skip=0, execution=None, no_cache=None)`	healthcare	healthcare ca_dpd_companies: the Health Canada DPD company register, one full shot
`ca_dpd_drug_products(self, *, status, limit=200, skip=0, execution=None, no_cache=None)`	healthcare	healthcare ca_dpd_drug_products: DPD drug products by market status — status is the Read Me
`ca_mdall_companies(self, *, limit=200, skip=0, execution=None, no_cache=None)`	healthcare	healthcare ca_mdall_companies: the Health Canada MDALL company register, one full shot
`ca_mdall_licence(self, *, licence_id, licence_type='active', lang='eng', execution=None, no_cache=None)`	healthcare	healthcare ca_mdall_licence: the MDALL single-licence dossier (the LIMH information page —
`ca_sema_sanctions(self, name=None, *, country=None, limit=20, execution=None, no_cache=None)`	legal	legal ca_sema_sanctions: Canada SEMA sanctions listings (Global Affairs Canada sema-lmes.xml,
`ch_zefix_firm(self, *, ehraid, execution=None, no_cache=None)`	company	company ch_zefix_firm: full record card by ehraid (Zefix /firm/{ehraid}.json; oldNames + M&A edges).
`ch_zefix_firm_search(self, *, name, max_entries=100, offset=0, execution=None, no_cache=None)`	company	company ch_zefix_firm_search: Swiss commercial register name search (Zefix POST search.json three params
`cisa_kev_catalog(self, *, cve=None, ransomware=None, limit=50, execution=None, no_cache=None)`	security	security cisa_kev_catalog: the CISA catalog of vulnerabilities exploited in the wild (static feed
`climatetrace_owners(self, *, name, limit=10, offset=None, execution=None, no_cache=None)`	esg	esg climatetrace_owners: emissions-owner candidates (Climate TRACE v7 owners;
`climatetrace_sources(self, *, owner_ids=None, owner_name=None, year=None, gas=None, limit=50, offset=None, sectors=None, subsectors=None, gadm_id=None, city_id=None, country_group=None, continent=None, execution=None, no_cache=None)`	esg	esg climatetrace_sources: emissions-owner -> facility/aggregate emission rows (Climate TRACE v7 sources;
`co_rues_companies(self, where=None, *, limit=20, offset=0, order=None, execution=None, no_cache=None)`	company	company co_rues_companies: Colombia RUES commercial-registry master (datos.gov.co Socrata c82u-588k;
`co_secop_contracts(self, where=None, *, limit=20, offset=0, order=None, execution=None, no_cache=None)`	procurement	procurement co_secop_contracts: Colombia SECOP II electronic contracts (datos.gov.co
`co_sic_sanctions(self, where=None, *, limit=20, offset=0, order=None, execution=None, no_cache=None)`	legal	legal co_sic_sanctions: Colombia SIC firm-sanctions register (datos.gov.co Socrata 73dx-n59j, keyless):
`comext_flows(self, *, reporter=None, partner=None, product=None, flow=None, indicators=None, time=None, since=None, until=None, execution=None, no_cache=None)`	economy	economy comext_flows: Eurostat Comext annual HS2-4-6 trade mirror since 2002 (the
`courtlistener_opinions_search(self, *, q=None, case_name=None, court=None, judge=None, docket_number=None, filed_after=None, filed_before=None, order_by=None, cursor=None, execution=None, no_cache=None)`	legal	legal courtlistener_opinions_search: US federal + state case-law search (Search API v4, anonymous and
`crossref_works(self, *, query=None, funder=None, award_number=None, rows=25, offset=0, cursor=None, from_pub_date=None, to_pub_date=None, execution=None, no_cache=None)`	research	research crossref_works: DOI registry paper search (/works verbatim name; query
`csl_screening_list(self, name=None, *, value=None, source=None, type=None, limit=20, execution=None, no_cache=None)`	legal	US Consolidated Screening List name screening (realtime, local execution): 12 list families
`ctgov_studies(self, *, query_term=None, query_titles=None, query_intr=None, query_cond=None, filter_advanced=None, agg_filters=None, fields=None, page_size=20, page_token=None, sort=None, count_total=True, execution=None, no_cache=None)`	healthcare	healthcare ctgov_studies: clinical-trial search (CT.gov v2; query_term is the query.term verbatim channel,
`dailymed_spls(self, *, search=None, manufacturer=None, setid=None, page=None, pagesize=None, sort=None, execution=None, no_cache=None)`	healthcare	healthcare dailymed_spls: SPL labeling metadata (the six DailyMed spls.json params under their upstream names;
`dgcomp_cases_search(self, query=None, *, name=None, instrument=None, text='', limit=20, page=1, execution=None, no_cache=None)`	legal	legal dgcomp_cases_search: EU competition cases (DG COMP webgate ES; query = the bare DSL
`ecb_fx_rates(self, *, currency=None, start=None, end=None, execution=None, no_cache=None)`	economy	economy ecb_fx_rates: the ECB euro reference rate for one currency
`ecfr_search(self, q=None, *, query=None, value=None, page=1, limit=20, date=None, execution=None, no_cache=None)`	legal	eCFR current-code section search (keyless): where a topic lives in the codified
`ecfr_titles(self, *, execution=None, no_cache=None)`	legal	eCFR title catalog (keyless): the 50 CFR titles with latest_amended_on /
`eiti_companies(self, *, company_name__like=None, name=None, size=10, execution=None, no_cache=None)`	esg	esg eiti_companies: extractives filer company candidates (EITI Datasette view_companies;
`eiti_payments(self, *, eiti_id_company__exact=None, eiti_id=None, company_name__like=None, name=None, size=50, execution=None, no_cache=None)`	esg	esg eiti_payments: company->government payment rows (EITI view_payments_detailed;
`epa_frs_facilities(self, *, registry_id=None, primary_name=None, state_code=None, city_name=None, country_name=None, site_type_name=None, epa_region_code=None, start=0, size=50, execution=None, no_cache=None)`	esg	esg epa_frs_facilities: FRS facility master point query (Envirofacts efservice frs_facility_site;
`epmc_search(self, , search=None, result_type='lite', page_size=25, cursor_mark='', sort=None, execution=None, no_cache=None)`	healthcare	healthcare epmc_search: literature evidence search (Europe PMC; search=query is the verbatim param channel, AFF: for affiliation search).
`euasl_datasets(self, *, execution=None, no_cache=None)`	esg	esg euasl_datasets: EU Air Safety List download catalog (banned/restricted third-country air
`eudamed_devices_udi_di_data(self, *, primary_di, page=0, page_size=5, iso2_code='en', execution=None, no_cache=None)`	healthcare	healthcare eudamed_devices_udi_di_data: the EU device master record (an EUDAMED primaryDi exact lookup + paging under the upstream names page/pageSize/iso2Code).
`eurostat_table(self, *, table=None, geo=None, time=None, dims=None, since=None, until=None, lang='EN', execution=None, no_cache=None)`	economy	economy eurostat_table: one Eurostat table through the filters you give
`eutl_datasets(self, *, execution=None, no_cache=None)`	esg	esg eutl_datasets: EU carbon registry official bulk-download catalog (EUTL data-download;
`euvd_exploited(self, *, limit=50, execution=None, no_cache=None)`	security	security euvd_exploited: the ENISA EU KEV rolling window — vulnerabilities currently
`euvd_vulnerability(self, *, id, execution=None, no_cache=None)`	security	security euvd_vulnerability: ENISA EUVD point lookup by CVE or EUVD code (the real API
`fda_crl_letters(self, *, search=None, limit=20, skip=0, sort='letter_date:desc', execution=None, no_cache=None)`	healthcare	healthcare fda_crl_letters: FDA Complete Response Letters (openFDA transparency/crl;
`fda_device_510k(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_device_510k: device premarket notification 510(k) (openFDA device/510k; applicant finds the company
`fda_device_classification(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_device_classification: the device product-code taxonomy face (openFDA device/classification;
`fda_device_pma(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_device_pma: device premarket approval PMA (openFDA device/pma; applicant finds the company;
`fda_device_recalls(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_device_recalls: FDA device recalls (openFDA device/recall = the RES system;
`fda_device_registrations(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_device_registrations: the device establishment register (openFDA device/registrationlisting;
`fda_drug_approvals(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_drug_approvals: FDA drug application/approval dossiers (openFDA drug/drugsfda;
`fda_drug_catalog(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_drug_catalog: the NDC catalogue (openFDA drug/ndc; labeler_name finds the labeler;
`fda_drug_recalls(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_drug_recalls: FDA drug recalls (openFDA drug/enforcement;
`fda_drug_shortages(self, *, search=None, limit=20, skip=0, sort='update_date:desc', execution=None, no_cache=None)`	healthcare	healthcare fda_drug_shortages: a single lookup of FDA drug shortages (openFDA;
`fda_food_recalls(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_food_recalls: FDA food recalls (openFDA food/enforcement;
`fda_orangebook(self, *, search=None, limit=20, skip=0, sort=None, execution=None, no_cache=None)`	healthcare	healthcare fda_orangebook: Orange Book approved drugs (the openFDA drug/orangebook API face;
`fdic_institutions(self, *, search=None, filters=None, limit=5, execution=None, no_cache=None)`	company	company fdic_institutions: US insured-bank master lookup (api.fdic.gov /banks/institutions;
`federalregister_documents(self, q, *, startdt=None, enddt=None, order='relevance', page=1, limit=20, doc_type=None, agencies=None, cfr_title=None, cfr_part=None, execution=None, no_cache=None)`	legal	legal federalregister_documents: search over the federal regulation/notice daily release stream
`fi_ytj_companies(self, *, name=None, business_id=None, execution=None, no_cache=None)`	company	company fi_ytj_companies: Finnish YTJ business master (PRH v3 one endpoint, two lookups; name search face
`fr_recherche_search(self, *, q, page=None, per_page=10, etat_administratif=None, execution=None, no_cache=None)`	company	company fr_recherche_search: French annuaire-entreprises official aggregate search (q takes name/officer
`fred_series(self, *, series=None, start=None, end=None, execution=None, no_cache=None)`	economy	economy fred_series: one FRED series over a date window (/fredgraph.csv?id=;
`gb_cma_case(self, slug, *, execution=None, no_cache=None)`	legal	legal gb_cma_case: the full UK CMA single-case dossier (gov.uk content API; content_id = the UUID
`gb_cma_cases(self, q=None, *, count=20, start=0, execution=None, no_cache=None)`	legal	legal gb_cma_cases: UK CMA case search (gov.uk search API, filter_format=cma_case fixed;
`gb_contracts_finder_published_notices(self, *, name=None, published_from=None, published_to=None, stages=None, limit=10, cursor=None, execution=None, no_cache=None)`	company	company gb_contracts_finder_published_notices: UK below-threshold small contracts (CF OCDS params verbatim;
`gb_ec_donations(self, query, *, from_=None, to=None, limit=20, start=None, execution=None, no_cache=None)`	legal	legal gb_ec_donations: UK political donations (the UK EC /donations single-endpoint face; query goes
`gb_ec_loans(self, query, *, limit=20, start=None, execution=None, no_cache=None)`	legal	legal gb_ec_loans: UK political loans (the UK EC /loans single-endpoint face; the upstream loans
`gb_fts_release_packages(self, *, name=None, stages='award', limit=10, cursor=None, updated_from=None, updated_to=None, execution=None, no_cache=None)`	company	company gb_fts_release_packages: UK WTO-line procurement (FTS OCDS five params verbatim;
`gb_gazette_notices(self, text=None, *, noticetypes=None, insolvency=None, start_date=None, end_date=None, page=1, page_size=20, sort=None, execution=None, no_cache=None)`	legal	legal gb_gazette_notices: The Gazette notice search (thegazette.co.uk data.json, keyless,
`gb_gtr_projects(self, *, q=None, s=20, p=1, execution=None, no_cache=None)`	research	research gb_gtr_projects: UK UKRI funded-project search (/projects?q= verbatim three
`gb_mhra_alert(self, slug, *, execution=None, no_cache=None)`	healthcare	healthcare gb_mhra_alert: the full UK MHRA single-alert dossier (gov.uk content API; content_id =
`gb_mhra_alerts(self, q=None, *, count=20, start=0, execution=None, no_cache=None)`	healthcare	healthcare gb_mhra_alerts: UK MHRA safety-alert search (gov.uk search API, filter_format=
`gb_tna_caselaw_judgment(self, document_uri, *, execution=None, no_cache=None)`	legal	legal gb_tna_caselaw_judgment: the full UK single-judgment dossier (Akoma Ntoso data.xml;
`gb_tna_caselaw_search(self, query=None, *, court=None, tribunal=None, party=None, judge=None, order=None, page=1, per_page=50, minimum_availability=None, execution=None, no_cache=None)`	legal	legal gb_tna_caselaw_search: UK judgment search (TNA Find Case Law /atom.xml; party/judge = whole-word
`gleif_direct_parent(self, *, lei, execution=None, no_cache=None)`	company	company gleif_direct_parent: LEI → direct parent (GLEIF /lei-records/{lei}/direct-parent dedicated endpoint).
`gleif_lei_records(self, *, lei, execution=None, no_cache=None)`	company	company gleif_lei_records: LEI → entity identity card (GLEIF /lei-records/{lei} single-record face; ISO 17442 20-char
`gleif_lei_records_search(self, *, filter_entity_legal_name, page_size=10, filter_entity_jurisdiction=None, filter_entity_status=None, page_number=None, execution=None, no_cache=None)`	company	company gleif_lei_records_search: company name → LEI candidates (GLEIF filter[entity.legalName] contains match;
`gleif_ultimate_parent(self, *, lei, execution=None, no_cache=None)`	company	company gleif_ultimate_parent: LEI → ultimate parent (GLEIF /lei-records/{lei}/ultimate-parent dedicated endpoint).
`gudid_devices(self, *, di=None, udi=None, record_key=None, execution=None, no_cache=None)`	healthcare	healthcare gudid_devices: the US device master record (AccessGUDID v3, a single endpoint with exactly one of di/udi/record_key).
`icite_pubs(self, *, pmid=None, execution=None, no_cache=None)`	research	research icite_pubs: PubMed paper citation-impact card (/pubs?pmids= query-parameter
`idb_debarred_entities(self, q=None, *, filters=None, limit=20, offset=0, sort=None, execution=None, no_cache=None)`	legal	legal idb_debarred_entities: Inter-American Development Bank sanctioned-firms register
`ie_revenue_defaulters(self, part=None, *, year=None, month=None, execution=None, no_cache=None)`	legal	legal ie_revenue_defaulters: Irish Revenue List of Defaulters (revenue.ie, keyless; the
`ilo_stat_indicator(self, *, indicator=None, ref_area=None, time_from=None, time_until=None, sex=None, classif=None, source=None, execution=None, no_cache=None)`	economy	economy ilo_stat_indicator: one ILOSTAT indicator for one country
`imf_sdmx_series(self, *, flow=None, country=None, indicator=None, frequency=None, start=None, end=None, execution=None, no_cache=None)`	economy	economy imf_sdmx_series: one IMF dataflow series (/external/sdmx/2.1/data/{flow}/
`kr_hometax_biz_status(self, *, biz_no, execution=None, no_cache=None)`	company	company kr_hometax_biz_status: Korea NTA business-registration-status single-shot (í´í¬ì
`lda_filings(self, client_name=None, registrant_name=None, filing_year=None, *, limit=20, page=None, ordering='-dt_posted', execution=None, no_cache=None)`	legal	legal lda_filings: US lobbying filings (LDA DRF; client_name/registrant_name/filing_year/
`mesh_descriptor(self, *, label, match='contains', limit=10, execution=None, no_cache=None)`	healthcare	healthcare mesh_descriptor: drug/disease term → MeSH descriptor candidates + the preferred record's synonym pool (the upstream names label/match/limit;
`nih_reporter_projects(self, *, org_name=None, fiscal_year=None, include_fields=None, limit=25, offset=0, execution=None, no_cache=None)`	research	research nih_reporter_projects: NIH funded-project search (/v2/projects/search POST;
`nih_reporter_publications(self, *, pmids=None, appl_ids=None, limit=25, offset=0, execution=None, no_cache=None)`	research	research nih_reporter_publications: NIH funding↔paper bridge table
`no_brreg_enheter(self, *, navn=None, organisasjonsnummer=None, page=0, size=20, execution=None, no_cache=None)`	company	company no_brreg_enheter: Norwegian registry master record (Enhetsregisteret; navn search face XOR org-number
`no_brreg_roller(self, *, organisasjonsnummer, execution=None, no_cache=None)`	company	company no_brreg_roller: org number → roles face (Enhetsregisteret /roller; DAGL CEO / STYR board /
`nsf_awards(self, *, keyword=None, id=None, rpp=25, offset=0, execution=None, no_cache=None)`	research	research nsf_awards: NSF funding search (awards.json verbatim four params; keyword
`ny_abo_contracts(self, where=None, *, limit=20, offset=0, order=None, execution=None, no_cache=None)`	procurement	procurement ny_abo_contracts: New York State authority contracts (data.ny.gov Socrata ehig-g5x3;
`ny_mta_procurements(self, where=None, *, limit=20, offset=0, order=None, execution=None, no_cache=None)`	procurement	procurement ny_mta_procurements: New York MTA procurements (data.ny.gov Socrata twsw-2mqa;
`ny_ogs_payments(self, where=None, *, limit=20, offset=0, order=None, execution=None, no_cache=None)`	procurement	procurement ny_ogs_payments: New York State OGS D&C payments (data.ny.gov Socrata
`nzco_companies(self, *, q, entity_types=None, start=None, limit=None, execution=None, no_cache=None)`	company	company nzco_companies: NZ Companies Register search (name substring over the whole
`nzco_directors(self, *, company_number, execution=None, no_cache=None)`	company	company nzco_directors: NZ company current directors by company number — the page H1
`oecd_sdmx_series(self, *, flow=None, key=None, start=None, end=None, execution=None, no_cache=None)`	economy	economy oecd_sdmx_series: one OECD dataflow series (/public/rest/data/{flow}/{key}/all,
`openalex_institutions(self, *, search=None, per_page=25, execution=None, no_cache=None)`	research	research openalex_institutions: institution candidate search (/institutions?search=
`openalex_works(self, *, search=None, ror=None, doi=None, title_search=None, per_page=25, cursor=None, select=None, execution=None, no_cache=None)`	research	research openalex_works: global scholarly output search (/works verbatim name;
`opencitations_citations(self, *, doi=None, execution=None, no_cache=None)`	research	research opencitations_citations: open citation index COCI (/index/v1/citations/{doi}
`osv_vulns(self, *, package, ecosystem, version=None, page_token=None, execution=None, no_cache=None)`	security	security osv_vulns: open-source package vulnerability query (OSV /v1/query POST with verbatim
`paris_mou_bans(self, *, execution=None, no_cache=None)`	esg	esg paris_mou_bans: Paris MoU banned ships register (THETIS getBanShips; the embedded ismCompany is
`paris_mou_detentions(self, *, execution=None, no_cache=None)`	esg	esg paris_mou_detentions: Paris MoU currently-detained ships snapshot (THETIS getCurrentDetentions;
`paris_mou_inspections(self, *, period_min, period_max, psc_inspection_regime=1, page=1, start=0, limit=50, ism_company_name=None, ism_company_imo_number=None, execution=None, no_cache=None)`	esg	esg paris_mou_inspections: Paris MoU historical PSC inspection stream window search (THETIS getPublicInspections
`paris_mou_low_performance_companies(self, *, execution=None, no_cache=None)`	esg	esg paris_mou_low_performance_companies: Paris MoU low-performance ISM company list
`rasff_notifications(self, subject=None, *, notification_reference=None, ec_valid_date_from=None, ec_valid_date_to=None, page_number=1, items_per_page=25, execution=None, no_cache=None)`	healthcare	healthcare rasff_notifications: the EU RASFF food-safety alert window (the consolidated
`read(self, id=None, *, target=None, level='tier1')`	company / healthcare	Corpus single-record read (hosted API): id (or target) + T-layer depth.
`ror_organizations(self, *, query=None, ror_id=None, page=None, all_status=None, execution=None, no_cache=None)`	company	company ror_organizations: research-org master record (ROR v2; query search face XOR ror_id single-record face —
`rxnav_rxcui_atc(self, *, rxcui, execution=None, no_cache=None)`	healthcare	healthcare rxnav_rxcui_atc: RxCUI → ATC code (the upstream property.json?propName=ATC; run rxnav_rxcui_by_name first for drug names).
`rxnav_rxcui_by_name(self, *, name, execution=None, no_cache=None)`	healthcare	healthcare rxnav_rxcui_by_name: drug/brand name → an RxCUI normalization card (the upstream rxcuiByName single-record face, no paging).
`safety_gate_alerts(self, *, year=None, limit=200, skip=0, execution=None, no_cache=None)`	healthcare	healthcare safety_gate_alerts: the EU Safety Gate weekly-report index (1,122 reports
`safety_gate_report(self, *, report_id, limit=200, skip=0, execution=None, no_cache=None)`	healthcare	healthcare safety_gate_report: one Safety Gate weekly report's alerts (the detail XML —
`search(self, *, filters=None, record_kind=None, facets=None, level='tier1', limit=50, cursor=None, mode=None, screen_inputs=None)`	company / healthcare	Corpus search (hosted API). mode="screen" + screen_inputs is the batch-screening mode.
`sec_fulltext_search(self, *, q, forms=None, startdt=None, enddt=None, limit=10, execution=None, no_cache=None)`	company	company sec_fulltext_search: SEC filing full-text search 2001+ (EDGAR FTS four params verbatim;
`sec_submissions(self, *, cik, execution=None, no_cache=None)`	company	company sec_submissions: SEC CIK → registrant identity card (data.sec.gov submissions single record;
`sipri_trades_search(self, filters=None, *, supplier=None, recipient=None, type='delivered', page=1, limit=20, execution=None, no_cache=None)`	legal	legal sipri_trades_search: country-level arms-transfer face (SIPRI atbackend; filters = the raw POST
`ted_notices_search(self, *, query=None, fields=None, limit=10, page=1, execution=None, no_cache=None)`	company	company ted_notices_search: EU procurement notices (TED v3 expert search POST;
`thetis_mrv_datasets(self, *, execution=None, no_cache=None)`	esg	esg thetis_mrv_datasets: EU MRV ship emissions-reporting versioned bulk-file catalog (THETIS-MRV
`un_comtrade_trade(self, *, reporter=None, period=None, partner=None, cmd=None, flow=None, type_code='C', freq_code='A', cl_code='HS', max_records=500, partner2=None, customs=None, mot=None, execution=None, no_cache=None)`	economy	economy un_comtrade_trade: the UN Comtrade trade mirror (public preview API;
`ungm_contract_awards(self, supplier=None, *, title=None, reference=None, award_from=None, award_to=None, countries=None, agencies=None, unspscs=None, page_index=1, page_size=15, sort_field='AwardDate', sort_ascending=False, execution=None, no_cache=None)`	procurement	procurement ungm_contract_awards: UN Global Marketplace contract-award search
`unsd_sdg_indicators(self, *, page=1, per_page=50, search=None, execution=None, no_cache=None)`	economy	economy unsd_sdg_indicators: the UN SDG indicator catalog (/Indicator/List — 251
`unsd_sdg_series(self, *, series=None, geo=None, time=None, page=1, page_size=100, execution=None, no_cache=None)`	economy	economy unsd_sdg_series: the observations of ONE SDG series (/Series/Data?
`us_occ_enforcements(self, year=None, *, month=None, all_year=False, execution=None, no_cache=None)`	legal	legal us_occ_enforcements: US OCC monthly bank-enforcement releases (occ.gov, keyless;
`usaspending_spending_by_award(self, *, recipient_search_text, award_type_codes=None, start_date=None, end_date=None, fields=None, limit=10, page=1, subawards=False, execution=None, no_cache=None)`	company	company usaspending_spending_by_award: federal contracts/grants by recipient (spending_by_award POST params
`vies_vat(self, *, vat, execution=None, no_cache=None)`	company	company vies_vat: EU VAT number online validation (official VIES face; INVALID is a legal answer, not an error;
`wb_countries(self, *, page=1, per_page=100, execution=None, no_cache=None)`	economy	economy wb_countries: the World Bank country reference (/v2/country — ISO3 / ISO2 /
`wb_debarred_firms(self, name=None, *, country=None, type=None, limit=20, execution=None, no_cache=None)`	legal	legal wb_debarred_firms: World Bank debarred-firms register (apigwext SAP gateway via the
`wb_ids_indicators(self, *, page=1, per_page=600, search=None, execution=None, no_cache=None)`	economy	economy wb_ids_indicators: the World Bank International Debt Statistics catalog
`wb_procnotices(self, notice_type='Contract Award', *, rows=10, os=0, execution=None, no_cache=None)`	procurement	procurement wb_procnotices: World Bank procurement notice stream (search.worldbank.org /api/v2/procnotices;
`wb_wdi_indicators(self, *, source=2, page=1, per_page=500, search=None, execution=None, no_cache=None)`	economy	economy wb_wdi_indicators: the World Bank indicator catalog (/v2/indicator;
`wb_wdi_values(self, *, country=None, indicator=None, date=None, per_page=100, execution=None, no_cache=None)`	economy	economy wb_wdi_values: World Bank WDI indicator values for one or more countries
`who_xmart_indicators(self, *, filter=None, top=500, skip=0, search=None, execution=None, no_cache=None)`	economy	economy who_xmart_indicators: the WHO xMart indicator directory
`who_xmart_values(self, *, indicator=None, geo=None, year=None, entity_set=None, top=500, skip=0, execution=None, no_cache=None)`	economy	economy who_xmart_values: the observations of one WHO indicator

Healthcare data channels: the healthcare search/read paths in the table above answer from the corpus face; the production store is reached via the hub REST direct-call reference (see the hub REST section on the healthcare domain page).

The source field and caching

Every realtime result carries source = {provider, execution, from_cache, observed_at|fetched_at}; the local automatic cache serves repeat queries within each capability's lifetime; on a cache hit from_cache: true.
Every corpus result carries source = {source, observed_at, backend}.
Error codes and exit codes: the CLI reference “Errors & limits” section.

ON THIS PAGE

Python SDK#

Quick start#

Method overview#

The source field and caching#

Python SDK

Quick start

Method overview

The source field and caching