RCSB PDB

RCSB PDB General API

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

GitHub OpenAPI

Operations 21

GET /v1/{id}/assembly Computes structural assembly. #
POST /v1/{id}/assembly Computes structural assembly. #
GET /v1/{id}/atoms Atoms satisfying the given criteria. #
POST /v1/{id}/atoms Atoms satisfying the given criteria. #
GET /v1/{id}/full The full structure. #
POST /v1/{id}/full The full structure. #
GET /v1/{id}/ligand Coordinates of the first group satisfying the given criteria. #
POST /v1/{id}/ligand Coordinates of the first group satisfying the given criteria. #
GET /v1/{id}/residueInteraction Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account. #
POST /v1/{id}/residueInteraction Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account. #
GET /v1/{id}/residueSurroundings Identifies all residues within the given radius from the source residue. #
POST /v1/{id}/residueSurroundings Identifies all residues within the given radius from the source residue. #
GET /v1/{id}/surroundingLigands Identifies (complete) ligands within the given radius from the source atom set. Takes crystal symmetry into account. #
POST /v1/{id}/surroundingLigands Identifies (complete) ligands within the given radius from the source atom set. Takes crystal symmetry into account. #
GET /v1/{id}/symmetryMates Computes crystal symmetry mates within the specified radius. #
POST /v1/{id}/symmetryMates Computes crystal symmetry mates within the specified radius. #
GET /v1/query-many Executes multiple queries at the same time and writes them as separate data blocks. #
POST /v1/query-many Executes multiple queries at the same time and writes them as separate data blocks. #
GET /{source}/{id}/ Returns a JSON response specifying if data is available and the maximum region that can be queried. #
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. #
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. #

Documentation

📖
Documentation
https://search.rcsb.org/redoc/index.html
📖
GettingStarted
https://www.rcsb.org/docs/programmatic-access/web-apis-overview
📖
Documentation
https://models.rcsb.org
📖
Documentation
https://maps.rcsb.org

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pdb/refs/heads/main/openapi/pdb-general-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/pdb-general-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

pdb-general-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.9.12
  title: ModelServer General API
  description: The ModelServer is a service for accessing subsets of macromolecular model data.
servers:
- url: https://data.rcsb.org/rest/v1/core
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: General
paths:
  /v1/{id}/assembly:
    get:
      tags:
      - General
      summary: Computes structural assembly.
      operationId: assembly
      parameters:
      - $ref: '#/components/parameters/id'
      - name: name
        in: query
        description: Assembly name.
        required: false
        schema:
          type: string
          default: '1'
        style: simple
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      responses:
        '200':
          description: Computes structural assembly.
          content:
            text/plain: {}
            application/octet-stream: {}
    post:
      tags:
      - General
      summary: Computes structural assembly.
      operationId: assembly-post
      parameters:
      - $ref: '#/components/parameters/id'
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              name: '1'
      responses:
        '200':
          description: Computes structural assembly.
          content:
            text/plain: {}
            application/octet-stream: {}
  /v1/{id}/atoms:
    get:
      tags:
      - General
      summary: Atoms satisfying the given criteria.
      operationId: atoms
      parameters:
      - $ref: '#/components/parameters/id'
      - name: label_entity_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: auth_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: pdbx_PDB_ins_code
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: type_symbol
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      responses:
        '200':
          description: Atoms satisfying the given criteria.
          content:
            text/plain: {}
            application/octet-stream: {}
    post:
      tags:
      - General
      summary: Atoms satisfying the given criteria.
      operationId: atoms-post
      parameters:
      - $ref: '#/components/parameters/id'
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              atom_site:
              - label_seq_id: 30
                label_asym_id: A
              - label_seq_id: 31
                label_asym_id: A
      responses:
        '200':
          description: Atoms satisfying the given criteria.
          content:
            text/plain: {}
            application/octet-stream: {}
  /v1/{id}/full:
    get:
      tags:
      - General
      summary: The full structure.
      operationId: full
      parameters:
      - $ref: '#/components/parameters/id'
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      responses:
        '200':
          description: The full structure.
          content:
            text/plain: {}
            application/octet-stream: {}
    post:
      tags:
      - General
      summary: The full structure.
      operationId: full-post
      parameters:
      - $ref: '#/components/parameters/id'
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example: {}
      responses:
        '200':
          description: The full structure.
          content:
            text/plain: {}
            application/octet-stream: {}
  /v1/{id}/ligand:
    get:
      tags:
      - General
      summary: Coordinates of the first group satisfying the given criteria.
      operationId: ligand
      parameters:
      - $ref: '#/components/parameters/id'
      - name: label_entity_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: auth_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: pdbx_PDB_ins_code
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: type_symbol
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      responses:
        '200':
          description: Coordinates of the first group satisfying the given criteria.
          content:
            text/plain: {}
            application/octet-stream: {}
    post:
      tags:
      - General
      summary: Coordinates of the first group satisfying the given criteria.
      operationId: ligand-post
      parameters:
      - $ref: '#/components/parameters/id'
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              atom_site:
              - label_seq_id: 30
                label_asym_id: A
              - label_seq_id: 31
                label_asym_id: A
      responses:
        '200':
          description: Coordinates of the first group satisfying the given criteria.
          content:
            text/plain: {}
            application/octet-stream: {}
  /v1/{id}/residueInteraction:
    get:
      tags:
      - General
      summary: Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account.
      operationId: residueInteraction
      parameters:
      - $ref: '#/components/parameters/id'
      - name: label_entity_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: auth_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: pdbx_PDB_ins_code
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: type_symbol
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: radius
        in: query
        description: Value in Angstroms.
        required: false
        schema:
          type: number
          default: 5
        style: simple
      - name: assembly_name
        in: query
        description: Assembly name. If none is provided, crystal symmetry (where available) or deposited model is used.
        required: false
        schema:
          type: string
        style: simple
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      responses:
        '200':
          description: Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account.
          content:
            text/plain: {}
            application/octet-stream: {}
    post:
      tags:
      - General
      summary: Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account.
      operationId: residueInteraction-post
      parameters:
      - $ref: '#/components/parameters/id'
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided data source ID maps to input file (as specified by the server instance config).
        required: false
        schema:
          type: string
          default: ''
        style: simple
      - name: transform
        in: query
        description: Transformation to apply to coordinates in '_atom_site'. Accepts a 4x4 transformation matrix, provided as array of 16 float values.
        required: false
        schema:
          type: string
        style: simple
      - name: download
        in: query
        description: If true, browser will download text files.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: filename
        in: query
        description: Controls the filename for downloaded files. Will force download if specified.
        required: false
        schema:
          type: string
          default: ''
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              atom_site:
              - label_seq_id: 30
                label_asym_id: A
              - label_seq_id: 31
                label_asym_id: A
              radius: 5
      responses:
        '200':
          description: Identifies all residues within the given radius from the source residue. Takes crystal symmetry into account.
          content:
            text/plain: {}
            application/octet-stream: {}
  /v1/{id}/residueSurroundings:
    get:
      tags:
      - General
      summary: Identifies all residues within the given radius from the source residue.
      operationId: residueSurroundings
      parameters:
      - $ref: '#/components/parameters/id'
      - name: label_entity_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_asym_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_comp_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: auth_seq_id
        in: query
        required: false
        schema:
          type: integer
        style: simple
      - name: pdbx_PDB_ins_code
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: label_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: auth_atom_id
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: type_symbol
        in: query
        required: false
        schema:
          type: string
        style: simple
      - name: radius
        in: query
        description: Value in Angstroms.
        required: false
        schema:
          type: number
          default: 5
        style: simple
      - name: model_nums
        in: query
        description: A comma-separated list of model ids (i.e. 1,2). If set, only include atoms with the corresponding '_atom_site.pdbx_PDB_model_num' field.
        required: false
        schema:
          type: string
        style: simple
      - name: encoding
        in: query
        description: Determines the output encoding (text based 'CIF' or binary 'BCIF'). Ligands can also be exported as 'SDF', 'MOL', or 'MOL2'.
        required: false
        schema:
          type: string
          enum:
          - cif
          - bcif
          - sdf
          - mol
          - mol2
          default: cif
        style: simple
      - name: copy_all_categories
        in: query
        description: If true, copy all categories from the input file.
        required: false
        schema:
          type: boolean
          default: false
        style: simple
      - name: data_source
        in: query
        description: Allows to control how the provided 

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pdb/refs/heads/main/openapi/pdb-general-api-openapi.yml