API documentation

There is a Swagger UI for documentation and direct interaction with the APIs. For more tips on how to use the API, it is recommended to start with the API Authentication documentation.

WARNING: Swagger incorrectly displays NDJSON examples in JSON format. For endpoints that require NDJSON as input you must convert the JSON examples to NDJSON (e.g. by removing new lines) prior to testing.

Backend server

Please note that Loculus is under continuous development and the endpoints are subject to change.
View backend API documentation
URL of backend server: https://api.loculus.genspectrum.org/backend

LAPIS query engines

Influenza B/Victoria LAPIS API documentation Dengue 1 LAPIS API documentation Dengue 2 LAPIS API documentation Dengue 3 LAPIS API documentation Dengue 4 LAPIS API documentation Influenza A/H1N1pdm LAPIS API documentation Influenza A/H3N2 LAPIS API documentation Influenza A/H5N1 LAPIS API documentation Influenza A LAPIS API documentation Influenza B LAPIS API documentation
URLs of LAPIS query engines:
  • Influenza B/Victoria: https://api.loculus.genspectrum.org/b-victoria
  • Dengue 1: https://api.loculus.genspectrum.org/denv1
  • Dengue 2: https://api.loculus.genspectrum.org/denv2
  • Dengue 3: https://api.loculus.genspectrum.org/denv3
  • Dengue 4: https://api.loculus.genspectrum.org/denv4
  • Influenza A/H1N1pdm: https://api.loculus.genspectrum.org/h1n1pdm
  • Influenza A/H3N2: https://api.loculus.genspectrum.org/h3n2
  • Influenza A/H5N1: https://api.loculus.genspectrum.org/h5n1
  • Influenza A: https://api.loculus.genspectrum.org/influenza-a
  • Influenza B: https://api.loculus.genspectrum.org/influenza-b

Keycloak server

We use the open source software Keycloak for authentication.
URL of Keycloak server: https://auth.loculus.genspectrum.org