RCSB RESTful API (1.48.1)

Download OpenAPI specification:Download

RCSB PDB: info@rcsb.org URL: www.rcsb.org

Provides programmatic access to information and annotations stored in the Protein Data Bank.
Models are generated from JSON schema version: 1.48.1.
API services deployed on: Mon, 27 Jan 2025 11:33:45 -0800

Assembly Service

provides access to information about structures at the quaternary structure level

Get structural assembly description by ENTRY ID and ASSEMBLY ID.

path Parameters
entry_id
required
string
Example: 1RH7

ENTRY ID of the entry.

assembly_id
required
string
Example: 1

ASSEMBLY ID of the biological assembly candidate.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "pdbx_struct_assembly": {
    },
  • "pdbx_struct_assembly_auth_evidence": [
    ],
  • "pdbx_struct_assembly_gen": [
    ],
  • "pdbx_struct_assembly_prop": [
    ],
  • "pdbx_struct_oper_list": [
    ],
  • "rcsb_assembly_container_identifiers": {
    },
  • "rcsb_assembly_info": {
    },
  • "rcsb_id": "1KIP-1\n",
  • "rcsb_struct_symmetry": [
    ],
  • "rcsb_struct_symmetry_provenance_code": "string",
  • "rcsb_struct_symmetry_lineage": [
    ],
  • "rcsb_assembly_feature": [
    ],
  • "rcsb_assembly_annotation": [
    ],
  • "rcsb_latest_revision": {
    }
}

Entity Service

provides access to information about structures at the level of unique molecular entities

Get branched entity description by ENTRY ID and ENTITY ID.

path Parameters
entry_id
required
string
Example: 4CYG

ID of the entry that needs to be fetched.

entity_id
required
string
Example: 2

ID of the entity that needs to be fetched.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_cluster_membership": [
    ],
  • "entity_poly": {
    },
  • "entity_src_gen": [
    ],
  • "entity_src_nat": [
    ],
  • "pdbx_entity_src_syn": [
    ],
  • "rcsb_entity_host_organism": [
    ],
  • "rcsb_entity_source_organism": [
    ],
  • "rcsb_polymer_entity": {
    },
  • "rcsb_polymer_entity_align": [
    ],
  • "rcsb_polymer_entity_annotation": [
    ],
  • "rcsb_polymer_entity_container_identifiers": {
    },
  • "rcsb_polymer_entity_feature": [
    ],
  • "rcsb_polymer_entity_feature_summary": [
    ],
  • "rcsb_polymer_entity_keywords": {
    },
  • "rcsb_polymer_entity_name_com": [
    ],
  • "rcsb_polymer_entity_name_sys": [
    ],
  • "rcsb_related_target_references": [
    ],
  • "rcsb_target_cofactors": [
    ],
  • "rcsb_id": "6EL3_1\n",
  • "rcsb_polymer_entity_group_membership": [
    ],
  • "rcsb_genomic_lineage": [
    ],
  • "rcsb_membrane_lineage": [
    ],
  • "rcsb_membrane_lineage_provenance_code": "Mpstruc",
  • "rcsb_cluster_flexibility": {
    },
  • "rcsb_latest_revision": {
    }
}

Get non-polymer entity data by ENTRY ID and ENTITY ID.

path Parameters
entry_id
required
string
Example: 4G22

ENTRY ID of the entry.

entity_id
required
string
Example: 2

ENTITY ID of the non-polymer entity.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "pdbx_entity_nonpoly": {
    },
  • "rcsb_nonpolymer_entity": {
    },
  • "rcsb_nonpolymer_entity_annotation": [
    ],
  • "rcsb_nonpolymer_entity_container_identifiers": {
    },
  • "rcsb_nonpolymer_entity_feature": [
    ],
  • "rcsb_nonpolymer_entity_feature_summary": [
    ],
  • "rcsb_nonpolymer_entity_keywords": {
    },
  • "rcsb_nonpolymer_entity_name_com": [
    ],
  • "rcsb_id": "6EL3_1\n",
  • "rcsb_latest_revision": {
    }
}

Get polymer entity data by ENTRY ID and ENTITY ID.

path Parameters
entry_id
required
string
Example: 4G22

ENTRY ID of the entry.

entity_id
required
string
Example: 1

ENTITY ID of the polymer entity.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_cluster_membership": [
    ],
  • "entity_poly": {
    },
  • "entity_src_gen": [
    ],
  • "entity_src_nat": [
    ],
  • "pdbx_entity_src_syn": [
    ],
  • "rcsb_entity_host_organism": [
    ],
  • "rcsb_entity_source_organism": [
    ],
  • "rcsb_polymer_entity": {
    },
  • "rcsb_polymer_entity_align": [
    ],
  • "rcsb_polymer_entity_annotation": [
    ],
  • "rcsb_polymer_entity_container_identifiers": {
    },
  • "rcsb_polymer_entity_feature": [
    ],
  • "rcsb_polymer_entity_feature_summary": [
    ],
  • "rcsb_polymer_entity_keywords": {
    },
  • "rcsb_polymer_entity_name_com": [
    ],
  • "rcsb_polymer_entity_name_sys": [
    ],
  • "rcsb_related_target_references": [
    ],
  • "rcsb_target_cofactors": [
    ],
  • "rcsb_id": "6EL3_1\n",
  • "rcsb_polymer_entity_group_membership": [
    ],
  • "rcsb_genomic_lineage": [
    ],
  • "rcsb_membrane_lineage": [
    ],
  • "rcsb_membrane_lineage_provenance_code": "Mpstruc",
  • "rcsb_cluster_flexibility": {
    },
  • "rcsb_latest_revision": {
    }
}

Get UniProt annotations for a given macromolecular entity (identified by ENTRY ID and ENTITY ID).

path Parameters
entry_id
required
string
Example: 4G22

ENTRY ID of the entry.

entity_id
required
string
Example: 1

ENTITY ID of the polymer entity.

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • {
    }
]

Entity Instance Service

provides access to information about structures at the level of unique molecular instances (chains)

Get branched entity instance description by ENTRY ID and ASYM ID.

path Parameters
entry_id
required
string
Example: 1US2

ID of the entry that needs to be fetched.

asym_id
required
string
Example: C

ID of the instance (chain) that needs to be fetched.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "pdbx_struct_special_symmetry": [
    ],
  • "pdbx_vrpt_summary_entity_fit_to_map": [
    ],
  • "pdbx_vrpt_summary_entity_geometry": [
    ],
  • "rcsb_ligand_neighbors": [
    ],
  • "rcsb_polymer_entity_instance_container_identifiers": {
    },
  • "rcsb_polymer_instance_annotation": [
    ],
  • "rcsb_polymer_instance_feature": [
    ],
  • "rcsb_polymer_instance_feature_summary": [
    ],
  • "rcsb_polymer_struct_conn": [
    ],
  • "struct_asym": {
    },
  • "rcsb_id": "1KIP.A\n",
  • "rcsb_latest_revision": {
    }
}

Get non-polymer entity instance description by ENTRY ID and ASYM ID (label_asym_id).

path Parameters
entry_id
required
string
Example: 2FBW

ENTRY ID of the entry.

asym_id
required
string
Example: J

ASYM ID (label_asym_id) of the instance (chain).

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "pdbx_struct_special_symmetry": [
    ],
  • "pdbx_vrpt_summary_entity_fit_to_map": [
    ],
  • "pdbx_vrpt_summary_entity_geometry": [
    ],
  • "rcsb_nonpolymer_entity_instance_container_identifiers": {
    },
  • "rcsb_nonpolymer_instance_annotation": [
    ],
  • "rcsb_nonpolymer_instance_feature": [
    ],
  • "rcsb_nonpolymer_instance_feature_summary": [
    ],
  • "rcsb_nonpolymer_instance_validation_score": [
    ],
  • "rcsb_nonpolymer_struct_conn": [
    ],
  • "rcsb_target_neighbors": [
    ],
  • "struct_asym": {
    },
  • "rcsb_id": "1KIP.A\n",
  • "rcsb_latest_revision": {
    }
}

Get polymer entity instance (a.k.a chain) data by ENTRY ID and ASYM ID (label_asym_id).

path Parameters
entry_id
required
string
Example: 2FBW

ENTRY ID of the entry.

asym_id
required
string
Example: E

ASYM ID (label_asym_id) of the instance (chain).

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "pdbx_struct_special_symmetry": [
    ],
  • "pdbx_vrpt_summary_entity_fit_to_map": [
    ],
  • "pdbx_vrpt_summary_entity_geometry": [
    ],
  • "rcsb_ligand_neighbors": [
    ],
  • "rcsb_polymer_entity_instance_container_identifiers": {
    },
  • "rcsb_polymer_instance_annotation": [
    ],
  • "rcsb_polymer_instance_feature": [
    ],
  • "rcsb_polymer_instance_feature_summary": [
    ],
  • "rcsb_polymer_struct_conn": [
    ],
  • "struct_asym": {
    },
  • "rcsb_id": "1KIP.A\n",
  • "rcsb_latest_revision": {
    }
}

Chemical Component Service

provides access to information about chemical components from which the relevant chemical structures can be constructed.

Get chemical component (ligands, small molecules and monomers) by CCD ID.

path Parameters
comp_id
required
string
Example: CFF

CHEM COMP ID that uniquely identifies the chemical component. For protein polymer entities, this is the three-letter code for the amino acid. For nucleic acid polymer entities, this is the one-letter code for the base.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "chem_comp": {
    },
  • "pdbx_chem_comp_audit": [
    ],
  • "pdbx_chem_comp_descriptor": [
    ],
  • "pdbx_chem_comp_feature": [
    ],
  • "pdbx_chem_comp_identifier": [
    ],
  • "pdbx_family_prd_audit": [
    ],
  • "pdbx_prd_audit": [
    ],
  • "pdbx_reference_entity_list": [
    ],
  • "pdbx_reference_entity_poly": [
    ],
  • "pdbx_reference_entity_poly_link": [
    ],
  • "pdbx_reference_entity_poly_seq": [
    ],
  • "pdbx_reference_entity_sequence": [
    ],
  • "pdbx_reference_entity_src_nat": [
    ],
  • "pdbx_reference_molecule": {
    },
  • "pdbx_reference_molecule_annotation": [
    ],
  • "pdbx_reference_molecule_details": [
    ],
  • "pdbx_reference_molecule_family": {
    },
  • "pdbx_reference_molecule_features": [
    ],
  • "pdbx_reference_molecule_list": [
    ],
  • "pdbx_reference_molecule_related_structures": [
    ],
  • "pdbx_reference_molecule_synonyms": [
    ],
  • "rcsb_bird_citation": [
    ],
  • "rcsb_chem_comp_annotation": [
    ],
  • "rcsb_chem_comp_container_identifiers": {
    },
  • "rcsb_chem_comp_descriptor": {
    },
  • "rcsb_chem_comp_info": {
    },
  • "rcsb_chem_comp_related": [
    ],
  • "rcsb_chem_comp_synonyms": [
    ],
  • "rcsb_chem_comp_target": [
    ],
  • "rcsb_schema_container_identifiers": [
    ],
  • "rcsb_id": "ATP, PRD_000010\n"
}

Get DrugBank annotations (integrated from DrugBank resource) for a given chemical component (identified by CHEM COMP ID) .

path Parameters
comp_id
required
string
Example: CFF

CHEM COMP ID that uniquely identifies the chemical component. For protein polymer entities, this is the three-letter code for the amino acid. For nucleic acid polymer entities, this is the one-letter code for the base.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "drugbank_container_identifiers": {
    },
  • "drugbank_info": {
    },
  • "drugbank_target": [
    ]
}

Entry Service

provides access to information about structures at the top entry level

Get structure by ENTRY ID.

path Parameters
entry_id
required
string
Example: 4ACQ

ENTRY ID of the entry.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "audit_author": [
    ],
  • "cell": {
    },
  • "citation": [
    ],
  • "diffrn": [
    ],
  • "diffrn_detector": [
    ],
  • "diffrn_radiation": [
    ],
  • "diffrn_source": [
    ],
  • "em_2d_crystal_entity": [
    ],
  • "em_3d_crystal_entity": [
    ],
  • "em_3d_fitting": [
    ],
  • "em_3d_fitting_list": [
    ],
  • "em_3d_reconstruction": [
    ],
  • "em_ctf_correction": [
    ],
  • "em_diffraction": [
    ],
  • "em_diffraction_shell": [
    ],
  • "em_diffraction_stats": [
    ],
  • "em_embedding": [
    ],
  • "em_entity_assembly": [
    ],
  • "em_experiment": {
    },
  • "em_helical_entity": [
    ],
  • "em_image_recording": [
    ],
  • "em_imaging": [
    ],
  • "em_particle_selection": [
    ],
  • "em_single_particle_entity": [
    ],
  • "em_software": [
    ],
  • "em_specimen": [
    ],
  • "em_staining": [
    ],
  • "em_vitrification": [
    ],
  • "entry": {
    },
  • "exptl": [
    ],
  • "exptl_crystal": [
    ],
  • "exptl_crystal_grow": [
    ],
  • "ma_data": [
    ],
  • "pdbx_SG_project": [
    ],
  • "pdbx_audit_revision_category": [
    ],
  • "pdbx_audit_revision_details": [
    ],
  • "pdbx_audit_revision_group": [
    ],
  • "pdbx_audit_revision_history": [
    ],
  • "pdbx_audit_revision_item": [
    ],
  • "pdbx_audit_support": [
    ],
  • "pdbx_database_PDB_obs_spr": [
    ],
  • "pdbx_database_related": [
    ],
  • "pdbx_database_status": {
    },
  • "pdbx_deposit_group": [
    ],
  • "pdbx_initial_refinement_model": [
    ],
  • "pdbx_molecule_features": [
    ],
  • "pdbx_nmr_details": {
    },
  • "pdbx_nmr_ensemble": {
    },
  • "pdbx_nmr_exptl": [
    ],
  • "pdbx_nmr_exptl_sample_conditions": [
    ],
  • "pdbx_nmr_refine": [
    ],
  • "pdbx_nmr_representative": {
    },
  • "pdbx_nmr_sample_details": [
    ],
  • "pdbx_nmr_software": [
    ],
  • "pdbx_nmr_spectrometer": [
    ],
  • "pdbx_reflns_twin": [
    ],
  • "pdbx_related_exp_data_set": [
    ],
  • "pdbx_serial_crystallography_data_reduction": [
    ],
  • "pdbx_serial_crystallography_measurement": [
    ],
  • "pdbx_serial_crystallography_sample_delivery": [
    ],
  • "pdbx_serial_crystallography_sample_delivery_fixed_target": [
    ],
  • "pdbx_serial_crystallography_sample_delivery_injection": [
    ],
  • "pdbx_soln_scatter": [
    ],
  • "pdbx_soln_scatter_model": [
    ],
  • "pdbx_vrpt_summary": {
    },
  • "pdbx_vrpt_summary_diffraction": [
    ],
  • "pdbx_vrpt_summary_em": [
    ],
  • "pdbx_vrpt_summary_geometry": [
    ],
  • "pdbx_vrpt_summary_nmr": [
    ],
  • "rcsb_accession_info": {
    },
  • "rcsb_comp_model_provenance": {
    },
  • "rcsb_entry_container_identifiers": {
    },
  • "rcsb_entry_info": {
    },
  • "rcsb_ma_qa_metric_global": [
    ],
  • "rcsb_primary_citation": {
    },
  • "refine": [
    ],
  • "refine_analyze": [
    ],
  • "refine_hist": [
    ],
  • "refine_ls_restr": [
    ],
  • "reflns": [
    ],
  • "reflns_shell": [
    ],
  • "software": [
    ],
  • "struct": {
    },
  • "struct_keywords": {
    },
  • "symmetry": {
    },
  • "rcsb_id": "1KIP\n",
  • "rcsb_entry_group_membership": [
    ],
  • "rcsb_external_references": [
    ],
  • "rcsb_binding_affinity": [
    ]
}

Get PubMed annotations (data integrated from PubMed) for a given entry's primary citation.

path Parameters
entry_id
required
string
Example: 4ACQ

ENTRY ID of the entry.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_id": "string",
  • "rcsb_pubmed_container_identifiers": {
    },
  • "rcsb_pubmed_central_id": "string",
  • "rcsb_pubmed_doi": "string",
  • "rcsb_pubmed_abstract_text": "string",
  • "rcsb_pubmed_affiliation_info": [
    ],
  • "rcsb_pubmed_mesh_descriptors": [
    ],
  • "rcsb_pubmed_mesh_descriptors_lineage": [
    ]
}

Groups Service

provides access to groups formed by aggregating individual structures, sequences or assemblies that share a degree of similarity

PDB cluster data based upon a given aggregation method

path Parameters
group_id
required
string
Example: Q3Y9I6

Group ID

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_id": "string",
  • "rcsb_group_container_identifiers": {
    },
  • "rcsb_group_info": {
    },
  • "rcsb_group_statistics": {
    },
  • "rcsb_group_accession_info": {
    },
  • "rcsb_group_related": [
    ]
}

Describes aggregation method used to create groups

path Parameters
group_provenance_id
required
string
Example: provenance_sequence_identity

Group provenance ID

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_id": "string",
  • "rcsb_group_provenance_container_identifiers": {
    },
  • "rcsb_group_aggregation_method": {
    }
}

PDB cluster data based upon a given aggregation method

path Parameters
group_id
required
string
Example: Q3Y9I6

Group ID

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_id": "string",
  • "rcsb_group_container_identifiers": {
    },
  • "rcsb_group_info": {
    },
  • "rcsb_group_statistics": {
    },
  • "rcsb_group_accession_info": {
    },
  • "rcsb_group_related": [
    ],
  • "rcsb_polymer_entity_group_members_rankings": [
    ],
  • "rcsb_polymer_entity_group_sequence_alignment": {
    }
}

Interface Service

provides access to information about pairwise polymeric interfaces present in assemblies

Get pairwise polymeric interface description by ENTRY ID, ASSEMBLY ID and INTERFACE ID.

path Parameters
entry_id
required
string
Example: 1RH7

ENTRY ID of the entry.

assembly_id
required
string
Example: 1

ASSEMBLY ID of the biological assembly.

interface_id
required
string
Example: 1

INTERFACE ID of the pairwise polymeric interface.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_id": "string",
  • "rcsb_interface_container_identifiers": {
    },
  • "rcsb_interface_partner": [
    ],
  • "rcsb_interface_operator": [
    ],
  • "rcsb_interface_info": {
    },
  • "rcsb_latest_revision": {
    }
}

Repository Holdings Service

provides access to information about holdings in the PDB repository.

Get the list of current entry IDs.

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • "string"
]

Get the status and status code of a structure.

path Parameters
entry_id
required
string

ID of the entry that needs to be fetched.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_repository_holdings_combined": {
    },
  • "rcsb_repository_holdings_combined_entry_container_identifiers": {
    },
  • "rcsb_id": "1KIP\n"
}

Get the status and status code of a list of entry IDs.

query Parameters
ids
required
string

A comma separated entry ID list.

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • {
    }
]

Get the description of the structure that was removed from the PDB repository.

path Parameters
entry_id
required
string
Example: 1HHB

ID of the entry that needs to be fetched.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_repository_holdings_insilico_models": {
    },
  • "rcsb_repository_holdings_removed": {
    },
  • "rcsb_repository_holdings_removed_audit_author": [
    ],
  • "rcsb_repository_holdings_removed_entry_container_identifiers": {
    },
  • "rcsb_repository_holdings_superseded": {
    },
  • "rcsb_repository_holdings_transferred": {
    },
  • "rcsb_id": "1KIP\n"
}

Get the list of removed entry IDs.

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • "string"
]

Get a list of unreleased structures with descriptions.

query Parameters
ids
required
string

A comma separated unreleased entry ID list.

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • {
    }
]

Get the description of unreleased structure that is being processed or on hold waiting for release.

path Parameters
entry_id
required
string

ID of the entry that needs to be fetched.

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "rcsb_repository_holdings_prerelease": [
    ],
  • "rcsb_repository_holdings_unreleased": {
    },
  • "rcsb_repository_holdings_unreleased_entry_container_identifiers": {
    },
  • "rcsb_id": "1KIP\n"
}

Get the list of unreleased entry IDs.

Responses

Response samples

Content type
application/json;charset=utf-8
[
  • "string"
]

Schema Service

Provides access to the RCSB PDB data schemas. The data schema is powered by the JSON Schema (json-schema.org) language.

Get assembly schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get branched instance schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get branched entity schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get chemical component/BIRD schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get DrugBank (integrated data) schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get entry schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get non-polymer instance schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get non-polymer entity schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get polymer instance schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get polymer entity schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get PubMed (integrated data) schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"

Get UniProt (integrated data) schema.

Responses

Response samples

Content type
application/json;charset=utf-8
"string"