ISO9001-logo
ISO 9001: We are pleased to announce that the BIGSdb-Pasteur platform has obtained ISO9001 certification in March 2026, and has been included in the scope of the CRBIP ISO 9001:2015 certification.

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 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 replaces wget or curl in automated scripts while handling OAuth authentication.

➡️ BIGSdb_downloader on GitHub
Edit on GitLab