nquire(1)

nquire1

Query ncbi entrez utilities, other parameter-based web services, or ftp

Usage

nquire [-help] [-ftp host dir [file]] [-url URL] [-get [URL]] [-len URL] [-lst host dir] [-dir host dir] [-eutils name] [-dwn host dir [file]] [-asp host dir [file]] [{-ncbi | -eutils | -pubchem | -pugrest | -pugview | -datasets}] [component ...] [-tag value ...] [-examples] [-version]

Overview

nquire performs raw HTTP(S) queries against web services such as NCBI E-Utilities that take GET or POST parameters, or downloads or listings from FTP and Aspera servers. (Aspera support requires installing proprietary client software.)

Options

Documentation

-help

Print usage information, complete with a few examples, some additionally illustrating the use of xtract(1).

Query Commands

-ftp host dir [file]

Use FTP instead of HTTP. The shell implementation accepts a filename on the command line only when invoked from a (pseudo)terminal, and otherwise reads filenames from standard input.

-url URL

Base URL for external search.

-get [URL]

Use HTTP(S) GET instead of POST.

-len URL

Content length of HTTP file.

-lst host dir

Lists contents of FTP site.

-dir host dir

FTP listing with file sizes.

File Downloads

-dwn host dir [file]

Like -ftp, but saves contents to correspondingly named files in the current directory.

-asp host dir [file]

Like -dwn, but uses Aspera's proprietary client if installed.

-url Shortcuts

-ncbi

https://www.ncbi.nlm.nih.gov

-eutils

https://eutils.ncbi.nlm.nih.gov/entrez/eutils

-pubchem

https://pubchem.ncbi.nlm.nih.gov

-pugrest

https://pubchem.ncbi.nlm.nih.gov/rest/pug

-pugview

https://pubchem.ncbi.nlm.nih.gov/rest/pug_view

-datasets

https://api.ncbi.nlm.nih.gov/datasets/v2alpha

URL Additions

component

Add /component to the base URL. (Must precede any tag/value pairs.)

-tag value ...

Add &tag=value,... to the base URL. (Must follow any simple components.)

Miscellaneous

-examples

Examples of advanced queries.

-version

Print version number.

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

-datasets since Debian 13 (Trixie); -eutils since Debian 12 (Bookworm); -examples since Debian 10 (Buster); -len since Debian 12 (Bookworm); -ncbi since Debian 12 (Bookworm); -pubchem since Debian 12 (Bookworm); -pugrest since Debian 12 (Bookworm); -pugview since Debian 12 (Bookworm); -version since Debian 10 (Buster).

From ncbi-entrez-direct 24.0.20250523+dfsg-1+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.