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 Institutes of Health (NIH) BioSample API

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

National Institutes of Health (NIH) BioSample API is one of 15 APIs that National Institutes of Health (NIH) 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 and API documentation.

This API exposes 1 operation across 1 path, and defines 24 schemas. It is described by OpenAPI 3.0.3, at version 2.0.5.

Requests are made against a single base URL, https://clinicaltrials.gov/api/v2.

1 operations 1 paths 24 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.5
Base URL
https://eutils.ncbi.nlm.nih.gov/entrez/eutils/
Resource Areas
1

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), v2reportsError (8 properties), v2reportsOrganism (8 properties), v2reportsInfraspecificNames (6 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nih-biosample-api-openapi.yml Raw ↑

Other APIs National Institutes of Health (NIH) publishes across the network.

NCBI E-utilities (Entrez Programming Utilities)
PubChem Power User Gateway (PUG REST)
NIH RePORTER API
NCBI BLAST URL API
PubMed Central (PMC) OA API
National Institutes of Health (NIH) Gene API
National Institutes of Health (NIH) Genome API
National Institutes of Health (NIH) Organelle API
National Institutes of Health (NIH) Prokaryote API
National Institutes of Health (NIH) Stats API
National Institutes of Health (NIH) Studies API
National Institutes of Health (NIH) Taxonomy API