CLI 参考#

双入口同语义：agentdata <domain> <command> 或 python -m agentdata <domain> <command>。 全局项可放子命令前后；两处都给时，子命令后面的那份生效。环境变量与旗标同效。

全局旗标#

旗标	说明
--base-url	云端 API 地址（env AGENTDATA_BASE_URL）
--api-key	访问凭证 PAT（env AGENTDATA_API_KEY）
--cache-dir	本机缓存目录（env AGENTDATA_CACHE_DIR）
--no-cache	本次绕过缓存直连上游
--execution	local|hosted|auto（默认 auto：实时查询走本地）

company（企业数据）#

ch_zefix_firm#

Zefix single record: purpose full text, oldNames history, hasTakenOver/takenOverBy M&A edges with ehraid/uid/chid cross-references (precedessor/successor)

辖域：CH

旗标	必填	说明
--ehraid	是	瑞士商业登记号 ehraid（search 结果行里就带）

ch_zefix_firm_search#

Zefix firm search: name contains-match (hits historical names too); three registry keys (ehraid/uid/chid) per row; maxEntries/offset honored upstream (echoed back)

辖域：CH

旗标	必填	说明
--name	是	公司名或片段（包含匹配——历史名也命中）
--max-entries	否	返回行数（上游 maxEntries，默认 100）
--offset	否	偏移（上游分页，配 --max-entries 走；上限以上游回显的 max_offset 为准）

co_rues_companies#

RUES registro mercantil master, 9.4M rows: matricula registry key x NIT tax id x CIIU industry x legal form x representante_legal name edge; base filter keeps NIT-identified (tax entity) rows only — persona natural rows whose id columns are cedulas stay out of the face, and the RL cedula-number column is stripped (names kept)

辖域：CO

旗标	必填	说明
--where	否	SoQL 过滤表达式原样透传（例 razon_social like '%BANCOL%'、estado_matricula='ACTIVA'）；面自动追加基滤只收公司（NIT）行
--limit	否	每页行数，1–500（默认 20）
--offset	否	翻页偏移，0 起
--order	否	排序（例 matricula ASC；上游不吃 NULLS 语法）

fdic_institutions#

FDIC institutions: ES search × structured filters are combinable raw channels (search 'NAME:"…"' / filters 'CERT:n'); no upstream limit wall (10,000 verified)

辖域：US

旗标	必填	说明
--search	否	全文检索表达式（例 NAME:"First National" AND ST:TX）
--filters	否	结构化过滤表达式（例 ST:TX AND CITY:Dallas；按 CERT 点查用 CERT:628）
--limit	否	返回行数（默认 5）

fi_ytj_companies#

YTJ v3 companies: name contains-match hits historical/branch names; businessId direct lookup; pagination params are silently ignored upstream — fixed ~63-row pages, totalResults is the real total

辖域：FI

旗标	必填	说明
--name	否	公司名（子串语义——「Nokia」连「Nokian Vuokrakodit」也命中；历史 / 分支名同样命中）
--business-id	否	芬兰 business-id（形如 0205709-4；直查单档）

fr_recherche_search#

etalab recherche-entreprises: one q for company name, officer name (cross-company mandate search) or SIREN direct lookup; rich rows with dirigeants (person + corporate slots), finances, tva; etat_administratif A=active/C=ceased true filter

辖域：FR

旗标	必填	说明
--q	是	一个检索词三用：公司名 / 高管人名（跨公司任职检索）/ SIREN 直查
--page	否	页码，1 起（走 while page ≤ total_pages）
--per-page	否	每页行数，1–25（默认 10；超 25 本地直接报错，不查上游）
--etat-administratif	否	状态真过滤：A=在营 / C=注销（上游默认不过滤；小写自动归一）

gb_contracts_finder_published_notices#

Sub-threshold UK contracts: publishedFrom/publishedTo are bare dates (opposite of FTS); no window → our rolling 7-day default (upstream returns empty without one); --stages filters tender|award (upstream 400 self-validates); --name = client-side contains filter

辖域：GB

旗标	必填	说明
--name	否	公司名，本地包含过滤（上游该面没有按名检索的参数——每页取满 100 行再滤）
--stages	否	阶段过滤：tender / award（缺省=两阶段混流；写错值上游 400 自报闭集）
--published-from	否	发布窗起，YYYY-MM-DD（默认回看 7 天）
--published-to	否	发布窗止（默认今天）
--limit	否	返回行数，1–100；配 --name 时为匹配数上限（每页仍取 100）
--cursor	否	翻页游标（续走时带上同一时间窗）

gb_fts_release_packages#

WTO-line UK procurement releases: stages/limit/cursor/updatedFrom/updatedTo upstream-verbatim; --name is a client-side contains filter (forces fetch of the full 100-row page, matches buyer or suppliers)

辖域：GB

旗标	必填	说明
--name	否	公司名，本地包含过滤（上游该面没有按名检索的参数——每页取满 100 行再滤）
--stages	否	OCDS 阶段：award / tender（默认 award）
--limit	否	返回行数，1–100；配 --name 时为匹配数上限（每页仍取 100）
--cursor	否	翻页游标（回填 next_cursor）
--updated-from	否	更新窗起，YYYY-MM-DD 或完整 ISO 时间（裸日期自动补 T00:00:00Z）
--updated-to	否	更新窗止（裸日期自动补 T23:59:59Z）

gleif_direct_parent#

Direct parent card; 404 = honestly no parent (not an error)

辖域：GLOBAL

旗标	必填	说明
--lei	是	要查的 LEI 码（20 位全球法人识别码）

gleif_lei_records#

Legal Entity Identifier → entity card (legal name, status, jurisdiction, registration; + successor LEIs (M&A edge), expiration, legal form, BIC/MIC)

辖域：GLOBAL

旗标	必填	说明
--lei	是	要查的 LEI 码（20 位全球法人识别码，ISO 17442）

gleif_lei_records_search#

Name → LEI candidates (non-authoritative; verify with gleif_lei_records before persisting); jurisdiction/status filters and page[number] walking upstream-verbatim; rows carry registered_as (cross-registry join key)

辖域：GLOBAL

旗标	必填	说明
--filter-entity-legal-name	是	公司法定名称或其片段（包含匹配；官方参数 filter\[entity.legalName\]）
--filter-entity-jurisdiction	否	辖域过滤（官方参数 filter\[entity.jurisdiction\]；ISO 3166 国码或区域码，如 CH、US-MO）
--filter-entity-status	否	实体状态过滤（官方参数 filter\[entity.status\]；ACTIVE/INACTIVE/NULL——实体生命周期，非 registration.status）
--page-number	否	页码，1 基（官方参数 page\[number\]；翻页界=result.page.lastPage）
--page-size	否	候选数上限，1–200（默认 10）

gleif_ultimate_parent#

Ultimate parent card (top of the control chain); 404 = honestly no parent (not an error)

辖域：GLOBAL

旗标	必填	说明
--lei	是	要查的 LEI 码（20 位全球法人识别码）

kr_hometax_biz_status#

NTS hometax anonymous single-BRN status: four states all legal answers — active (일반/간이/과세특례 taxpayer), closed (ISO closure date extracted), unregistered (result=S, not an error), error; txprNm is always null upstream (no owner-name leak)

辖域：KR

旗标	必填	说明
--biz-no	是	韩国事业者登记号，10 位数字，连字符可省（124-81-00998 与 1248100998 等价）——运行时必填

no_brreg_enheter#

Brønnøysund Enhetsregisteret: navn search with HAL pagination (page/size, 0-based) or orgnr single record; navn is the Norwegian upstream param (?name= 400s)

辖域：NO

旗标	必填	说明
--navn	否	公司名（上游真参数名是 navn——写成 name 会 400）
--organisasjonsnummer	否	9 位组织号（直查单档，优先于 --navn）
--page	否	页码，0 起（仅 --navn 检索时有效）
--size	否	每页行数（默认 20，上限 100）

no_brreg_roller#

Role groups (DAGL CEO / STYR board / REVI auditor): persons carry name+birth date (no national id in the public face), corporate roles (auditors) carry org number; avregistrert=true = retired

辖域：NO

旗标	必填	说明
--organisasjonsnummer	是	9 位组织号（enheter 结果行里就带）

nzco_companies#

Name substring over the register index — the canonical parameter set is required (a bare ?q= answers an empty match, pinned). Rows: company number + 16-digit NZBN + the register's own status word (Registered/Removed, not 'Active') + entity type + registered address. Paging = the pager's own start= + limit 5|15 (both observed live; other sizes unpinned, not shipped); has_next reads the pager offsets

辖域：NZ

旗标	必填	说明
--q	是	名称子串（必填；登记册名称索引里公司号也能命中）
--entity-types	否	过滤器表单自己的 checkbox 码：ALL（默认）/ LTD / UNLTD / COOP=新西兰本国、ASIC / NON_ASIC=海外注册
--start	否	翻页行偏移，0 起（首页省略不发）
--limit	否	页容，只有 5 与 15 两值真机见过（默认 15；其余上游不承诺，本地拒绝）

nzco_directors#

Current appointments: full legal name + residential address (statutorily public in NZ, partially masked since the privacy-law change — captured verbatim) + appointment date in the register's wording. The page H1 confirms the company (name+number+status; a mismatch refuses to attribute rows). Ceased/former appointments render in a different section and stay out; find the number with nzco_companies (e.g. 104799 = Air New Zealand Limited)

辖域：NZ

旗标	必填	说明
--company-number	是	新西兰公司号，纯数字（104799=Air New Zealand Limited；先用 nzco_companies 查号）

ror_organizations#

Research Organization Registry: query → candidates (fixed 20/page, --page walks), or ror_id → authoritative single record

辖域：GLOBAL

旗标	必填	说明
--query	否	机构名关键词（每页固定 20 行）
--ror-id	否	ROR id（0+8 位；裸 id 或完整 URL 均可）
--page	否	页码（配 --query）
--all-status	否	把非 active（inactive / withdrawn）机构也纳入结果——上游缺省只回 active，其余两态静默隐藏

sec_fulltext_search#

EDGAR full-text search: q/forms/startdt/enddt upstream-verbatim; a single date end is auto-completed (silently ignored upstream), dateRange=custom always two-ended; total_relation gte = capped at 10k

辖域：US

旗标	必填	说明
--q	是	检索词（EDGAR 全文检索语法；短语用引号）
--forms	否	申报表型过滤（如 8-K,10-K）
--startdt	否	起始日 YYYY-MM-DD（只给一端时自动补 2001-01-01）
--enddt	否	截止日 YYYY-MM-DD（只给一端时自动补今天）
--limit	否	返回行数，1–100（上游单页即 100 条命中，超出部分本地切片）

sec_submissions#

Registrant identity card: legal/former names, tickers·exchanges, EIN, SIC, filing totals (accepts bare/zero-padded/CIK-prefixed input)

辖域：US

旗标	必填	说明
--cik	是	SEC 申报主体号 CIK（1–10 位数字；search 结果行里就带）

ted_notices_search#

Tenders Electronic Daily: expert-syntax query via --query (e.g. 'organisation-name-buyer=Siemens* AND organisation-country-buyer=DEU' / classification-cpv=33100000); limit 1-250 is an upstream hard wall

辖域：EU

旗标	必填	说明
--query	是	TED 检索表达式（必填；例 organisation-name-buyer=Siemens* AND organisation-country-buyer=DEU，尾随 * = 前缀匹配）
--fields	否	返回字段，逗号分隔（eForms 字段名；写错会 400 并附完整字段清单，照抄正确名即可）
--limit	否	每页公告数，1–250（默认 10）
--page	否	页码

usaspending_spending_by_award#

Federal contracts/grants: recipient name (array upstream, scalar auto-wrapped); award-type codes, time window (single end auto-completed), fields all upstream-verbatim

辖域：US

旗标	必填	说明
--recipient-search-text	是	收款方名称
--award-type-codes	否	奖项类型代码，逗号分隔（默认 A,B,C,D=合同；拨款用 02/03 等）
--start-date	否	时间窗起，YYYY-MM-DD（只给一端时另一端自动补全）
--end-date	否	时间窗止，YYYY-MM-DD
--fields	否	返回列，逗号分隔（默认 6 列）
--limit	否	每页行数，1–100（默认 10）
--page	否	页码（has_more 为真就继续翻）
--subawards, --no-subawards	否	是否包含子奖项（默认关）

vies_vat#

Official EU VAT validation: member-state prefixed number; INVALID → ok:true with valid=false; '---' masking → null (not missing data)

辖域：EU

旗标	必填	说明
--vat	是	带成员国前缀的 VAT 号（例 DE811907980）

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

economy（）#

bis_sdmx_series#

BIS SDMX series (realtime, local execution; /api/v1/data/{flow}/{key}/all, the SDMX 2.1 generic-CSV channel; key = the raw dot-separated series key with AT LEAST two segments — the segment order is flow-specific: WS_CBPOL FREQ.REF_AREA (M.US), WS_DSR FREQ.BORROWERS_CTY.DSR_BORROWERS (Q.US.N), WS_XRU FREQ.REF_AREA.CURRENCY.COLLECTION (M.CN.CNY.E); a one-segment key is every area at once — a multi-megabyte answer; a wrong key answers 404 with an SDMX error, which is not a block; --start / --end are the upstream startPeriod / endPeriod bounds)

辖域：GLOBAL

旗标	必填	说明
--flow	是	BIS 数据流 id（WS_CBPOL 政策利率 / WS_DSR 偿债率 / WS_XRU 美元汇率）
--key	是	SDMX 序列键，至少两段点分（段序按数据流定义：WS_CBPOL 是 M.US、WS_DSR 是 Q.US.N、WS_XRU 是 M.CN.CNY.E）——单段 key=全地区巨墙，本地拒
--start	否	期间窗起点（上游 startPeriod）
--end	否	期间窗截止（上游 endPeriod）

bls_series#

BLS v2 series observations (realtime, local execution; POST /publicAPI/v2/timeseries/data/ with a JSON body; --series takes up to 25 comma-separated ids — the documented keyless caps are 25 series x 10 years x 500 queries/day; a window wider than 10 years is refused locally because the upstream clamp keeps the EARLIEST ten years (startyear-anchored: a 2010..2026 ask answered 2010..2019); a bogus id answers 200 and the id is listed under series_without_data; omitting both years answers the latest ~3 calendar years; catalog/calculations/annualaverage/aspects are key-gated options and are never sent)

辖域：US

旗标	必填	说明
--series	是	BLS 序列 id，逗号分隔，≤ 25 个（官方码表：CUUR0000SA0=CPI-U、LNS14000000=失业率、CES0000000001=非农就业；小写本地归一大写）
--start-year	否	窗起点年（上游 startyear；与 --end-year 成对，双缺=最近 ~3 个日历年）
--end-year	否	窗截止年（上游 endyear；与 --start-year 成对；≤10 年窗——更宽窗本地拒：上游钳位保留的是最早十年）

comext_flows#

Eurostat Comext annual HS2-4-6 trade mirror since 2002 (realtime, local execution; the DEDICATED comext dissemination root /api/comext/dissemination/.../data/ds-059341 — the plain Eurostat root 404s the ds- datasets; at least one filter is required — the filterless mirror is a 413 "Full extraction forbidden" (31.3 billion cells, one query caps at 5 million); --flow 1 imports / 2 exports; --indicators defaults to VALUE_EUR; the reporter aggregates EU / EU27_2020 / EA / EA21 live alongside the country codes; the JSON-stat grid is decoded into flat rows; the monthly CN8 detail (DS-045409) travels the raw side, not this face)

辖域：EU

旗标	必填	说明
--reporter	否	报告方 Eurostat geo 码（可重复，如 DE；聚合体 EU / EU27_2020 / EA / EA21 与国家码同框）
--partner	否	伙伴方 geo 码（可重复，如 CN、WLD=世界）
--product	否	HS 2/4/6 品类码（可重复；85=电气机械）——码形错是静默零格，对 dimensions.product.codes 核对
--flow	否	流向（可重复：1 进口 / 2 出口）——不给=双向各一行
--indicators	否	值口径（默认 VALUE_EUR 欧元；亦 QUANTITY_IN_100KG）
--time	否	年份过滤（可重复，如 2024）
--since	否	时间轴起点（上游 sinceTimePeriod）
--until	否	时间轴终点（上游 untilTimePeriod）——至少给一个过滤维，零过滤上游 413

ecb_fx_rates#

ECB euro reference rate for one currency (realtime, local execution; /EXR/D.{CCY}.EUR.SP00.A?format=csvdata; the value is units of {currency} per 1 EUR and the date travels with every row; --start / --end are the upstream startPeriod / endPeriod bounds and one of them is required; the historical eurofxref CSV is a stale 2010 snapshot and is not used)

辖域：EU

旗标	必填	说明
--currency	是	币种的 ISO 4217 三字母码（USD / JPY / GBP）——序列键是 EXR.D.{CCY}.EUR.SP00.A
--start	否	窗口起始日（上游 startPeriod）；与 --end 至少给一端，否则拉全史（约 8,000 行）
--end	否	窗口截止日（上游 endPeriod）

eurostat_table#

Eurostat table query (realtime, local execution; /data/{table}; geo / time / --dim k=v are the upstream dimension filters — SEVERAL values are REPEATED parameters (the '+' form is a 400 and the comma form silently yields zero cells); --since / --until are the upstream sinceTimePeriod / untilTimePeriod bounds; the JSON-stat grid is decoded into flat rows; a geo outside the table yields zero cells and no upstream error)

辖域：EU

旗标	必填	说明
--table	是	表码（如 tec00001 / demo_pjan / nama_10_a64）
--geo	否	地理过滤（可重复，如 DE）——多值必须重复传，逗号拼接会静默回零格
--time	否	时间过滤（可重复，如 2023）
--dim	否	其余维度过滤，k=v 形式（可重复，如 unit=CP_MEUR、nace_r2=TOTAL）——不给就是整张网格
--since	否	时间轴起点（上游 sinceTimePeriod）
--until	否	时间轴终点（上游 untilTimePeriod）
--lang	否	上游语言（默认 EN）

fred_series#

FRED series observations (realtime, local execution; /fredgraph.csv?id=; ONE series id per call — several ids answer a ZIP archive the JSON transport cannot carry; an unknown series id answers an HTML error page and is reported as not-found; a missing observation is null; --start / --end are the upstream cosd / coed bounds)

辖域：US

旗标	必填	说明
--series	是	序列 id，一次一个（GDP / CPIAUCSL / DGS10）——多个 id 上游回 ZIP
--start	否	观测窗起点（上游 cosd）
--end	否	观测窗终点（上游 coed）

ilo_stat_indicator#

ILOSTAT indicator for one country (realtime, local execution; /data/indicator/; the format flag is the query parameter format=json — a path suffix is a 400/404; --ref-area (ISO-3) is required — the world-wide answer is orders of magnitude bigger; --time-from / --time-until are the upstream timefrom / timeto bounds — the upstream spells the upper bound 'timeto' and silently ignores 'timeuntil'; the urllib channel is the working one on this host — the curl stack answers an empty 200)

辖域：GLOBAL

旗标	必填	说明
--indicator	是	ILOSTAT 指标码（如 EMP_TEMP_SEX_ECO_NB_A）
--ref-area	是	国家 ISO-3 码（如 USA）——必填，全球口径体量差几个数量级
--time-from	否	年份下界（上游 timefrom）
--time-until	否	年份上界（上游 timeto——上游不认 timeuntil）
--sex	否	性别维度过滤（上游 sex）
--classif	否	分类维度过滤（上游 classif1，如 ECO_SECTOR_TOTAL）
--source	否	来源过滤（上游 source）

imf_sdmx_series#

IMF SDMX series (realtime, local execution; /external/sdmx/2.1/data/{flow}/{COUNTRY.INDICATOR[.FREQUENCY]}, the SDMX 2.1 generic-CSV channel; --country AND --indicator are both required — the country-only key is the multi-megabyte wall; the key shape fits the WEO/GDD/CPI family, NOT UNFCCC whose dimensions insert INDUSTRY/GAS_TYPE before the indicator; --start / --end are the upstream startPeriod / endPeriod bounds; OBS_VALUE carries the true value — SCALE is only a display hint)

辖域：GLOBAL

旗标	必填	说明
--flow	是	IMF 数据流 id（WEO 世界经济展望 / GDD 全球债务 / CPI 物价）
--country	是	国家码（WEO/GDD 用 ISO-3，如 USA）——与 --indicator 双必填，国家-only key 是巨墙
--indicator	是	指标码（如 NGDP_RPCH = 实际 GDP 增速）——键形=COUNTRY.INDICATOR\[.FREQUENCY\]，适合 WEO/GDD/CPI 族（UNFCCC 的维序不同，勿用）
--frequency	否	可选尾维（如 A）
--start	否	期间窗起点（上游 startPeriod）
--end	否	期间窗截止（上游 endPeriod）

oecd_sdmx_series#

OECD SDMX series (realtime, local execution; /public/rest/data/{flow}/{key}/all, the SDMX generic-CSV channel; --flow takes the CATALOG form agency,DSD@DF[,version] — the bare DF spelling answers 404 "Could not find Dataflow and/or DSD"; --key is dot-separated with EXACTLY one segment per DSD dimension and an EMPTY segment as the wildcard — the segment count is validated against the DSD structure before the data call, so the short-key 403 ("expecting 12 got 6") never forms; --start / --end are the upstream startPeriod / endPeriod bounds; the whole service is keyless — the 2026-11-02 'needs a key' ruling was a request-form misdiagnosis)

辖域：GLOBAL

旗标	必填	说明
--flow	是	数据流，目录形 agency,DSD@DF\[,version\]（如 OECD.ECO.MAD,DSD_EO@DF_EO,1.5 经济展望、OECD.SDD.NAD,DSD_NAAG@DF_NAAG_I,1.0 国民账户 GDP 章）——裸 DF 名上游 404；agency 带点是常态
--key	是	点分序列键，段数必须=DSD 维数、空段=通配（A.DEU...=年度 × 德国 × 其余全通配）——本面先走结构端点校验，维名列进错误信息
--start	否	期间窗起点（上游 startPeriod）
--end	否	期间窗截止（上游 endPeriod）

un_comtrade_trade#

UN Comtrade trade mirror, public preview (realtime, local execution; /public/v1/preview/{type}/{freq}/{cl}; --reporter / --partner take an ISO-3 code or the numeric area code — the ISO3 is translated through the area reference, whose historical and duplicate rows make a naive map wrong (USA = 842, not 840 or 841); --period 2023 / 202301; --cmd is the commodity code (comma list, TOTAL = all goods); --flow X / M / 'X,M'; the preview answers at most 500 records)

辖域：GLOBAL

旗标	必填	说明
--reporter	是	报告国：ISO-3（USA）或数字地区码（842）
--period	是	报告期：2023 或 202301
--partner	否	伙伴方：ISO-3 或数字码（0 / W00 = 世界合计）
--cmd	否	商品码，逗号列表（TOTAL = 全部商品）
--flow	否	流向：X 出口 / M 进口 / X,M 双向
--type-code	否	路径段：商品类型（C）
--freq-code	否	路径段：频率（A = 年度）
--cl-code	否	路径段：分类体系（HS）
--max-records	否	每次调用返回条数（1–500）
--partner2	否	第二伙伴方（上游 partner2Code；ISO-3 或数字码，同 --partner 解析——镜像流的经手国腿）
--customs	否	海关制度过滤（上游 customsCode；取值见 Comtrade 参照表）
--mot	否	运输方式过滤（上游 motCode；数字码，取值见 Comtrade 参照表）

unsd_sdg_indicators#

UNSD SDG indicator catalog (realtime, local execution; /Indicator/List — 251 indicators over the 17 goals, each row carrying its series codes (713 in total) nested inside; the upstream answers the whole catalog in one payload — --page / --per-page slice it locally and --search is a LOCAL keyword scan over the whole catalog, never an upstream filter)

辖域：GLOBAL

旗标	必填	说明
--page	否	本地页切（上游一次发整本目录）
--per-page	否	本地页大小（1–500，默认 50）
--search	否	关键词本地扫描（指标码 / 描述 / series 码）——扫的是整本目录，不是当前页

unsd_sdg_series#

UNSD SDG series observations (realtime, local execution; /Series/Data?seriesCode= — series granularity only: the whole-indicator endpoint is a 3.2M-row wall that is never formed; --geo is a LOCAL filter over the fetched page matching the geoAreaCode or geoAreaName — the upstream 'area' parameter is DECORATIVE, byte-identical with and without it; --time is the upstream timePeriod filter, the one upstream filter that works on this endpoint)

辖域：GLOBAL

旗标	必填	说明
--series	是	SDG series 码（如 SI_POV_DAY1、DC_ODA_POVLG——用 unsd_sdg_indicators 列候选）——只走 series 粒度，整指标端点是 320 万行巨墙、永不调用
--geo	否	地理过滤，本地执行（匹配 geoAreaCode 或 geoAreaName，不分大小写）——上游 area 参数是装饰品（带不带字节全同）
--time	否	期间过滤（上游 timePeriod，如 2020）——该端点唯一有效的上游过滤
--page	否	页码，1 起（上游翻页）
--page-size	否	每页条数（1–1000，默认 100）

wb_countries#

World Bank country reference (realtime, local execution; /v2/country; ISO3 / ISO2 / region / income level / lending type / coordinates — the income band is the buyer-screen dimension; the 296 entries include the aggregate regions)

辖域：GLOBAL

旗标	必填	说明
--page	否	页码，1 起（默认 1）
--per-page	否	每页条数（默认 100）

wb_ids_indicators#

World Bank International Debt Statistics catalog (realtime, local execution; /v2/indicator with source pinned to 6 = IDS — 577 indicators in seven debt families: DOD stocks / INT interest / AMT disbursements / DIS / NFL net flows / NTR / TDS service plus the balance-of-payments mirrors; the per-page default 600 holds the whole catalog in one page; the VALUES of the DT.* codes are served by wb_wdi_values WITHOUT a source parameter — the value endpoint breaks with source=6 and the API silently falls back to sourceid 2)

辖域：GLOBAL

旗标	必填	说明
--page	否	页码，1 起（默认 1）
--per-page	否	每页条数（默认 600——整本 IDS 目录一页装下）
--search	否	关键词，只扫当前页（不是上游过滤）

wb_wdi_indicators#

World Bank indicator catalog (realtime, local execution; /v2/indicator?source=; source 2 = WDI — without it the catalog is every World Bank source at once (29,544 rows); --search is a LOCAL keyword scan over the returned page, not an upstream filter)

辖域：GLOBAL

旗标	必填	说明
--source	否	世行源 id，2 = WDI（默认 2）——不给就是全世行指标目录
--page	否	页码，1 起（默认 1）
--per-page	否	每页条数（默认 500）
--search	否	关键词，只扫当前页（不是上游过滤）——页外候选要翻页

wb_wdi_values#

World Bank WDI indicator values (realtime, local execution; /v2/country/{country}/indicator/{indicator}; country = ISO3, several codes joined by ';'; ONE indicator code per call — the upstream rejects several codes in one call ("120 Invalid value"); date = YYYY or YYYY:YYYY; a missing observation is null, never fabricated)

辖域：GLOBAL

旗标	必填	说明
--country	是	国家 ISO-3 码，多国用 ; 拼接（CHN;JPN）
--indicator	是	一个 WDI 指标码（如 NY.GDP.MKTP.CD）——多个码上游回 120 Invalid value
--date	否	年份或区间：2020 或 2020:2023
--per-page	否	每页条数（默认 100）

who_xmart_indicators#

WHO xMart indicator directory (realtime, local execution; IND_DIRECTORY_WIDE — 1,561 indicators, each row carrying IND_URI_API (the per-indicator API diameter) and IND_URI_WEB; --filter is the raw upstream OData $filter; --search is a LOCAL keyword scan over the returned page)

辖域：GLOBAL

旗标	必填	说明
--filter	否	上游 OData $filter 逐字透传（如 startswith(IND_NAME,'TB_')）——按词找指标走这一条
--top	否	上游 $top 页大小（1–5000，默认 500）
--skip	否	上游 $skip 偏移（默认 0）
--search	否	关键词，只扫当前页（不是上游过滤）

who_xmart_values#

WHO xMart indicator observations (realtime, local execution; DATA_/{entity set}; the entity set is resolved from the directory row's IND_URI_API — when several entity sets carry the same indicator name the candidate list is NOT auto-picked, pass --entity-set; --geo takes an ISO-3 country (translated through REF_GEO_WIDE into the M49 code) or a raw M49 code; --year is the DIM_TIME string value)

辖域：GLOBAL

旗标	必填	说明
--indicator	是	指标码（如 TB_ppm_enrol_tx_prct）
--geo	否	ISO-3 国家码或裸 M49 码（经 REF_GEO_WIDE 翻译）
--year	否	年份（DIM_TIME 的字符串值，如 2023）
--entity-set	否	取值实体集（同一指标名有多个候选时必填）
--top	否	上游 $top 页大小（1–5000，默认 500）
--skip	否	上游 $skip 偏移（默认 0）

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

esg（ESG 数据）#

climatetrace_owners#

Climate TRACE emissions-owner candidates: name/limit/offset upstream-verbatim; zero hit = legal empty (upstream 404 JSON mapped); ordering is NOT stable across limits — fetch enough in one go

辖域：GLOBAL

旗标	必填	说明
--name	是	企业主体名（先拿 id，再配 climatetrace_sources 查设施级排放）
--limit	否	返回行数（上限 50）
--offset	否	跳过行数（排序不稳定——尽量一次取够）

climatetrace_sources#

Climate TRACE owner/filter→facility/aggregate emission sources: owner_ids→ownerIds (comma-joined = union & dedup, tested; repeated param = upstream silently first-wins, do not use) XOR --owner-name 快捷通道 (resolves first candidate); year no local wall (out-of-window year → upstream null, 2021+ has data); gas verbatim — non-co2e gas switches row key to emissions_quantity (native unit); 0.2.9 audit additions: offset paging, sectors closed-set validated locally (invalid values silently return the WHOLE corpus upstream), subsectors passthrough (upstream 400 self-describes), location family gadm_id/city_id/country_group/continent passthrough (upstream 400 enforces one-at-a-time); owner_ids or at least one filter required (bare corpus scan walled politely)

辖域：GLOBAL

旗标	必填	说明
--owner-ids	否	企业 id（E 系，如 E100000000766；逗号分隔多个=并集）
--owner-name	否	企业名快捷通道：先解出首个候选企业（与 --owner-ids 二选一；要精确定向用后者）
--year	否	排放年份（默认当年；数据窗 2021 起）
--gas	否	温室气体口径（默认 co2e_100yr = tCO2e）
--limit	否	返回行数（上限 500）
--offset	否	跳过行数（排序不稳定——尽量一次取够）
--sectors	否	部门过滤，闭集：agriculture / buildings / fluorinated-gases / forestry-and-land-use / fossil-fuel-operations / manufacturing / mineral-extraction / power / transportation / waste，另有特殊值 all_no_forest（写错值上游静默回整库，本地已拦）
--subsectors	否	子部门 slug，上游 68 值（全表在 GET /v7/definitions/subsectors；写错值上游 400 自报）
--gadm-id	否	GADM 区域 id（地点族四参——gadm-id / city-id / country-group / continent 上游一次只许传一个，多传 400）
--city-id	否	都市圈 id（地点族四参，一次只许传一个）
--country-group	否	国家组 slug（如 eu / aosis / g20；地点族四参，一次只许传一个）
--continent	否	大洲名（如 Europe——上游口径 RUS 计入 Europe；地点族四参，一次只许传一个）

eiti_companies#

EITI extractives filing-company candidates: company_name__like is the upstream Datasette magic param verbatim (%/_ metachars yours to manage); --name 快捷通道 wraps %contains% (same slot, XOR); zero hit = legal empty

辖域：GLOBAL

旗标	必填	说明
--company-name__like	否	公司名，SQL LIKE 匹配（% / _ 通配符原样透传）
--name	否	公司名快捷通道：自动按 %名% 包含匹配（与 --company-name__like 二选一；要自管通配符用后者）
--size	否	返回行数（上限 1000）

eiti_payments#

EITI company→government payment lines: id channel (eiti_id_company__exact verbatim XOR --eiti-id 快捷通道 adding the eiti_id_company: prefix) + name channel (company_name__like verbatim XOR --name 快捷通道); channels may combine; at least one required (bare scan walled locally)

辖域：GLOBAL

旗标	必填	说明
--eiti-id-company__exact	否	EITI 企业 id，全值精确匹配（含 eiti_id_company: 前缀）
--eiti-id	否	裸 UUID 快捷通道：自动补 eiti_id_company: 前缀（与 --eiti-id-company__exact 二选一）
--company-name__like	否	公司名，SQL LIKE 匹配（% / _ 通配符原样透传）
--name	否	公司名快捷通道：自动按 %名% 包含匹配（与 --company-name__like 二选一；要自管通配符用后者）
--size	否	返回行数（上限 1000）

epa_frs_facilities#

EPA FRS facility registry point query: seven filter columns upstream-verbatim (registry_id / primary_name / state_code / city_name + the 0.3.20 audit trio country_name / site_type_name / epa_region_code — ALL exact '=' match, combinable = AND; the upstream contains/~ operators silently return 0, fuzzy facility names go through ECHO; country_name unlocks the non-US facility slice, GERMANY=110 measured) + start/size paging (ROWS closed interval start:end, computed locally — an omitted/inverted ROWS segment makes the upstream dump the whole table); at least one filter required (bare 5.6M-row scan walled politely, batch pipeline serves that); each call = rows + count (total_matches)

辖域：US

旗标	必填	说明
--registry-id	否	FRS Registry ID——设施权威键（ECHO/TRI/GHGRP 汇流锚）
--primary-name	否	设施主名称——精确匹配（含空格；上游 contains/~ 算子静默回 0，模糊检索走 ECHO 面）
--state-code	否	州代码，两字母（小写自动转大写，如 DE）
--city-name	否	城市名（精确匹配；七过滤可并用=AND，至少给一个）
--country-name	否	国家名（精确大写形，小写自动转大写——GERMANY=110 行实测，解锁非美设施切片）
--site-type-name	否	设施类型（精确大写，如 STATIONARY=4,725,914 行实测）
--epa-region-code	否	EPA 区域（零填充两位串形 '03'；region 10=214,197 行实测）
--start	否	分页偏移（上游 ROWS 闭区间左端；右端由 size 本地恒算）
--size	否	返回行数（默认 50，礼貌档 500）

euasl_datasets#

EU Air Safety List official download catalog (keyless): one call returns all files — the machine-readable XLSX master (Annex A = carriers under an operating ban, Annex B = restrictions/conditions) + 24 official-language PDF renditions; the document UUIDs rotate on every republication (reconcile against this listing, never guess file names); zero params upstream; the binary bodies go through the batch pipeline, this face gives coordinates

辖域：EU

旗标	必填	说明

eutl_datasets#

EUTL official bulk-download catalog (keyless): one call returns all datasets — Azure daily extracts (accounts/operators/holdings csv.gz) + climate.ec.europa.eu yearly files (compliance/verified emissions 2021-2025); zero params upstream; file downloads themselves go through the batch pipeline, this face gives coordinates

辖域：EU

旗标	必填	说明

paris_mou_bans#

Paris MoU banned-ships register (keyless): ban date/occurrence/order status/reason/minimum duration/banning authority, with the embedded ISM company flattened to row keys — the official ship x management-company edge (~2/3 of rows carry a company IMO number); zero params upstream

辖域：GLOBAL

旗标	必填	说明

paris_mou_detentions#

Paris MoU (Atlantic/European port state control) currently-detained ships snapshot (keyless): daily-rolling live state — ship IMO number (asset key), detention port+country, reporting authority; historical detentions go through paris_mou_inspections window search; zero params upstream

辖域：GLOBAL

旗标	必填	说明

paris_mou_inspections#

Paris MoU historical port state control inspections (THETIS form-encoded POST, keyless): period_min/period_max are dd/mm/yyyy STRICT (upstream native order day/month/year — wrong order silently returns zero) and the window must be <= 3 years (enforced locally, upstream silently empties beyond); page is the paging switch — the face always sends it (without page upstream ignores limit and dumps the whole window); page+start+limit = start-offset paging (page 1/2 verified zero overlap); ism_company_imo_number / ism_company_name filter straight to the management company (resume window stats ships/inspections/detentions/ISM deficiencies ride along); psc_inspection_regime upstream-verbatim (1 = PSC default regime, only verified value; omitted = upstream 200 empty); zero rows in window = legal empty

辖域：GLOBAL

旗标	必填	说明
--period-min	是	窗起 dd/mm/yyyy（上游参 periodMin；日/月/年严格序——写错序上游静默回 0 行；必填）
--period-max	是	窗止 dd/mm/yyyy（上游参 periodMax；窗≤3 年本地墙——超窗上游静默空回；必填）
--psc-inspection-regime	否	检查制度（上游参 pscInspectionRegime；1=PSC 默认制度，唯一活值——0→200 毒空/2→HTTP 500，非 1 本地墙拒附证据）
--page	否	页码（上游参 page；翻页开关——本面恒发，不带则上游无视 limit 整窗倾倒）
--start	否	页内行偏移（上游参 start；page+start+limit=start 偏移翻页，page1/page2 实测零重叠）
--limit	否	返回行数（默认 50，礼貌档 500；上游 1000 全量兑现）
--ism-company-name	否	ISM 管理公司名过滤（上游参 ismCompanyName）
--ism-company-imo-number	否	ISM 公司 IMO 号过滤，7 位零填充（上游参 ismCompanyImoNumber，如 0052193；零填充/非填充两形上游均收，透传不规范化）

paris_mou_low_performance_companies#

Paris MoU low-performance ISM company list (rolling 6-month window, keyless): each row carries an IMO company number (7-digit zero-padded official string), with address/country/performance level (LOW dominant, some MEDIUM)/listing dates — company-risk attribute list; zero params upstream

辖域：GLOBAL

旗标	必填	说明

thetis_mrv_datasets#

THETIS-MRV versioned bulk-file catalog (keyless): reporting periods (2018+) x versioned regenerated XLSX publications (versions roll — reconcile by this list, never guess filenames; generation timestamps are early-morning batch runs); download_path template is served for the batch pipeline, this face gives coordinates; zero params upstream

辖域：EU

旗标	必填	说明

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

healthcare（医疗数据）#

注：本域的 search/read 应答语料面；生产医疗库走 hub REST 直调（基址 https://hub.omnimay.com，US 面见医疗数据域页）；实时查询不受影响。

au_tga_artg#

澳洲治疗用品登记（ARTG）检索。

辖域：AU

旗标	必填	说明
--query	否	检索词（全字段 AND；按申办方精确查把名字放进双引号，如 "Sun Pharma ANZ Pty Ltd"）
--limit	否	返回行数（上限 100，默认 20）
--skip	否	跳过行数（默认 0）

au_tga_manufacturers#

澳洲登记制造商名册（可按州过滤）。

辖域：AU

旗标	必填	说明
--state	否	州过滤（如 QLD / NSW / VIC；本地按 SiteState 过滤）
--limit	否	返回行数（上限 500，默认 100）

ca_dpd_companies#

加拿大药品数据库公司册：DIN 持有企业 × 公司码，带类型与全址。

辖域：CA

旗标	必填	说明
--limit	否	返回行数（默认 200——上游一发全册无分页，这是本地切片）
--skip	否	跳过行数（默认 0，本地切片）

ca_dpd_drug_products#

加拿大在册药品：DIN × 品牌名 × 企业，按上市状态闭集过滤。

辖域：CA

旗标	必填	说明
--status	是	上市状态闭集，必填：1=已批 2=已上市 3=上市前撤销 4=上市后撤销 6=休眠（无 5）——未知值被上游静默无视并倾倒整库 15MB，SDK 侧先拦
--limit	否	返回行数（默认 200，本地切片）
--skip	否	跳过行数（默认 0，本地切片）

ca_mdall_companies#

加拿大医疗器械活跃许可公司册（双国册——美国厂商在册带国别码）。

辖域：CA

旗标	必填	说明
--limit	否	返回行数（默认 200——上游一发全册无分页，这是本地切片）
--skip	否	跳过行数（默认 0，本地切片）

ca_mdall_licence#

MDALL 单张执照全档：制造商块 × 公司 ID × 器械分级与识别符族。

辖域：CA

旗标	必填	说明
--licence-id	是	MDALL 执照号，数字（如 111577；上游参数 licenceId）
--licence-type	否	执照索引：active（默认）
--lang	否	语言：eng（默认）

ctgov_studies#

ClinicalTrials.gov 试验检索——按适应症 / 申办方 / 状态找试验。

辖域：US

旗标	必填	说明
--query.term	否	原始检索表达式（官方 query.term 语法；按申办方查用 AREA\[LeadSponsorName\]("Pfizer")）
--query.titles	否	标题字段检索（可与 --query.term / --query.cond 等组合）
--query.intr	否	干预手段字段检索（药物 / 术式名；可与 --query.term 等组合）
--query.cond	否	适应症/病种检索（可与其他条件组合）
--filter.advanced	否	高级过滤，AREA\[字段\](值) 语法，可组合（例见下）
--agg-filters	否	分面过滤，数值枚举（例 phase:3——写 PHASE3 会零命中）
--fields	否	返回列，逗号分隔（例 NCTId,BriefTitle）
--page-size	否	每页行数（默认 20；上游未设上限）
--page-token	否	翻页令牌（回填 next_page_token）
--sort	否	排序（例 EnrollmentCount:desc）
--count-total, --no-count-total	否	是否请求命中总数（默认开）

dailymed_spls#

美国药品说明书结构化标签（DailyMed SPL）检索。

辖域：US

旗标	必填	说明
--search	否	药品名（官方 drug_name 通道）
--manufacturer	否	标签持有方/生产商过滤（如 Pfizer）
--setid	否	SPL setid 精确过滤
--page	否	页码
--pagesize	否	每页行数（按 100 封顶——更大值不报错但仍按 100 返回）
--sort	否	排序（如 published_date）

epmc_search#

欧洲生命科学文献库（Europe PMC）检索——按机构 / 主题找文献。

辖域：GLOBAL

旗标	必填	说明
--search	否	检索表达式（例 AFF:"Novartis" AND "psoriasis"——AFF 按机构过滤）
--result-type	否	返回行深（默认 lite）
--page-size	否	每页行数，1–1000（默认 25）
--cursor-mark	否	翻页游标（首页传 *）
--sort	否	排序（例 CITED desc）

eudamed_devices_udi_di_data#

EU 器械 UDI-DI → EUDAMED 登记数据。

辖域：EU

旗标	必填	说明
--primary-di	是	EU 器械 UDI-DI（必填）
--page	否	页码（从 0 起）
--page-size	否	每页行数（默认 5）
--iso2-code	否	返回语言（默认 en）

fda_crl_letters#

FDA 完整回复函（CRL）：公司 × 否决性审批事件，带批准状态与来函日期。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 company_name:"Firm Name"）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 letter_date:desc）

fda_device_510k#

510(k) 上市前通告：K 号 × 申请企业，带决定码与决定日期。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 applicant:"Medtronic"）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 decision_date:desc）

fda_device_classification#

器械产品码分类学：器械名 × 产品码 × 器械类别，产品码可 join 510(k)/PMA/召回面。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 device_name:"syringe"）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（本面无日期字段——无默认排序，须自己给）

fda_device_pma#

PMA 上市前批准与补充：PMA 号 × 申请企业，带决定码与决定日期。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 applicant:"Medtronic"）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 decision_date:desc）

fda_device_recalls#

美国器械召回（RES 系统，含全生命周期）：召回企业 FEI 号与 K 号可作关联键。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 recalling_firm:"Firm Name"——短语形态）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 event_date_posted:desc）

fda_device_registrations#

器械机构注册与列名（季更）：注册号 / FEI 号 × 企业名。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 registration.name:"Firm Name"——可检字段都在 registration.* 命名空间，顶层 firm_name / fei_number 不命中）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 registration.reg_expiry_date_year:desc）

fda_drug_approvals#

Drugs@FDA 申请档案：申请号 × 申办方，带产品清单与申报时间线。

辖域：US

旗标	必填	说明
--search	否	检索表达式（openFDA 语法，例 sponsor_name:"TEVA"——公司键是 sponsor_name，applicant_name 是上游文档错觉；keyword 字段按行内存储形态区分大小写）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 submissions.submission_status_date:desc）

fda_drug_catalog#

NDC 药品目录（日更）：产品 NDC × 标签商，带上市日期与类别。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 labeler_name:"pfizer" 查标签商——NDC 目录日更，NSDE 上市起止日期并入此面）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 marketing_start_date:desc）

fda_drug_recalls#

美国药品召回与执法记录（2012 起）：召回号 × 召回企业，带级别、状态与原因。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 recalling_firm.exact:"Firm Name"）——运行时必填：缺参本地直接报错，不空打上游
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 report_date:desc）

fda_drug_shortages#

美国药品短缺通报（openFDA）。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 openfda.manufacturer_name.exact:"Fresenius Kabi USA, LLC" AND status:Current——openFDA 语法，生产商/药名/状态都写进表达式）
--limit	否	返回行数，1–1000（默认 20）
--skip	否	跳过行数（默认 0）
--sort	否	排序（默认 update_date:desc）

fda_food_recalls#

美国食品召回与执法记录（2012 起）：召回号 × 召回企业，带级别、状态与原因。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 recalling_firm.exact:"Firm Name"）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 report_date:desc）

fda_orangebook#

橙皮书批准药品：批准日期 × 持证人，带参比药品（RLD）标记。

辖域：US

旗标	必填	说明
--search	否	检索表达式（例 products.application_full_name:"Teva"——持证人在 products[] 里，顶层无 applicant 字段）——运行时必填：缺参本地直接报错
--limit	否	返回行数，1–1000（上游硬墙；默认 20）
--skip	否	跳过行数（默认 0——上游无游标，深翻页靠它）
--sort	否	排序（默认 approval_date:desc）

gb_mhra_alert#

英国 MHRA 单条警示全档（公告正文+PDF 附件）。

辖域：GB

旗标	必填	说明
--slug	是	警示页尾段标识（用 alerts 结果行里的 slug；粘贴整条 gov.uk 链接也自动剥前缀——带尾 .json 同样剥掉）

gb_mhra_alerts#

英国 MHRA 药品与器械安全警示检索（召回/器械通告/现场安全通知）。

辖域：GB

旗标	必填	说明
--q	否	检索词（公司名/产品词穿透通道——如 Abbott 命中 160 条警示；不传=整库 1,462 条最新在前）
--count	否	每页行数 1–100（默认 20；礼貌上限，上游无墙）
--start	否	偏移翻页：从第几行开始取（默认 0）

gudid_devices#

美国器械登记库（GUDID）：DI / UDI → 器械登记卡。

辖域：US

旗标	必填	说明
--di	否	器械标识符 DI
--udi	否	完整 UDI 字符串
--record-key	否	记录键（GUDID 原始行键）

mesh_descriptor#

医学主题词表（MeSH）检索——把药名 / 病种名归一到标准主题词。

辖域：GLOBAL

旗标	必填	说明
--label	是	要查的医学主题词（传 term/descriptor 会被上游 400——用 label）
--match	否	匹配模式（默认 contains）
--limit	否	候选上限（默认 10，最大 50）

rasff_notifications#

欧盟 RASFF 食品与饲料安全警示检索：通报国 × 产品类别 × 风险决定。

辖域：EU

旗标	必填	说明
--subject	否	警示主题自由文本（上游参数 subject；如 aflatoxin）
--notification-reference	否	警示编号精确匹配（上游参数 notificationReference；如 2026.9701）
--ec-valid-date-from	否	窗口起，dd-MM-yyyy 格式（上游参数 ecValidDateFrom；如 01-09-2026——ISO 格式被上游拒绝）
--ec-valid-date-to	否	窗口止，dd-MM-yyyy 格式（上游参数 ecValidDateTo）
--page-number	否	页码，1 基（上游参数 pageNumber；默认 1）
--items-per-page	否	每页行数 1–200（上游参数 itemsPerPage；浏览器默认 25，200 为礼貌上限）

rxnav_rxcui_atc#

RxCUI → ATC 药理分类。

辖域：US

旗标	必填	说明
--rxcui	是	RxCUI 数字编号

rxnav_rxcui_by_name#

药名 / 品牌名 → RxCUI 编码（RxNorm 官方归一）。

辖域：US

旗标	必填	说明
--name	是	药品名或品牌名

safety_gate_alerts#

欧盟 Safety Gate（原 RAPEX）非食品产品安全周报总目。

辖域：EU

旗标	必填	说明
--year	否	报告年份——本地后滤非上游参数（上游恒发整份总目）
--limit	否	返回行数（默认 200，本地切片）
--skip	否	跳过行数（默认 0，本地切片）

safety_gate_report#

单期 Safety Gate 周报明细：案号 × 品类 × 风险级别 × 通报国 × 原产国。

辖域：EU

旗标	必填	说明
--report-id	是	报告号，数字（safety_gate_alerts 行里回显的 report_id；粘贴整条明细 URL 也能自动剥出）
--limit	否	返回行数（默认 200，本地切片）
--skip	否	跳过行数（默认 0，本地切片）

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

legal（法律数据）#

afdb_debarred_entities#

AfDB debarment register (keyless): the whole 1,440-row feed (FIRM 1,196 / INDIVIDUAL 244) is pulled once, cached 24h and scanned locally. Basis = the cross-debarment edge (CROSS DEBARMENT : WBG / CROSS-DEBARMENT: ADB — upstream spacing inconsistent, so --basis is a contains-match on the bank token: WBG/ADB/IDB/EBRD); To empty = ongoing. Empty result = clean screening (legitimate answer)

辖域：GLOBAL

旗标	必填	说明
--name	否	主体名（企业或个人）——匹配名称的任何一部分，不分大小写
--type	否	主体类型：FIRM 或 INDIVIDUAL（精确匹配，不分大小写）
--basis	否	除名依据——匹配 Basis 文本的任何一部分。册内跨行除名以银行 token 标记（WBG / ADB / IDB / EBRD），同一标记既有带空格也有带连字符两种写法，只写 token 即可
--limit	否	返回行数，1–100（默认 20）。整册在本地筛查，结果里的 total_matched 是确切命中数

ca_sema_sanctions#

Canada SEMA sanctions (Consolidated Canadian Autonomous Sanctions List, keyless sema-lmes.xml): 5,708 live listings — persons 3,526 / entities 2,181 of which 731 ships with an IMO number (the join key onto shipping rosters). Bilingual cells verbatim ("Syria / Syrie"); name screening contains-matches name + aliases (matched_on echoes the hit face). Empty result = clean screening (legitimate answer)

辖域：CA

旗标	必填	说明
--name	否	被指定名称——匹配正名或别名的任何一部分，不分大小写；结果回显命中的是哪一个
--country	否	国家——匹配国家格子的任何一部分；该格子双语书写（Syria 与 Syrie 同中）
--limit	否	返回行数，1–100（默认 20）。整册在本地筛查，结果里的 total_matched 是确切命中数

co_sic_sanctions#

Colombia SIC sanctions register (keyless): firm sanctions imposed in firme by the Superintendencia de Industria y Comercio — multado (the sanctioned party) × valor (fine, COP) × conducta (the violation) × sector, 3,938 rows 2013→. Socrata $-parameter channel verbatim: --where raw SoQL, --limit 1-500, --offset, --order column[ ASC|DESC] (same contract as co_secop_contracts; name-only key — no NIT column, a name join onto co_rues_companies is the corpus line's job)

辖域：CO

旗标	必填	说明
--where	否	SoQL 过滤表达式原样透传（例 upper(multado) like '%ECOPETROL%'——被罚主体名列 multado；册内 3,938 条 2013 年起）
--limit	否	每页行数，1–500（默认 20）
--offset	否	翻页偏移，0 起（本册无总数回显，翻页走偏移）
--order	否	排序（例 fecha_emitida DESC；缺省=入库序非时间序）

courtlistener_opinions_search#

CourtListener opinions search (federal + state courts; CAP/api.case.law retired into this source): at least one filter required (full corpus ~8.3M bulk is served by the S3 batch line); upstream fixes page size at 20 — page via --cursor (next_cursor is echoed back). 0.2.9 audit snapshot (2026-10-28): the search endpoint now returns 401 for anonymous traffic (worked 2026-10-26) while other v4 endpoints stay open — face on watch per the keyless-only ruling; authenticated tiers are 5/min·50/hr·125/day, anonymous numbers unpublished upstream

辖域：US

旗标	必填	说明
--q	否	全文检索词
--case-name	否	案件名过滤
--court	否	法院 id（如 calctapp / scotus）
--judge	否	法官名过滤
--docket-number	否	案号过滤
--filed-after	否	归档日 YYYY-MM-DD 起（含当日）
--filed-before	否	归档日止（含当日）
--order-by	否	排序（如 score desc）
--cursor	否	翻页游标（回填 next_cursor）

csl_screening_list#

Name screening against the US Consolidated Screening List (realtime, local execution): SDN / Entity List / DPL / ITAR / SSI … 12 list families, one keyless CSV, cached 24h and scanned locally (matched_on shows which face hit: name or alt_names). Empty result = clean screening (a legitimate answer)

辖域：US

旗标	必填	说明
--name	否	主体名（子串、不分大小写；同时匹配 name 与 alt_names；必填——缺失时返回 JSON 用法错误信封）
--source	否	名单族过滤，子串（如 "Entity List"、"SDN"、"Sectoral"）
--type	否	主体类型：Entity / Individual / Vessel / Aircraft（不少行不带类型）
--limit	否	返回行数（默认 20，上限 100；total_matched 回显全量命中数）

dgcomp_cases_search#

DG COMP case search: --query raw ES bool DSL (JSON text, XOR with 快捷通道) XOR --name/--instrument 快捷通道 (assembles the SPA's three-field text query / caseInstrument term); pageSize hard cap 100 — upstream silently returns 100 rows for larger asks (probed 2026-10-26)

辖域：EU

旗标	必填	说明
--query	否	原始 ES bool 查询，JSON 文本（例 {"bool":{"must":\[{"term":{"caseInstrument":"SA"}}\]}}）
--name	否	当事人/案件名快捷通道：查 caseTitle 等三个字段（与 --query 二选一；要裸 DSL 用 --query）
--instrument	否	案件类型：AT 反垄断 / M 并购 / SA 国家援助 / DMA 数字市场法
--text	否	附加全文条件（缺省=不加）
--page	否	页码
--limit	否	返回行数，1–100（更大值不报错、仍按 100 返回）

ecfr_search#

eCFR current-code section search (keyless, realtime): where a topic lives in the codified CFR today — counterpart of federalregister_documents (Federal Register = what changed today). coords = seven-level citation; starts_on~ends_on = that version's effective window. 0.2.9 audit: --date = point-in-time retrieval (section versions in force on that date; probed 2026-10-28 asbestos 1,436 current vs 339 at 2024-01-01)

辖域：US

旗标	必填	说明
--q	否	主题词（必填——缺失时返回 JSON 用法错误信封）
--page	否	页码（默认 1）
--limit	否	返回行数（默认 20，上限 100）
--date	否	时点检索 YYYY-MM-DD——取该日仍在效力的条文版本（缺省=现行文本；例：石棉现行 1,436 条，2024-01-01 时点只剩 339 条）

ecfr_titles#

eCFR title catalog (keyless): the 50 CFR titles with latest amendment/issue dates and the library-wide as_of watermark (eCFR integrates daily)

辖域：US

旗标	必填	说明

federalregister_documents#

Federal Register document search: q → conditions[term] verbatim; startdt/enddt auto-completed to a full window when either end is given (a single end is silently ignored upstream); document_number is the stable key, single-doc raw_text_url feeds the corpus batch line. 0.2.9 audit additions: --doc-type closed set validated locally (invalid values silently return 0 rows upstream — false-negative trap), --agencies slug filter, --cfr-title/--cfr-part CFR-anchored narrowing (part requires title), --order gains executive_order_number

辖域：US

旗标	必填	说明
--q	是	检索词（带引号的短语=精确匹配）
--startdt	否	发布日 YYYY-MM-DD 起（只给一端时自动补 1994-01-01）
--enddt	否	发布日止（只给一端时自动补今天）
--order	否	结果顺序：relevance / newest / oldest / executive_order_number（第四值按总统令号排）
--doc-type	否	文件类型，闭集：RULE / PRORULE / NOTICE / PRESDOCU（上游对错值静默回 0 行——本地先拦）
--agencies	否	机构 slug（如 environmental-protection-agency；全表在 GET /api/v1/agencies）
--cfr-title	否	CFR 卷号（如 40=环境保护）
--cfr-part	否	CFR 条号或区间（如 763 或 1-50；须配 --cfr-title）
--page	否	页码
--limit	否	返回行数（上限 50——平台自限，上游允许到 1000）

gb_cma_case#

UK CMA single-case dossier (keyless): content_id is the stable UUID key; change_history = case evolution newest→oldest ([0] = latest, last = First published); attachments = decision/notice PDF family; body_html = case-page summary. A pasted full base_path (/cma-cases/ or absolute URL) is accepted — the prefix is stripped

辖域：GB

旗标	必填	说明
--slug	是	案件页尾段标识（用 cases 结果行里的 slug；直接粘贴整条 gov.uk 链接也会自动剥掉前缀）

gb_cma_cases#

UK CMA case search (gov.uk search API, keyless): q verbatim over case titles (case name = party pair 'A / B'); count politeness cap 100 (upstream has no wall — count=1000 yields the full 1000, probed 2026-10-29); start = offset pagination; omit --q to enumerate the full live register (~2,591 cases). Single-case detail: gb_cma_case with the slug from each row

辖域：GB

旗标	必填	说明
--q	否	案件检索词（打案名/描述；不传=枚举全库约 2,600 案——案名就是当事公司对，如「Google / BeatThatQuote.com」）
--count	否	每页行数 1–100（默认 20；这 100 是我方的礼貌上限，上游本身没有墙）
--start	否	偏移翻页：从第几行开始取（默认 0）

gb_ec_donations#

UK EC donations face: query verbatim (donor/regulated-entity name); from/to window auto-completed when missing (missing window → upstream Total=-1 fake success); rows hard cap 50 (probed 2026-10-26)

辖域：GB

旗标	必填	说明
--query	是	捐赠方/登记主体名（包含匹配；必填）
--from	否	窗口起 YYYY-MM-DD（默认登记起点 2001-02-16）
--to	否	窗口止（默认今天）
--start	否	偏移量
--limit	否	返回行数，1–50（更大值不报错、仍按 50 返回）

gb_ec_loans#

UK EC loans face: query verbatim (lender/borrower name); upstream loans endpoint takes no date-window params; rows hard cap 50 (probed 2026-10-26)

辖域：GB

旗标	必填	说明
--query	是	出借方/借款方名（包含匹配；必填）
--start	否	偏移量
--limit	否	返回行数，1–50（更大值不报错、仍按 50 返回）

gb_gazette_notices#

The Gazette search face (keyless, OGL; 3.58M notices digitised from 1992): event filtering is by notice code — --noticetypes (+-joined upstream; the noticecode= param is SILENTLY IGNORED, probed 2026-11-03) or --insolvency (the corporate-insolvency chapter: 2404/2408/2410/2411/2414/2421-2424/2431/2432/2607/2702). title = the company name on corporate insolvency codes; placed_by = liquidator/administrator or the edition; geo:Point = the registered office. At least one filter required — a bare search is the 4,887,099-notice bulk wall

辖域：GB

旗标	必填	说明
--text	否	全文包含词（公告正文与标题）
--noticetypes	否	公告码，逗号或 + 拼接（如 2410,2432）——事件过滤只认公告码；注意 noticecode= 这个形近参数被上游无视，别处抄来的命令要换成这个
--insolvency	否	公司破产码章预设（13 码：清盘决议/清算人任命/管理人/停业等），与 --noticetypes 并集
--start-date	否	发表窗起 YYYY-MM-DD
--end-date	否	发表窗止 YYYY-MM-DD
--page	否	页码（默认 1）
--page-size	否	每页行数 1–100（默认 20；100 是上游硬帽）
--sort	否	排序：latest-date（默认）或 oldest-date

gb_tna_caselaw_judgment#

UK single-judgment dossier (keyless): neutral_citation is the official key; parties = [{name, role}] official party-to-role edges (claimant/defendant, companies and individuals); judges; text = plain-text body. document_uri takes all three forms — legacy ewhc/admin/2026/2298, new-style d-, tna. — the uri field of gb_tna_caselaw_search rows; a pasted full URL is accepted (prefix and /data.xml suffix stripped)

辖域：GB

旗标	必填	说明
--document-uri	是	判决标识（search 行内 uri 三形均可：旧式 ewhc/admin/2026/2298、新版 d-、tna.；粘贴整条链接也会自动剥壳）

gb_tna_caselaw_search#

UK judgment search (TNA Find Case Law /atom.xml, keyless): eight upstream params verbatim — party/judge are full-word matches over party/judge names, query is full text, court/tribunal are court codes (repeatable, exploded); order in ±date/±updated/±transformation; per_page politeness cap 50 (=upstream default). Rows carry neutral_citation (e.g. [2026] EWHC 2298 (Admin)), uri (machine key for gb_tna_caselaw_judgment) and contenthash. Open Justice Licence: commercial reuse OK, bulk computational analysis forbidden without a (free) licence — keep this a targeted search face

辖域：GB

旗标	必填	说明
--query	否	全文检索词（引号短语=按词序匹配）
--court	否	法院码，可重复（如 uksc ewhc；也可用裁判所码）
--tribunal	否	裁判所码，可重复（court 的别名段，如 eat）
--party	否	当事人名，整词匹配（如 Barclays——半截词不中）
--judge	否	法官名，整词匹配
--order	否	排序：date/-date（默认新在前）/updated/-updated/transformation/-transformation
--page	否	页码（总页数看结果里的 total_pages）
--per-page	否	每页行数 1–50（默认 50=上游缺省，也是我方礼貌档）
--minimum-availability	否	表示层下限：metadata/document/full-text（默认 full-text）

idb_debarred_entities#

IDB sanctioned-firms register (keyless CKAN DataStore, server-side search; live 1,343 rows): q = full-text across all fields, filters = JSON field→value exact matches (e.g. {"To": "Ongoing"} or {"Entity": "Firm"}), offset paging, include_total always on. From arrives as nanosecond text kept verbatim ("2009-07-10 00:00:00.000000000"); Source carries the cross-debarment markers (ADB/WBG cross debarment). Empty result = clean screening (legitimate answer)

辖域：GLOBAL

旗标	必填	说明
--q	否	全字段全文检索（册方原生的 q 参数）
--filters	否	按字段取值过滤，JSON 文本，字段→取值精确匹配（册方原生的 filters 参数），如 {"To": "Ongoing"} 或 {"Entity": "Firm"}
--limit	否	每次返回行数，1–100（默认 20）——册方是实时查询，这就是每页行数
--offset	否	首行之前跳过的行数（册方原生的 offset 参数）；结果里带册方给出的总行数
--sort	否	排序，如 "From desc"（册方原生的 sort 参数）

ie_revenue_defaulters#

Irish Revenue defaulters register (keyless): the statutory quarterly publication — TWO row schemas under one list: part 1 = penalties determined by a court (Issue Type/Fine/Sentence/Charges), part 2 = Revenue settlements (Name/Address/County/Occupation + Tax/Interest/Penalties/Total/Unpaid as ints, comma-thousands stripped). One part per call (--part 1|2); --year + --month select the quarter (march/june/september/december, give both or neither) and default to the latest on the index (current year only). Names/addresses are published by statute — the co_sic precedent; CSV carries a UTF-8 BOM and trailing-space headers (normalised)

辖域：IE

旗标	必填	说明
--part	否	名单部别：1 = 法院判罚（罪名/罚金/刑期/罪数），2 = Revenue 和解（五行金额+未缴）——两部是两张不同的表，结果里的 kind 回显本次行结构（默认 1）
--year	否	发布年（与 --month 成对给；不给=索引最新一季）
--month	否	季度名：march/june/september/december（与 --year 成对给）

lda_filings#

LDA lobbying-disclosure filings: client_name (lobbied company) / registrant_name (lobbying firm) / filing_year all upstream-verbatim (may combine); page_size hard-clamped 25 — upstream silently returns 25 rows for larger asks (probed 2026-10-26); iterate with --page (true offset pagination)

辖域：US

旗标	必填	说明
--client-name	否	被游说企业名（包含匹配）
--registrant-name	否	游说机构名
--filing-year	否	申报年（1999 起）
--page	否	页码（上游每页固定最多 25 行）
--ordering	否	排序（默认 -dt_posted）
--limit	否	返回行数，1–25（更大值不报错、仍按 25 返回）

sipri_trades_search#

SIPRI arms transfers: supplier/recipient country names (快捷通道 — resolves numeric EntityId via the 30-day cached country table; names in the raw filter value1 upstream → 500) XOR --filters raw JSON ({"field": "Supplier"|"Recipient", "listData": [EntityId]}); pageSize cap 100; country-level face, not company-level

辖域：GLOBAL

旗标	必填	说明
--filters	否	原始过滤条件，JSON 文本（例 \[{"field":"Recipient","listData":\[8\]}\]；国别只认数字 id）
--supplier	否	供应国快捷通道：英文全名（如 United States；与 --filters 二选一，国名自动解析为数字 id）
--recipient	否	接收国快捷通道：英文全名（如 Angola；与 --filters 二选一，国名自动解析为数字 id）
--type	否	口径：delivered=交付量（TIV）/ orders=订单量
--page	否	页码
--limit	否	返回行数（上限 100）

us_occ_enforcements#

OCC (Office of the Comptroller of the Currency) monthly enforcement-actions news releases (keyless): the by-year news-release listing picks the Enforcement Actions titles (~11-12 a year; listings verified 2005-2026); default = the latest release of the year. TWO body schemas under one face, form says which: sentences (2024+) = one row per action with cmp_amount scaled from the '$750 million' wording + docket No. (AA-ENF-YYYY-NN — the official key, joins the EASearch database 1989+, out of SDK scope) + IAP prohibition rows (institution-affiliated parties; names are statutory public disclosures — the co_sic precedent); tables (≤2020) = per-section order rows (No./Name-Bank-City/State/Date). --month selects by month name in any era (2026-era titles carry it, earlier listings' MM/DD/YYYY dates do); --all walks every release of the year

辖域：US

旗标	必填	说明
--year	否	年份 2005–今年（逐年新闻发布列表页的范围；默认今年）
--month	否	月份全名 January–December——选该月的执法公告（不给 = 该年最新一份）
--all	否	走该年每一份执法公告（行上带各自的 release_nr）

wb_debarred_firms#

World Bank debarred-firms register (keyless via the page-embedded public apikey): the whole 1,546-row dump is pulled once, cached 24h and scanned locally (same contract as csl_screening_list). SUPP_ELIG_STAT DEBARRED 890 / X-DEBARRED 656; DEBAR_TO_DATE 2999-12-31 = indefinite; DEBAR_REASON cites the procurement-guidelines clause; China leads at 392 firms. The DNB/REGISTER identifier fields ship empty — name × country is the join channel. Empty result = clean screening (legitimate answer)

辖域：GLOBAL

旗标	必填	说明
--name	否	供应商名称——匹配名称的任何一部分，不分大小写
--country	否	国家——匹配国名的任何一部分，或两字母国码精确匹配（China 与 CN 同中）
--type	否	供应商类型：F 企业、I 个人、U 未注明、C 集团（精确匹配，不分大小写）
--limit	否	返回行数，1–100（默认 20）。整册在本地筛查，结果里的 total_matched 是确切命中数

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

procurement（采购数据）#

br_pncp_contracts#

Brazil national procurement contracts (Portal Nacional de Contratações Públicas, keyless): publication-window search over /api/consulta/v1/contratos — every row is buyer CNPJ × supplier CNPJ with the four valor columns; join straight onto the RFB register. data_inicial/data_final (YYYYMMDD or YYYY-MM-DD) and pagina are upstream verbatim (500 rows/page); cnpj_orgao narrows to one buyer. PF (individual) supplier rows carry their identifier and name masked per the PII rule

辖域：BR

旗标	必填	说明
--data-inicial	是	合同窗起，YYYYMMDD 或 YYYY-MM-DD（必填——两个日期端点都要给）
--data-final	是	合同窗止（必填；单月窗约 17.5 万份合同，先用窄窗）
--pagina	否	页码（默认 1；每页固定 500 行=上游默认）
--cnpj-orgao	否	买方 CNPJ 过滤，14 位（可选）

co_secop_contracts#

Colombia SECOP II electronic contracts (datos.gov.co Socrata dataset jbjy-vk9h, keyless): 5.6M+ contracts — buyer NIT × supplier NIT/CC with the valor family; join straight onto the RUES register. where is the raw SoQL $where channel (verbatim pass-through); limit/offset/order mirror $limit/$offset/$order. No total echo — page with offset. Personal-document (Cédula etc.) supplier rows carry their identifier and name masked per the PII rule

辖域：CO

旗标	必填	说明
--where	否	SoQL 过滤表达式（逐字透传；例 upper(nombre_entidad) like '%MINISTERIO%'——% / _ 通配符自己写）
--limit	否	返回行数，1–500（默认 20）
--offset	否	偏移翻页（默认 0；本面无总数字段——翻页自己累计）
--order	否	排序列，可带 ASC / DESC（例 valor_del_contrato DESC；写 NULLS 语法上游 400）

ny_abo_contracts#

New York State authority contracts (data.ny.gov Socrata dataset ehig-g5x3, keyless): 275k+ rows from the Authorities Budget Office universe — buyer authority_name × vendor_name + full address (no UEI/DUNS; name+address walk), four value columns plus MWBE / NYS-business preference flags. where is the raw SoQL $where channel; limit/offset/order mirror $limit/$offset/$order. No total echo — page with offset

辖域：US

旗标	必填	说明
--where	否	SoQL 过滤表达式（逐字透传；例 upper(vendor_name) like '%DELTA%'）
--limit	否	返回行数，1–500（默认 20）
--offset	否	偏移翻页（默认 0；本面无总数字段）
--order	否	排序列，可带 ASC / DESC（例 award_date DESC；写 NULLS 语法上游 400）

ny_mta_procurements#

New York MTA procurements (data.ny.gov Socrata dataset twsw-2mqa, keyless): 107k+ rows — buyer is always the MTA; vendor_name + value family + vendor_is_nys_or_fbe preference flag. where is the raw SoQL $where channel; limit/offset/order mirror $limit/$offset/$order. No total echo — page with offset

辖域：US

旗标	必填	说明
--where	否	SoQL 过滤表达式（逐字透传；例 upper(vendor_name) like '%SKANSKA%'）
--limit	否	返回行数，1–500（默认 20）
--offset	否	偏移翻页（默认 0；本面无总数字段）
--order	否	排序列，可带 ASC / DESC（例 transaction_number DESC；写 NULLS 语法上游 400）

ny_ogs_payments#

New York State Office of General Services design & construction payments (data.ny.gov Socrata dataset rb9h-9fit, keyless): 69k+ payment rows — buyer is always OGS; each row is contractnumber × vendor × paymentamount with fiscalyear/quarter/county (no address columns — name walk). Completes the New York trio (ABO authorities / MTA transport / OGS construction) buyer universe. where is the raw SoQL $where channel; limit/offset/order mirror $limit/$offset/$order. No total echo — page with offset

辖域：US

旗标	必填	说明
--where	否	SoQL 过滤表达式（逐字透传；例 upper(vendor) like '%HIGHLAND%'）
--limit	否	返回行数，1–500（默认 20）
--offset	否	偏移翻页（默认 0；本面无总数字段）
--order	否	排序列，可带 ASC / DESC（例 paymentamount DESC；写 NULLS 语法上游 400）

ungm_contract_awards#

United Nations Global Marketplace contract awards (https://www.ungm.org public search, keyless): ~50k awards across the UN-agency buyer universe (UNDP/UNFPA/ILO/UNOPS...) × global vendors — each row is award id + title/vendor/award date/agency/reference/supplier country. supplier/title/reference/award_from/award_to/countries/agencies/unspscs are upstream verbatim; page_index (1-based) and page_size (1-100, site default 15) page through; newest first by default (sort_field=AwardDate, sort_ascending=false). The ASP.NET anti-forgery session pairing is handled internally (15-minute reuse, auto re-bootstrap on expiry)

辖域：GLOBAL

旗标	必填	说明
--supplier	否	供方名过滤（例 DELTA；上游原名 Supplier）
--title	否	标的内容文本过滤（上游原名 Title）
--reference	否	参考号过滤（例 rfx_11130_ROAP）
--award-from	否	授标日期窗起（站选择器 dd-MMM-yyyy 形；上游 AwardFrom）
--award-to	否	授标日期窗止（上游 AwardTo）
--countries	否	项目国别过滤列表（空格分隔多值；上游 Countries[]）
--agencies	否	UN 机构过滤列表（例 --agencies UNDP ILO；上游 Agencies[]）
--unspscs	否	UNSPSC 商品码过滤列表（上游 UNSPSCs[]）
--page-index	否	页码，1 起（默认 1）
--page-size	否	页大小，1–100（默认 15=站缺省）
--sort-field	否	排序字段（默认 AwardDate；恒非空——空值上游 500）
--sort-ascending	否	升序开关（默认关=最新在前）

wb_procnotices#

World Bank procurement notice stream (search.worldbank.org /api/v2/procnotices, keyless): 313k+ notices across the MDB buyer universe (IBRD/IDA projects in 100+ countries). notice_type/rows/os are upstream verbatim (default: Contract Award); supplier keys are extracted from the embedded award section into awarded_firms[]{name, supp_id} — firm name + WB supplier id, joinable onto the WB debarred list. notice_text itself is not returned (embedded contact details stay out of the face)

辖域：GLOBAL

旗标	必填	说明
--notice-type	否	通知类型（默认 Contract Award=授标通知；上游同键值枚举如 General Procurement Notice）
--rows	否	返回行数，1–100（默认 10）
--os	否	偏移翻页（默认 0；全量 31.3 万条——上游 offset 原名）

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

research（研究数据）#

biorxiv_details#

bioRxiv preprint metadata window stream (realtime, local execution; /details/biorxiv/{from}/{to}/{cursor}; authors arrive as a semicolon-joined string and jatsxml is a full-text XML URL, not inline — full-text bulk belongs to the jatsxml_url links; message counts are strings upstream, normalized here)

辖域：GLOBAL

旗标	必填	说明
--from-date	是	窗口起 YYYY-MM-DD（必填）
--to-date	是	窗口止 YYYY-MM-DD（必填）
--cursor	否	页索引（从 0 起）

crossref_works#

Crossref works search with funder bridge (realtime, local execution; query full-text × funder DOI (filter=funder:) × award_number (filter=award.number:, requires --funder) × from/to publication window combine AND; award numbers live only inside rows' funders[].award — select cannot fetch them (probe: select-not-available); offset+rows ≤ 10,000 documented upstream wall — deep paging switches to --cursor, the official deep-pager channel (0.2.9 audit)

辖域：GLOBAL

旗标	必填	说明
--query	否	全文检索
--funder	否	资助方 DOI（如 10.13039/100000001 = NSF）
--award-number	否	资助编号（须配 --funder）
--from-pub-date	否	发表窗起 YYYY-MM-DD（官方参数 from-pub-date）
--to-pub-date	否	发表窗止 YYYY-MM-DD（官方参数名 until-pub-date，这里镜像为 to）
--rows	否	返回行数（上限 100——平台自限，上游文档到 1000）
--offset	否	偏移量（offset+rows 不得超过 10,000；更深的翻页改走 --cursor——与 --offset 二选一）
--cursor	否	深翻页游标：首页传 *，之后回填上一响应的 next_cursor——绕开 offset 的 1 万行墙（与 --offset 二选一）

gb_gtr_projects#

UK UKRI Gateway to Research projects (realtime, local execution; /projects?q=&s=&p=; s ≥ 10 is an upstream 400 wall; upstream sends no total — full page signals more via has_more; organisation edges live one hop deeper in detail links.link[] rel=LEAD_ORG, this face is the list only)

辖域：GB

旗标	必填	说明
--q	是	检索词（必填）
--s	否	每页行数（至少 10）
--p	否	页码

icite_pubs#

NIH iCite citation-impact card for a PubMed paper (realtime, local execution; /api/pubs?pmids= single record; RCR/FCR/citation counts — the impact hop after nih_reporter_publications hands you a pmid)

辖域：US

旗标	必填	说明
--pmid	是	PubMed id（纯数字，如 26017442；必填）

nih_reporter_projects#

NIH RePORTER project search (realtime, local execution; POST /v2/projects/search; criteria=snake_case and include_fields=camelCase are separately hard-bound upstream — wrong shapes are silently ignored, so bare passthrough is not exposed; org match is exact, not fuzzy; offset+limit cap 15,000)

辖域：US

旗标	必填	说明
--org-name	否	承担机构名（上游精确匹配）
--fiscal-year	否	财政年
--include-fields	否	返回字段，逗号分隔（camelCase；写错上游静默忽略——别指望报错）
--limit	否	每页行数，1–500
--offset	否	偏移量（offset+limit 不得超过 15,000）

nih_reporter_publications#

NIH funding↔publication bridge (realtime, local execution; POST /v2/publications/search; criteria recognizes ONLY pmids/appl_ids — every other key is silently ignored upstream and dumps the whole 8.3M table, so the local gate requires one of the two and no other criteria is passed through; rows are a 3-key bridge {coreproject, pmid, applid}; zero rows = no linkage on record, sparseness is a real answer)

辖域：US

旗标	必填	说明
--pmids	否	PubMed id 列表，逗号分隔
--appl-ids	否	NIH application id 列表（来自 nih_reporter_projects 结果）
--limit	否	每页行数，1–500
--offset	否	偏移量（offset+limit 不得超过 15,000）

nsf_awards#

US NSF awards search (realtime, local execution; keyword full-text XOR id point lookup; rpp 1-200 per upstream doc; upstream sends no total — full page signals more via has_more)

辖域：US

旗标	必填	说明
--keyword	否	全文检索关键词（与 --id 二选一）
--id	否	NSF 资助编号，点查（与 --keyword 二选一）
--rpp	否	每页行数，1–200
--offset	否	偏移量（翻页）

openalex_institutions#

Research-institution candidate search (realtime, local execution; /institutions?search=; same-name multi-country clones coexist — the candidate list is NOT auto-picked: choose the ROR explicitly, then query output via openalex_works --ror)

辖域：GLOBAL

旗标	必填	说明
--search	是	机构名（如 pfizer；必填）
--per-page	否	每页行数，1–200

openalex_works#

Global scholarly works search (realtime, local execution; api.openalex.org/works; search full-text × ror institution edge × doi × title_search combine AND into filter=; per_page 1-200 (explicit upstream 400 wall); cursor pagination via meta.next_cursor — the cursor encodes paging only, so re-send the same constraints when continuing; select is force-merged with core fields so slimming cannot strip id/doi/display_name/authorships/open_access)

辖域：GLOBAL

旗标	必填	说明
--search	否	全文检索词
--ror	否	ROR id（裸 id 或完整 URL 均可；按机构过滤）
--doi	否	DOI 精确匹配
--title-search	否	标题子串匹配
--per-page	否	每页行数，1–200
--cursor	否	翻页游标（回填 next_cursor；续走须带原检索条件）
--select	否	附加返回字段，逗号分隔（核心字段恒在、不会被剥）

opencitations_citations#

OpenCitations COCI citing-DOI list (realtime, local execution; /index/v1/citations/{doi}; doi: prefix and doi.org URLs are normalized away — upstream 400s otherwise; upstream limit param is silently ignored (probe: ?limit=3 still returns all 217) so no fake pagination, the full list comes back with a count)

辖域：GLOBAL

旗标	必填	说明
--doi	是	被引 DOI（doi: 前缀自动剥；必填）

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

security（安全数据）#

cisa_kev_catalog#

CISA Known Exploited Vulnerabilities catalog (realtime, local execution; static feed ~1.8MB; --cve and --ransomware are local post-filters, upstream stays empty-param pure; catalog updates weekly, catalogVersion echoed in reason)

辖域：US

旗标	必填	说明
--cve	否	CVE 号精确查（本地过滤，如 CVE-2021-44228）
--ransomware	否	只看已知勒索软件在利用的条目（本地过滤）
--limit	否	返回行数（默认 50；全量请翻页，勿整拉）

euvd_exploited#

ENISA EU KEV rolling window — vulnerabilities currently exploited in the wild per EU tracking (realtime, local execution; the window refreshes continuously; the 399,311-row full EUVD↔CVE mapping is a raw-side 12MB dump, not this face; --limit is a local slice)

辖域：EU

旗标	必填	说明
--limit	否	返回行数（默认 50；EU KEV 滚动窗小但持续增长）

euvd_vulnerability#

ENISA EUVD single-vulnerability full record by CVE or EUVD code (realtime, local execution; richer than the NVD public face — CVSS vector+version, EPSS inline, exploitedSince, CVE+GHSA aliases, vendor×product×version ranges, EU member-state CSAF advisories; dates are Java-format upstream and ISO-normalized locally; unknown id = 404 carried as not-found)

辖域：EU

旗标	必填	说明
--id	是	CVE 或 EUVD 码（如 CVE-2024-3400 / EUVD-2024-31989；必填）——单条全档点查

osv_vulns#

Open-source package vulnerability query (realtime, local execution; OSV /v1/query POST; ecosystem is a closed set validated locally because upstream silently returns empty for unknown values; version omitted = all known vulns for the package)

辖域：GLOBAL

旗标	必填	说明
--package	是	包名（如 lodash；必填）
--ecosystem	是	包生态（npm / PyPI / Go / Maven / crates.io / RubyGems / NuGet / Packagist / Debian / Alpine / Linux / OSS-Fuzz / Hex / Pub / Conda / Android / GitHub Actions；必填）
--version	否	包版本（缺省=该包全部已知漏洞）
--page-token	否	续页令牌（回填上一响应 result 里的 next_page_token；上游在超 1000 条漏洞或 20 秒时分页）

search#

Corpus search (hosted, PAT required): filters/record_kind/level/pagination

旗标	必填	说明
--filter	否	筛选条件 K=V，可重复传多次（可用字段见本页筛选字段表）
--record-kind	否	记录类型（闭集，取值见本域规格）
--facets	否	要计数的字段，逗号分隔（响应带 facets 计数）
--level	否	读取分层深度（默认 tier1；分层含义见本页读取分层）
--limit	否	每页行数（默认 50，上限 1000）
--cursor	否	翻页游标（回填上一响应的 next_cursor）
--mode	否	特殊模式：screen=批量筛查（须配 --input）
--input	否	批量筛查的输入 JSONL 文件（配 --mode screen）

read#

Corpus single-record read (hosted): id + T-layer depth

旗标	必填	说明
--id	是	主体 id（search 结果行里的 id）
--level	否	读取分层深度（默认 tier1）

错误与限额#

CLI 退出码#

exit	族	语义
0	成功	正常输出
1	上游/可用性	上游不可达/限流/未找到、能力不可用、云端 429
2	用法	参数形状错、kind 未识、未配凭证、请求 4xx

SDK 错误码（闭集）#

SdkError(code, detail, provider?, status?, retry_after?)——错误码集合固定（闭集），可以穷举分支处理。 快速判断：exit 1 → 网络/上游/限流问题（按 Retry-After 或稍后重试）；exit 2 → 检查参数与凭证。

• exit 1（上游/可用性族）：capability_unavailable / rate_limited / thirdparty_rate_limited / thirdparty_upstream_unavailable / upstream_not_found / upstream_rate_limited / upstream_unavailable
• exit 2（用法族）：usage_error / resolve_kind_unknown / op_unknown / 语料契约 4xx（unauthenticated / forbidden / undeclared_field / bad_value …）

HTTP 状态码（云端 API）#

HTTP	code	触发
400	undeclared_field / bad_operator / record_kind_unknown / cursor_invalid / limit_out_of_range / bad_value	请求形状/取值错
401	unauthenticated	Bearer PAT 缺失/无效
403	forbidden	PAT 未授权该域
404	unknown_target	read 的 id 不在域内（未覆盖 ≠ 不存在）
429	rate_limited	超每 key 配额（带 Retry-After，到点重试即可）
502/503	thirdparty_upstream_unavailable / thirdparty_rate_limited / capability_unavailable	上游异常（上游限流时透传上游 Retry-After）

注：个别上游在你的网络环境不可达时，SDK 归一为 upstream_unavailable 并附排查提示，不盲目重试。