pdbsearch.queries

pdbsearch.queries.query(return_type, node=None, **request_options)[source]

Queries the RCSB search API.

Parameters:
  • return_type (str) – the type of data to return.

  • node (Node) – the node to query.

  • return_all (bool) – whether to return all results, unpaginated.

  • start (int) – the start index of the results.

  • rows (int) – the number of results to return.

  • sort (str or list[str]) – the attribute or attributes to sort by.

  • counts_only (bool) – whether to return only the count of results.

  • content_types (list[str]) – the PDB types (experimental/computational).

  • facets (list[str]) – RCSB aggregation terms.

Return type:

dict