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) Organelle API

#### Options to download RefSeq organelle genome data, including the associated sequence and metadata.These organelle services allow you to get RefSeq organelle genome metadata as a data report or download gene, transcript and protein sequence, and metadata, as an organelle data package, for RefSeq organelle genomes.

National Center for Biotechnology Information (NCBI) Organelle 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 Organelle. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and rate-limit docs.

This API exposes 5 operations across 5 paths, and defines 31 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.

5 operations 5 paths 31 schemas 3 GET2 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) Organelle 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 5

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

Organelle 5

Options to download RefSeq organelle genome data, including the associated sequence and metadata. These organelle services allow you to get RefSeq organelle genome metadata as a d…

GET
/organelle/accession/{accessions}/download
Get an organelle data package by nucleotide accession
download_organelle_package 3 params → default200
POST
/organelle/download
Get an organelle data package
download_organelle_package_by_post 1 param body → default200
GET
/organelle/accessions/{accessions}/dataset_report
Get an organelle data report by nucleotide accession
organelle_datareport_by_accession 9 params → default200
GET
/organelle/taxon/{taxons}/dataset_report
Get an organelle data report by taxon
organelle_datareport_by_taxon 12 params → default200
POST
/organelle/dataset_report
Get an organelle data report
organelle_datareport_by_post body → default200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are v2OrganelleMetadataRequest (12 properties), v2reportsOrganelle (10 properties), v2reportsError (8 properties), v2reportsOrganism (8 properties). Each schema is shown below with its type and property counts.

v2reportsInfraspecificNames
object
6 properties
v2OrganelleMetadataRequestOrganelleTableFormat
string
v2reportsWarning
object
5 properties
v2reportsErrorGeneErrorCode
string
v2OrganelleMetadataRequestContentType
string
v2reportsOrganelleDataReports
object
4 properties
v2OrganelleSort
object
2 properties
v2reportsOrganelleBiosample
object
1 property
v2reportsOrganism
object
8 properties
v2reportsOrganelleTopology
string
v2reportsOrganelleGeneCounts
object
5 properties
v2reportsErrorAssemblyErrorCode
string
v2reportsErrorVirusErrorCode
string
v2AnnotationForOrganelleType
string
v2IncludeTabularHeader
string
v2reportsErrorTaxonomyErrorCode
string
rpcStatus
object
3 properties
v2reportsError
object
8 properties
v2OrganelleDownloadRequest
object
3 properties
v2reportsLineageOrganism
object
2 properties
v2OrganelleMetadataRequest
object
12 properties
v2reportsMessage
object
2 properties
v2reportsSequenceInformation
object
3 properties
v2reportsOrganelle
object
10 properties
v2reportsWarningGeneWarningCode
string
v2reportsOrganelleType
string
v2reportsErrorOrganelleErrorCode
string
v2reportsBioProject
object
4 properties
v2SortDirection
string
protobufAny
object
2 properties
v2reportsWarningReplacedId
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncbi-organelle-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) Prokaryote API
National Center for Biotechnology Information (NCBI) Taxonomy API
National Center for Biotechnology Information (NCBI) Version API