Health — entry 014 of 23
LAPIS
LAPIS is the open, keyless REST API behind covSPECTRUM, serving aggregated counts, sequence details, and mutation queries over SARS-CoV-2 genomic data drawn from public sources like GenBank and Nextstrain, documented via an OpenAPI v2 endpoint at lapis.cov-spectrum.org. The frontend's old ETH Zurich domain, cov-spectrum.ethz.ch, now 301-redirects permanently to cov-spectrum.org — 'url' corrected to the live domain. A live GET against lapis.cov-spectrum.org/open/v2/ returns Access-Control-Allow-Origin: *, reconfirming the stored 'yes' cors.
GreatAPIs Score
Auth quickstart
- No key needed — call it now.
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
info-controller4
GET/sample/databaseConfig
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | DatabaseConfig |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/info
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
| Status | Description | Schema |
|---|---|---|
200 | OK | LapisInfo |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/lineageDefinition/{column}
| Name | In | Required | Type |
|---|---|---|---|
column | path | yes | string |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/referenceGenome
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | ReferenceGenome |
500 | Internal Server Error | LapisErrorResponse |
lapis-controller20
GET/sample/aggregated
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
fields | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | AggregatedResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/aggregated
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — AggregatedPostRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | AggregatedResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/alignedAminoAcidSequences
| Name | In | Required | Type |
|---|---|---|---|
genes | query | no | array |
sequenceFilters | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
fastaHeaderTemplate | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/alignedAminoAcidSequences
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — AllAminoAcidSequenceRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/alignedAminoAcidSequences/{gene}
| Name | In | Required | Type |
|---|---|---|---|
gene | path | yes | — |
sequenceFilters | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
fastaHeaderTemplate | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/alignedAminoAcidSequences/{gene}
| Name | In | Required | Type |
|---|---|---|---|
gene | path | yes | — |
X-Request-ID | header | no | — |
application/json — AminoAcidSequenceRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/aminoAcidInsertions
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | AminoAcidInsertionsResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/aminoAcidInsertions
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — InsertionsRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | AminoAcidInsertionsResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/aminoAcidMutations
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
minProportion | query | no | number |
orderBy | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
fields | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | AminoAcidMutationsResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/aminoAcidMutations
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — SequenceFiltersWithMinProportion (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | AminoAcidMutationsResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/details
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
fields | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
limit | query | no | — |
offset | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
X-Request-ID | header | no | — |
dataFormat | query | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | DetailsResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/details
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — DetailsPostRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | DetailsResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/mostRecentCommonAncestor
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
phyloTreeField | query | yes | — |
printNodesNotInTree | query | no | boolean |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
dataFormat | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | MostRecentCommonAncestorResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/mostRecentCommonAncestor
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — MostRecentCommonAncestorRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | MostRecentCommonAncestorResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/nucleotideInsertions
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | NucleotideInsertionsResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/nucleotideInsertions
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — InsertionsRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | NucleotideInsertionsResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/nucleotideMutations
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
minProportion | query | no | number |
orderBy | query | no | — |
limit | query | no | — |
offset | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
fields | query | no | — |
X-Request-ID | header | no | — |
dataFormat | query | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | NucleotideMutationsResponse |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/nucleotideMutations
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — SequenceFiltersWithMinProportion (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | NucleotideMutationsResponse |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/phyloSubtree
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
phyloTreeField | query | yes | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
dataFormat | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/phyloSubtree
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — PhyloSubtreeRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
queries-over-time-controller3
POST/component/aminoAcidMutationsOverTime
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — MutationsOverTimeRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | QueriesOverTimeResponseMutationsOverTimeResult |
500 | Internal Server Error | LapisErrorResponse |
POST/component/nucleotideMutationsOverTime
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — MutationsOverTimeRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | QueriesOverTimeResponseMutationsOverTimeResult |
500 | Internal Server Error | LapisErrorResponse |
POST/component/queriesOverTime
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — QueriesOverTimeRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | QueriesOverTimeResponseQueriesOverTimeResult |
500 | Internal Server Error | LapisErrorResponse |
query-controller1
POST/query/parse
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — QueryParseRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | QueryParseResponse |
500 | Internal Server Error | LapisErrorResponse |
single-segmented-sequence-controller4
GET/sample/alignedNucleotideSequences
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
fastaHeaderTemplate | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/alignedNucleotideSequences
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — NucleotideSequenceRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
GET/sample/unalignedNucleotideSequences
| Name | In | Required | Type |
|---|---|---|---|
sequenceFilters | query | no | — |
orderBy | query | no | — |
nucleotideMutations | query | no | — |
aminoAcidMutations | query | no | — |
nucleotideInsertions | query | no | — |
aminoAcidInsertions | query | no | — |
limit | query | no | — |
offset | query | no | — |
dataFormat | query | no | — |
fastaHeaderTemplate | query | no | — |
X-Request-ID | header | no | — |
downloadAsFile | query | no | boolean |
downloadFileBasename | query | no | string |
compression | query | no | string |
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
POST/sample/unalignedNucleotideSequences
| Name | In | Required | Type |
|---|---|---|---|
X-Request-ID | header | no | — |
application/json — NucleotideSequenceRequest (required)
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
500 | Internal Server Error | LapisErrorResponse |
Try it
Developer reference
https://lapis.cov-spectrum.org/open/v2- GET/sample/aggregated
- GET/sample/details
Availability
Changelog
- gained an OpenAPI spec
- content changed