OpenAPI 3.0 REST API

NCBI Datasets REST API

OpenAPI 3.0 REST API

NCBI Datasets REST API

The OpenAPI 3.0 Specification is an open-source format for describing and documenting APIs. An OpenAPI 3.0 specification serves as the core definition for the public Datasets interfaces, and is the single access mechanism used by all Datasets-based applications.

The NCBI Datasets OpenAPI 3.0 spec is available in YAML format, and can be utilized by a variety of open-source tools and other software frameworks to generate client code for interacting with the REST API in a way that is idiomatic for the target language or environment.

An API key is a unique string (value) that you include in your HTTP requests that identifies you to NCBI servers. API keys offer enhanced levels of access to NCBI APIs. Any IP address posting more than three requests per second to Datasets without an API key will receive an error message. Including an API key, an IP address can post up to ten requests per second. If you expect your usage to exceed ten requests/second, please contact us and we can negotiate a higher rate limit.

You can obtain an API key from the Settings page of your NCBI account (to create an account, visit https://account.ncbi.nlm.nih.gov/signup/). After creating the key, include it in each request by assigning it to the api_key parameter.

Generated October 14, 2021