Rcsb

RCSB PDB Data API

Provides programmatic access to information and annotations stored in the Protein Data Bank. Models are generated from JSON schema version: 1.61.2

Data & analytics#science--math

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Provides programmatic access to information and annotations stored in the Protein Data Bank. Models are generated from JSON schema version: 1.61.2

Endpoints 41

Chemical Component Service

  • GETGet DrugBank annotations (integrated from DrugBank resource) for a given chemical component (identified by CHEM COMP ID) ./rest/v1/core/drugbank/:comp_id
  • GETGet chemical component (ligands, small molecules and monomers) by CCD ID./rest/v1/core/chemcomp/:comp_id

Entity Instance Service

  • GETGet polymer entity instance (a.k.a chain) data by ENTRY ID and ASYM ID (label_asym_id)./rest/v1/core/polymer_entity_instance/:entry_id/:asym_id
  • GETGet non-polymer entity instance description by ENTRY ID and ASYM ID (label_asym_id)./rest/v1/core/nonpolymer_entity_instance/:entry_id/:asym_id
  • GETGet branched entity instance description by ENTRY ID and ASYM ID./rest/v1/core/branched_entity_instance/:entry_id/:asym_id

Entity Service

  • GETGet UniProt annotations for a given macromolecular entity (identified by ENTRY ID and ENTITY ID)./rest/v1/core/uniprot/:entry_id/:entity_id
  • GETGet polymer entity data by ENTRY ID and ENTITY ID./rest/v1/core/polymer_entity/:entry_id/:entity_id
  • GETGet non-polymer entity data by ENTRY ID and ENTITY ID./rest/v1/core/nonpolymer_entity/:entry_id/:entity_id
  • GETGet branched entity description by ENTRY ID and ENTITY ID./rest/v1/core/branched_entity/:entry_id/:entity_id

Entry Service

  • GETGet PubMed annotations (data integrated from PubMed) for a given entry's primary citation./rest/v1/core/pubmed/:entry_id
  • GETGet structure by ENTRY ID./rest/v1/core/entry/:entry_id

Interface Service

  • GETGet pairwise polymeric interface description by ENTRY ID, ASSEMBLY ID and INTERFACE ID./rest/v1/core/interface/:entry_id/:assembly_id/:interface_id

Schema Service

  • GETGet UniProt (integrated data) schema./rest/v1/schema/uniprot
  • GETGet PubMed (integrated data) schema./rest/v1/schema/pubmed
  • GETGet polymer instance schema./rest/v1/schema/polymer_entity_instance
  • GETGet polymer entity schema./rest/v1/schema/polymer_entity
  • GETGet non-polymer instance schema./rest/v1/schema/nonpolymer_entity_instance
  • GETGet non-polymer entity schema./rest/v1/schema/nonpolymer_entity
  • GETGet entry schema./rest/v1/schema/entry
  • GETGet DrugBank (integrated data) schema./rest/v1/schema/drugbank
  • GETGet chemical component/BIRD schema./rest/v1/schema/chem_comp
  • GETGet branched instance schema./rest/v1/schema/branched_entity_instance
  • GETGet branched entity schema./rest/v1/schema/branched_entity
  • GETGet assembly schema./rest/v1/schema/assembly

Repository Holdings Service

  • GETGet a list of unreleased structures with descriptions./rest/v1/holdings/unreleased?ids=string
  • GETGet the description of unreleased structure that is being processed or on hold waiting for release./rest/v1/holdings/unreleased/:entry_id
  • GETGet the list of unreleased entry IDs./rest/v1/holdings/unreleased/entry_ids
  • GETGet the status and status code of a list of entry IDs./rest/v1/holdings/status?ids=string
  • GETGet the status and status code of a structure./rest/v1/holdings/status/:entry_id
  • GETGet the description of the structure that was removed from the PDB repository./rest/v1/holdings/removed/:entry_id
  • GETGet the list of removed entry IDs./rest/v1/holdings/removed/entry_ids
  • GETGet the list of current PRD IDs for BIRD entries./rest/v1/holdings/current/prd_ids
  • GETGet the list of current entry IDs./rest/v1/holdings/current/entry_ids
  • GETGet the list of current CCD IDs./rest/v1/holdings/current/ccd_ids

Groups Service

  • GETGet a group object that aggregates all polymer entities associated with the specified UniProt ID or sequence cluster ID/rest/v1/core/polymer_entity_groups/:group_id
  • GETGet a group object that aggregates all non-polymer entities associated with the specified Chemical Component ID/rest/v1/core/nonpolymer_entity_groups/:group_id
  • GETDescribes aggregation method used to create groups/rest/v1/core/group_provenance/:group_provenance_id
  • GETGet a group object that aggregates all entries associated with the specified PDB Group Deposition ID/rest/v1/core/entry_groups/:group_id

Assembly Service

  • GETGet structural assembly description by ENTRY ID and ASSEMBLY ID./rest/v1/core/assembly/:entry_id/:assembly_id

graph-ql-controller

  • GETexecuteGet/graphql?query=string
  • POSTexecutePost/graphql

API details

Authentication
None declared in the description
Operations
41 operations on 40 pathsGET 40POST 1
Main resources
Schema Service 12Repository Holdings Service 10Entity Service 4Groups Service 4Entity Instance Service 3Chemical Component Service 2Entry Service 2graph-ql-controller 2Assembly Service 1Interface Service 1
Response formats
application/json;charset=utf-8 */* application/json
Description format
OpenAPI 3.0.1, API version 1.61.2

How to test the RCSB PDB Data API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the RCSB PDB Data API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get DrugBank annotations (integrated from DrugBank resource) for a given chemical component (identified by CHEM COMP ID) .” (GET /rest/v1/core/drugbank/:comp_id), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the RCSB PDB Data API?

Provides programmatic access to information and annotations stored in the Protein Data Bank. Models are generated from JSON schema version: 1.61.2 It is listed under Data & analytics and has 41 endpoints.

Who publishes the RCSB PDB Data API?

It is listed from Rcsb's public API description (an OpenAPI document), not published by Rcsb on Swastik Codes. Anyone who controls data.rcsb.org can claim the profile by adding a DNS TXT record.

How do I authenticate with the RCSB PDB Data API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the RCSB PDB Data API have?

41 operations on 40 paths (40 GET, 1 POST). The largest groups are Schema Service, Repository Holdings Service, Entity Service, Groups Service.

Is forking the RCSB PDB Data API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.