Skip to main content

Programmatic access to the biocentral ecosystem.

Project description

biocentral_api - Python Client

Python API package for biocentral.

Installation

pip install biocentral-api

Basic Usage

Embedding protein sequences:

from biocentral_api import BiocentralAPI, CommonEmbedder

biocentral_api = BiocentralAPI()

# ProtT5
embedder_name = CommonEmbedder.ProtT5
reduce = True
sequence_data = {"Seq1": "MMALSLALM"}
result = biocentral_api.embed(embedder_name=embedder_name, reduce=reduce, sequence_data=sequence_data,
                              use_half_precision=False).run()
print(result)

For more examples, please refer to the examples folder.

Service Limitations

The following limitations are currently in place:

  • Sequence Limit: The embed() API has a limit of 1,000 sequences per request. See the amylase example for how to deal with datasets that exceed this limit.
  • Rate Limiting: Most endpoints have a quite strict rate limiting to distribute the available resources as fair as possible. All affected endpoints have a built-in retry mechanism to handle the rate limiting.
  • 431 Forbidden: Sometimes, the DDoS Protection of the API will send a mistaken 431 forbidden response. If you encounter this, please just try to re-run your script.

Citation

Please cite our paper if you are using the biocentral API in your work:

@Article{Franz2026,
  author    = {Franz, Sebastian and Olenyi, Tobias and Schloetermann, Paula and Smaoui, Amine and Jimenez-Soto, Luisa F. and Rost, Burkhard},
  journal   = {Journal of Molecular Biology},
  title     = {biocentral: embedding-based protein predictions},
  year      = {2026},
  issn      = {0022-2836},
  month     = jan,
  pages     = {169673},
  doi       = {10.1016/j.jmb.2026.169673},
  groups    = {[JMB] biocentral: embedding-based protein predictions, swc_bo_engineering},
  publisher = {Elsevier BV},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

biocentral_api-1.2.0.tar.gz (74.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

biocentral_api-1.2.0-py3-none-any.whl (159.3 kB view details)

Uploaded Python 3

File details

Details for the file biocentral_api-1.2.0.tar.gz.

File metadata

  • Download URL: biocentral_api-1.2.0.tar.gz
  • Upload date:
  • Size: 74.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for biocentral_api-1.2.0.tar.gz
Algorithm Hash digest
SHA256 87ad68b6c82852fb20138017ab7705bcd93dc37f06d8dc3699c11359c3a3d8dd
MD5 d148d021cb21ea070afb0ce45d09a4d6
BLAKE2b-256 5c7f0a0372ec3a911e56db69a8359c98482569dfc09df50aaff9c9f742e2e2d0

See more details on using hashes here.

File details

Details for the file biocentral_api-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: biocentral_api-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 159.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for biocentral_api-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24cc9fd9a8a2c2b89f8d02ffedf901eed80e94e8cfafad32a62769bfc08d6f7b
MD5 a932c0a208e05f085fc112ce00636bc1
BLAKE2b-256 94d3f77e587d1774fa8fa7bdd3f8033564e94b37901fc06bfdaf70165eedeca8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page