Research data#

Realtime queries over research funding and scholarly output, ten faces: funded projects (US NSF, NIH RePORTER, UK UKRI GtR), scholarly works (OpenAlex, Crossref, bioRxiv) and citation impact (NIH iCite, OpenCitations) — the full chain from institution to project to paper to citation, with stable keys (ROR / pmid / DOI) that hand off face to face. All commands run locally on your machine with no credentials: no platform-side quota, each upstream's own limits apply, and repeats within a cache lifetime are served from your local cache without hitting it.

Realtime queries#

One section per face: what it answers, the full parameter table and the boundaries. Commands are the flat two-segment names (<domain> <provider>_<dataset>); this domain's corpus faces search / read are documented in the CLI reference.

biorxiv_details#

**Answers:**bioRxiv preprint metadata — stream every preprint inside a date window.

Parameters：

Flag	Required	Meaning
--from-date	yes	Window start YYYY-MM-DD (required)
--to-date	yes	Window end YYYY-MM-DD (required)
--cursor	no	Page index (starts at 0)

**Boundary:**both date endpoints are required; authors arrive as a semicolon-joined string; jatsxml is a URL to full-text XML, not inline content — fetch the full text through that link; upstream counts are strings, normalized to numbers locally.

crossref_works#

**Answers:**Crossref works search with a funder bridge — funder DOI × award number filters which papers a grant funded.

Parameters：

Flag	Required	Meaning
--query	no	Full-text query
--funder	no	Funder DOI, e.g. 10.13039/100000001 = NSF
--award-number	no	Award / grant number (requires --funder)
--from-pub-date	no	Publication window start YYYY-MM-DD (official param from-pub-date)
--to-pub-date	no	Publication window end YYYY-MM-DD (the official param is until-pub-date, mirrored to to here)
--rows	no	Rows (cap 100 — a platform-side limit; the upstream documents 1000)
--offset	no	Result offset (offset+rows ≤ 10,000; for deeper pages switch to --cursor — XOR with --offset)
--cursor	no	Deep-paging cursor: * for the first page, then feed next_cursor — bypasses the 10,000-row offset wall (XOR with --offset)

**Boundary:**award numbers live only inside rows' funders[].award (select cannot fetch them); --award-number requires --funder; offset+rows must stay within 10,000 (documented upstream wall) — deeper paging goes through --cursor (first page *, then echo next_cursor back).

gb_gtr_projects#

**Answers:**The UK research-funding project store (Gateway to Research) — keyword project search; organisation edges sit one hop deeper in the details.

Parameters：

Flag	Required	Meaning
--q	yes	Search term (required)
--s	no	Page size (at least 10)
--p	no	Page number

**Boundary:**page size is at least 10 (smaller gets a 400 upstream); no total upstream — a full page signals more; this face is the list only, LEAD_ORG organisation edges live in the detail links.link[] (rel=LEAD_ORG).

icite_pubs#

**Answers:**The impact card for one PubMed paper — RCR/FCR and citation counts, the hop after the bridge hands you a pmid.

Parameters：

Flag	Required	Meaning
--pmid	yes	PubMed id, digits only, e.g. 26017442 (required)

**Boundary:**a single-pmid point lookup (bare digits); not a bulk face — score a batch by collecting pmids from the bridge first, then query one by one.

nih_reporter_projects#

**Answers:**The NIH funded-projects store — project-level records by recipient organization × fiscal year.

Parameters：

Flag	Required	Meaning
--org-name	no	Receiving organization name (exact match upstream)
--fiscal-year	no	Fiscal year
--include-fields	no	Comma-separated camelCase fields (wrong names are silently ignored upstream)
--limit	no	Page size, 1–500
--offset	no	Result offset (offset+limit ≤ 15,000)

**Boundary:**criteria is snake_case and include_fields camelCase — wrong shapes are silently ignored upstream (no error); organization match is exact, not fuzzy; offset+limit must stay within 15,000.

nih_reporter_publications#

**Answers:**The project ↔ paper bridge — hand it pmids or applids, get back 3-key rows of which project links which paper; the hop after nih_reporter_projects.

Parameters：

Flag	Required	Meaning
--pmids	no	Comma-separated PubMed ids
--appl-ids	no	Comma-separated NIH application ids (from nih_reporter_projects)
--limit	no	Page size, 1–500
--offset	no	Result offset (offset+limit ≤ 15,000)

**Boundary:**criteria recognizes only pmids / appl_ids (any other key is silently ignored upstream and dumps the whole table — hence the local one-of-two gate); zero rows = no linkage on record, sparseness is a real answer.

nsf_awards#

**Answers:**US NSF award grants — keyword full-text search, or a single award by its id.

Parameters：

Flag	Required	Meaning
--keyword	no	Full-text search keyword (XOR with --id)
--id	no	NSF award id, point lookup (XOR with --keyword)
--rpp	no	Rows per page, 1–200
--offset	no	Result offset (pagination)

Boundary:--keyword and --id are mutually exclusive; 1–200 rows per page; upstream sends no total — a full page signals more via has_more.

openalex_institutions#

**Answers:**Institution name → ROR candidates — pick the ROR, then query output on openalex_works via --ror.

Parameters：

Flag	Required	Meaning
--search	yes	Institution name, e.g. pfizer (required)
--per-page	no	Rows per page, 1–200

Boundary:--search is required; candidates are non-authoritative — same-name branches in different countries each list separately (a university's campuses are distinct records), disambiguate by country / alias before use.

openalex_works#

**Answers:**The global scholarly-works index — full-text search AND-combinable with institution (ROR), DOI and title-substring filters.

Parameters：

Flag	Required	Meaning
--search	no	Full-text search term
--ror	no	ROR id (bare or full URL; filters by institution)
--doi	no	DOI exact match
--title-search	no	Title substring match
--per-page	no	Rows per page, 1–200
--cursor	no	Cursor from next_cursor (re-send the same constraints)
--select	no	Extra fields to return, comma-separated (core fields are always merged in)

**Boundary:**1–200 rows per page; paging goes through meta.next_cursor — the cursor encodes paging only, so re-send the original constraints when continuing; select is force-merged with core fields, so id/doi/display_name/authorships/open_access cannot be stripped.

opencitations_citations#

**Answers:**Cited DOI → every DOI citing it — the one-hop citation edge from the open COCI store.

Parameters：

Flag	Required	Meaning
--doi	yes	Cited DOI (the doi: prefix is auto-stripped; required)

**Boundary:**the upstream limit param is silently ignored (probed: limit 3 still returns the full list) — so no fake pagination, the full list comes back in one call with a count; doi: prefixes and doi.org URLs are stripped automatically (otherwise a 400 upstream).

Flat commands at a glance#

The command surface of this domain is the flat, two-part names (<domain> <provider>_<dataset>) — the table below lists every direct-lookup face. This table is generated from the CLI's own --help, so it tracks the code exactly; full parameter tables are in the CLI reference.

Command	Jurisdiction	What it answers
research biorxiv_details	GLOBAL	bioRxiv preprint metadata window (by date range)
research crossref_works	GLOBAL	Crossref works search with funder bridge (funder DOI)
research gb_gtr_projects	GB	UKRI funded-project search (Gateway to Research)
research icite_pubs	US	Per-paper citation-impact card (NIH iCite, RCR/FCR)
research nih_reporter_projects	US	NIH funded-project search (RePORTER)
research nih_reporter_publications	US	NIH funding ↔ publication bridge (3-key rows)
research nsf_awards	US	US NSF award search (keyword full-text / id point lookup)
research openalex_institutions	GLOBAL	Research-institution candidates (OpenAlex, ROR-keyed)
research openalex_works	GLOBAL	Global scholarly works search (OpenAlex)
research opencitations_citations	GLOBAL	Cited DOI → full citing-DOI list (OpenCitations)