Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

National Center for Biotechnology Information (NCBI) Prokaryote API

#### Options to download prokaryote gene data, including the associated sequence and metadata.These gene services allow you to download gene and protein sequence, and metadata as a prokaryote gene data package, for prokaryotic [RefSeq non-redundant proteins](https://www.ncbi.nlm.nih.gov/refseq/about/nonredundantproteins/).

National Center for Biotechnology Information (NCBI) Prokaryote API is one of 14 APIs that National Center for Biotechnology Information (NCBI) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Prokaryote. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version v2.

Requests are made against a single base URL, https://api.ncbi.nlm.nih.gov/datasets/v2.

2 operations 2 paths 5 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v2
Base URL
https://eutils.ncbi.nlm.nih.gov/entrez/eutils/
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

National Center for Biotechnology Information (NCBI) Prokaryote API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (ApiKeyAuth). An API key is passed in the header as api-key (ApiKeyAuthHeader). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Prokaryote 2

Options to download prokaryote gene data, including the associated sequence and metadata. These gene services allow you to download gene and protein sequence, and metadata as a pr…

GET
/protein/accession/{accessions}/download
Get a prokaryote gene data package by RefSeq protein accession
download_prokaryote_gene_package 5 params → default200
POST
/protein/accession/download
Get a prokaryote gene data package by RefSeq protein accession
download_prokaryote_gene_package_post 1 param body → default200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are v2ProkaryoteGeneRequest (4 properties), rpcStatus (3 properties), protobufAny (2 properties), v2ProkaryoteGeneRequestGeneFlankConfig (1 property). Each schema is shown below with its type and property counts.

v2ProkaryoteGeneRequestGeneFlankConfig
object
1 property
rpcStatus
object
3 properties
v2Fasta
string
v2ProkaryoteGeneRequest
object
4 properties
protobufAny
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncbi-prokaryote-api-openapi.yml Raw ↑

Other APIs National Center for Biotechnology Information (NCBI) publishes across the network.

NCBI Entrez E-utilities API
NCBI BLAST URL API
PubChem PUG REST API
PMC Open Access API (OA Service)
PMC ID Converter API
PMC OAI-PMH Service
National Center for Biotechnology Information (NCBI) BioSample API
National Center for Biotechnology Information (NCBI) Gene API
National Center for Biotechnology Information (NCBI) Genome API
National Center for Biotechnology Information (NCBI) Organelle API
National Center for Biotechnology Information (NCBI) Taxonomy API
National Center for Biotechnology Information (NCBI) Version API