Data access policy note: since January 1st, 2025, registration and authentication are mandatory to access all data curated after this date, either via the web interface or via the application programming interface (API authentication help link).
To request an API key, follow the steps outlined at: Requesting a BIGSdb-Pasteur API Key
Please contact us if you have any questions.
Application Programming Interface
The API can be accessed at:
https://bigsdb.pasteur.fr/api
The BIGSdb API is described in Jolley et al. (2017), Database 2017: bax060, and is fully documented at:
https://bigsdb.readthedocs.io/en/latest/rest.html
Request an API Key
Access to the BIGSdb API requires authentication using a personal API key.
This 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 is intended to be used as a secure and convenient replacement for wget or curl in automated download scripts, while seamlessly handling the OAuth authentication required by the BIGSdb API.