Application Programming Interface
The BIGSdb API allows programmatic access to database resources.
🔗 Access & Documentation
API endpoint:
https://bigsdb.pasteur.fr/api
Documentation:
https://bigsdb.readthedocs.io/en/latest/rest.html
The BIGSdb API is described in Jolley et al. (2017), Database 2017: bax060.
🔑 Request an API Key
Access to the BIGSdb API requires authentication using a personal API key.
➡️ How to request an API keyThis page explains the full procedure, required information, and contact points depending on user affiliation.
⚙️ Use the BIGSdb API
Once an API key has been issued, the API can be used directly or via dedicated client tools.
🧰 BIGSdb_downloader
BIGSdb_downloader is a command-line tool designed to download alleles and profiles from PubMLST and BIGSdb Pasteur using authenticated API access.
It replaces wget or curl in automated scripts while handling
OAuth authentication.