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

#### Options to download BioSample data.This BioSample service allows you to get BioSample data as a data report.

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

This API exposes 1 operation across 1 path, and defines 24 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.

1 operations 1 paths 24 schemas 1 GET

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) BioSample 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 1

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

BioSample 1

Options to download BioSample data. This BioSample service allows you to get BioSample data as a data report.

GET
/biosample/accession/{accessions}/biosample_report
Get BioSample dataset reports by accession(s)
BioSample_dataset_report 1 param → default200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are v2reportsBioSampleDataReport (38 properties), v2reportsOrganism (8 properties), v2reportsError (8 properties), v2reportsInfraspecificNames (6 properties). Each schema is shown below with its type and property counts.

v2reportsInfraspecificNames
object
6 properties
v2reportsBioSampleStatus
object
2 properties
v2reportsWarning
object
5 properties
v2reportsBioSampleId
object
3 properties
v2reportsBioSampleOwner
object
2 properties
v2reportsErrorGeneErrorCode
string
v2reportsOrganism
object
8 properties
v2reportsBioSampleAttribute
object
2 properties
v2reportsErrorAssemblyErrorCode
string
v2reportsBioSampleDescription
object
3 properties
v2reportsErrorVirusErrorCode
string
v2reportsErrorTaxonomyErrorCode
string
rpcStatus
object
3 properties
v2reportsBioSampleDataReportPage
object
4 properties
v2reportsError
object
8 properties
v2reportsBioSampleDataReport
object
38 properties
v2reportsLineageOrganism
object
2 properties
v2reportsMessage
object
2 properties
v2reportsWarningGeneWarningCode
string
v2reportsErrorOrganelleErrorCode
string
v2reportsBioSampleContact
object
1 property
v2reportsBioProject
object
4 properties
protobufAny
object
2 properties
v2reportsWarningReplacedId
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncbi-biosample-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) Gene API
National Center for Biotechnology Information (NCBI) Genome API
National Center for Biotechnology Information (NCBI) Organelle 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