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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

RCSB PDB

RCSB PDB General API

The General API from RCSB PDB — 12 operation(s) for general.

Documentation Provider Profile APIs.io OpenAPI GitHub

RCSB PDB General API is one of 7 APIs that RCSB PDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include General. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 21 operations across 12 paths, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 0.9.12.

Requests are made against the base URL https://data.rcsb.org/rest/v1/core.

21 operations 12 paths 1 schemas 12 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.9.12
Base URL
https://data.rcsb.org/rest/v1/core
Resource Areas
1

Paths & Operations 21

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

General 21
GET
/v1/{id}/assembly
Computes structural assembly.
assembly 9 params → 200
POST
/v1/{id}/assembly
Computes structural assembly.
assembly-post 8 params body → 200
GET
/v1/{id}/atoms
Atoms satisfying the given criteria.
atoms 19 params → 200
POST
/v1/{id}/atoms
Atoms satisfying the given criteria.
atoms-post 8 params body → 200
GET
/v1/{id}/full
The full structure.
full 8 params → 200
POST
/v1/{id}/full
The full structure.
full-post 8 params body → 200
GET
/v1/{id}/ligand
Coordinates of the first group satisfying the given criteria.
ligand 19 params → 200
POST
/v1/{id}/ligand
Coordinates of the first group satisfying the given criteria.
ligand-post 8 params body → 200
GET
/v1/{id}/residueInteraction
Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account.
residueInteraction 21 params → 200
POST
/v1/{id}/residueInteraction
Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account.
residueInteraction-post 8 params body → 200
GET
/v1/{id}/residueSurroundings
Identifies all residues within the given radius from the source residue.
residueSurroundings 20 params → 200
POST
/v1/{id}/residueSurroundings
Identifies all residues within the given radius from the source residue.
residueSurroundings-post 8 params body → 200
GET
/v1/{id}/surroundingLigands
Identifies (complete) ligands within the given radius from the source atom set. Takes crystal symmetry into account.
surroundingLigands 22 params → 200
POST
/v1/{id}/surroundingLigands
Identifies (complete) ligands within the given radius from the source atom set. Takes crystal symmetry into account.
surroundingLigands-post 8 params body → 200
GET
/v1/{id}/symmetryMates
Computes crystal symmetry mates within the specified radius.
symmetryMates 9 params → 200
POST
/v1/{id}/symmetryMates
Computes crystal symmetry mates within the specified radius.
symmetryMates-post 8 params body → 200
GET
/v1/query-many
Executes multiple queries at the same time and writes them as separate data blocks.
query-many 1 param → 200
POST
/v1/query-many
Executes multiple queries at the same time and writes them as separate data blocks.
query-many-post body → 200
GET
/{source}/{id}/
Returns a JSON response specifying if data is available and the maximum region that can be queried.
getInfo 2 params → 200
GET
/{source}/{id}/box/{a1,a2,a3}/{b1,b2,b3}/
Returns density data inside the specified box for the given entry. For X-ray data, returns 2Fo-Fc and Fo-Fc volumes in a single response.
getBox 7 params → 200
GET
/{source}/{id}/cell/
Returns (downsampled) volume data for the entire "data cell". For X-ray data, returns unit cell of 2Fo-Fc and Fo-Fc volumes, for EM data returns everything.
getCell 4 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is info (9 properties). Each schema is shown below with its type and property counts.

info
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pdb-general-api-openapi.yml Raw ↑

Other APIs RCSB PDB publishes across the network.

RCSB PDB Data API
AE Profile APIs.io
RCSB PDB Sequence Coordinates API
AE Profile APIs.io
RCSB PDB Structure Alignment API
AE Profile APIs.io
RCSB PDB Metadata Service API
AE Profile APIs.io
RCSB PDB Search Service API
AE Profile APIs.io
RCSB PDB Suggest Service API
AE Profile APIs.io
#General
← Back to R APIs
API Details
ID
pdb:pdb-general-api
Base URL
https://data.rcsb.org/rest/v1/core
Docs
https://data.rcsb.org
Provider
RCSB PDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network