National Library of Medicine

opencollection: 1.0.0
info:
  name: NCBI E-utilities API
  version: '1.0'
items:
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Search a database
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi
      params:
      - name: db
        value: ''
        type: query
        description: Database to search (e.g. pubmed, pmc, gene, protein, nuccore).
      - name: term
        value: ''
        type: query
        description: Entrez text query, URL-encoded.
      - name: usehistory
        value: ''
        type: query
        description: Set to 'y' to post UIDs to the History server.
      - name: retmax
        value: ''
        type: query
        description: Maximum number of UIDs to return (default 20, max 10000).
      - name: retstart
        value: ''
        type: query
        description: Sequential index of the first UID to return (zero-based).
      - name: retmode
        value: ''
        type: query
        description: Output format.
      - name: api_key
        value: ''
        type: query
        description: NCBI API key for higher rate limits.
    docs: Returns a list of UIDs matching a text query, optionally posting the results to the Entrez History server for downstream
      operations.
  - info:
      name: Global cross-database query
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/egquery.fcgi
      params:
      - name: term
        value: ''
        type: query
    docs: Returns the number of records in every Entrez database matching a single text query.
- info:
    name: Retrieve
    type: folder
  items:
  - info:
      name: Fetch full records by UID
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi
      params:
      - name: db
        value: ''
        type: query
      - name: id
        value: ''
        type: query
        description: Comma-separated list of UIDs or a WebEnv/query_key reference.
      - name: rettype
        value: ''
        type: query
        description: Retrieval type (e.g. abstract, fasta, gb, medline).
      - name: retmode
        value: ''
        type: query
        description: Retrieval mode (e.g. xml, text, json, asn.1).
      - name: api_key
        value: ''
        type: query
    docs: Returns formatted data records for a list of UIDs.
  - info:
      name: Retrieve document summaries
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/esummary.fcgi
      params:
      - name: db
        value: ''
        type: query
      - name: id
        value: ''
        type: query
      - name: version
        value: ''
        type: query
        description: Set to '2.0' for the newer DocSum schema.
      - name: retmode
        value: ''
        type: query
    docs: Returns document summaries for a list of input UIDs.
- info:
    name: Discovery
    type: folder
  items:
  - info:
      name: Database statistics and field metadata
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/einfo.fcgi
      params:
      - name: db
        value: ''
        type: query
      - name: retmode
        value: ''
        type: query
    docs: Returns the list of all valid Entrez databases or, when 'db' is supplied, statistics and indexing fields for that
      database.
  - info:
      name: Find related records across Entrez databases
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/elink.fcgi
      params:
      - name: dbfrom
        value: ''
        type: query
      - name: db
        value: ''
        type: query
      - name: id
        value: ''
        type: query
      - name: linkname
        value: ''
        type: query
      - name: cmd
        value: ''
        type: query
        description: Command mode (neighbor, neighbor_history, llinks, prlinks, etc.).
    docs: Returns UIDs in a destination database linked to UIDs in a source database, including computed neighbors and external
      LinkOut links.
  - info:
      name: Spelling suggestions for a query term
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/espell.fcgi
      params:
      - name: db
        value: ''
        type: query
      - name: term
        value: ''
        type: query
    docs: Returns NCBI-suggested corrections for a misspelled query term.
  - info:
      name: Match citations to PubMed UIDs
      type: http
    http:
      method: GET
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/ecitmatch.cgi
      params:
      - name: db
        value: ''
        type: query
      - name: rettype
        value: ''
        type: query
      - name: bdata
        value: ''
        type: query
        description: Pipe-delimited citation strings.
    docs: Resolves bibliographic citation strings to PubMed UIDs.
- info:
    name: History
    type: folder
  items:
  - info:
      name: Post UIDs to the Entrez History server
      type: http
    http:
      method: POST
      url: https://eutils.ncbi.nlm.nih.gov/entrez/eutils/epost.fcgi
      params:
      - name: db
        value: ''
        type: query
      - name: id
        value: ''
        type: query
    docs: Uploads a list of UIDs and returns a WebEnv and query_key for downstream calls.
bundled: true