RCSB Search API (2.5.0)

Download OpenAPI specification:Download

E-mail: info@rcsb.org License: Apache 2.0

Provides programmatic access to RCSB search API.

Search Service

Released data search API endpoint allows you to perform GET requests with textual and scientific searches against current RCSB PDB entries

query Parameters
required
object (Search Query)

Search query. Must be URL-encoded.

Responses

Response samples

Content type
application/json
{
  • "query_id": "string",
  • "result_type": "entry",
  • "total_count": 1,
  • "group_by_count": 1,
  • "ungrouped_count": 1,
  • "explain_metadata": {
    },
  • "result_set": [
    ],
  • "facets": [
    ],
  • "group_by": {
    },
  • "group_set": [
    ]
}

Released data search API endpoint allows you to perform POST requests with textual and scientific searches against current RCSB PDB entries

Request Body schema: application/json
object (Request Info) non-empty

Information about the query.

object (Request Options)
return_type
required
string (Return Type)
Enum: "entry" "polymer_entity" "non_polymer_entity" "polymer_instance" "assembly" "mol_definition"

Specifies the type of the returned identifiers.

Group Node (object) or Terminal Node (object)

Any valid query string as per the Search Aggregator query syntax is permitted. A search consists of one or more groups combined.

Responses

Request samples

Content type
application/json
{
  • "request_info": {
    },
  • "request_options": {
    },
  • "return_type": "entry",
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "query_id": "string",
  • "result_type": "entry",
  • "total_count": 1,
  • "group_by_count": 1,
  • "ungrouped_count": 1,
  • "explain_metadata": {
    },
  • "result_set": [
    ],
  • "facets": [
    ],
  • "group_by": {
    },
  • "group_set": [
    ]
}

Unreleased data search API endpoint allows you to perform GET requests with textual searches against RCSB PDB unreleased entries

query Parameters
required
object (Unreleased Entry Search Query)

Search query. Must be URL-encoded.

Responses

Response samples

Content type
application/json
{
  • "query_id": "string",
  • "result_type": "unreleased_entry",
  • "total_count": 0,
  • "explain_metadata": {
    },
  • "result_set": [
    ],
  • "facets": [
    ]
}

Suggest Service

Provides auto-complete/search-as-you-type functionality.

query Parameters
required
object (Suggest Query)

Suggest query. Must be URL-encoded.

Responses

Response samples

Content type
application/json
{
  • "took": 0,
  • "suggestions": {
    }
}

Metadata Service

Get RCSB PDB unreleased entry schema.

Responses

Get RCSB PDB structure data schema as JSON Schema.

Responses

Get RCSB PDB chemical data schema as JSON Schema.

Responses