This is a demonstration environment. It may contain non-accurate test data and should not be used for real-world applications. Data will be deleted regularly.

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.

By using our API you agree to our Data use terms .

Backend API specifications

Loculus is under continuous development and the endpoints are subject to change.

Complete API

All backend endpoints and all query APIs in one OpenAPI document.

JSON Swagger Scalar
Spec: /api-docs.json

General backend API

Backend endpoints excluding the organism and view query APIs.

JSON Swagger Scalar
Spec: /api-docs/general.json
URL of backend server: https://backend-loculus-vision.loculus.org

Query API specifications - databases

Query API specifications - views

Keycloak server

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