count_variants
Count variants matching filters by genomic region, minor-allele frequency, and missing data rate to size a query before downloading data.
Instructions
Count variants matching filters, computed server-side (nothing is downloaded).
Fast way to size a query before pulling data. Filter by genomic region
(reference_name + optional start/end, from list_sequences), minor-
allele frequency (min_maf/max_maf) and/or max_missing_data (0–1 fraction).
With no filters this returns the total variant count of the set. variant_set_db_id
is a BrAPI variantSetDbId (from list_variant_sets / list_content).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | Region end position, 1-based inclusive. | |
| start | No | Region start position, 1-based inclusive. | |
| max_maf | No | Maximum minor-allele frequency (0-1). | |
| min_maf | No | Minimum minor-allele frequency (0-1). | |
| reference_name | No | Chromosome/contig name to restrict the search to (see list_sequences). | |
| max_missing_data | No | Maximum per-variant missing-data fraction (0-1). | |
| variant_set_db_id | Yes | BrAPI variantSetDbId identifying the run (MODULE§project§run); from list_variant_sets / list_content. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |