> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catalog.igvf.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Variants

> Retrieve genetic variants.

Example: organism = Homo sapiens or Mus musculus.

mouse_strain = CAST_EiJ (only for mouse variants).

The examples below are specific to Homo sapiens:

region = chr1:1157520-1158189 (maximum length: 10kb),

GENCODE_category = coding or noncoding (only for human variants),

rsid = rs58658771,

spdi = NC_000020.11:3658947:A:G,

hgvs = NC_000020.11:g.3658948A>G,

ca_id = CA739473472,

variant_id = NC_000020.11:3658947:A:G.

The limit parameter controls the page size and can not exceed 500.

Pagination is 0-based.



## OpenAPI

````yaml /openapi/catalog-dev.openapi.json get /variants
openapi: 3.0.3
info:
  title: IGVF Catalog - Development
  description: >-
    Development IGVF Catalog OpenAPI compliant REST API built using tRPC with
    Express.


    Our database uses 0-based, half-open coordinates for genomic coordinates in
    the GRCh38 (human) and GRCm39 (mouse) reference genomes.


    Data is licensed under the Creative Commons license and the software is
    licensed under the MIT license.
  version: 1.2.0 - DEV
servers:
  - url: https://catalog-api-dev.demo.igvf.org/api
security: []
externalDocs:
  url: https://api-dev.catalog.igvf.org/openapi
paths:
  /variants:
    get:
      summary: Variants
      description: |-
        Retrieve genetic variants.

        Example: organism = Homo sapiens or Mus musculus.

        mouse_strain = CAST_EiJ (only for mouse variants).

        The examples below are specific to Homo sapiens:

        region = chr1:1157520-1158189 (maximum length: 10kb),

        GENCODE_category = coding or noncoding (only for human variants),

        rsid = rs58658771,

        spdi = NC_000020.11:3658947:A:G,

        hgvs = NC_000020.11:g.3658948A>G,

        ca_id = CA739473472,

        variant_id = NC_000020.11:3658947:A:G.

        The limit parameter controls the page size and can not exceed 500.

        Pagination is 0-based.
      operationId: variants
      parameters:
        - name: spdi
          in: query
          required: false
          schema:
            type: string
        - name: hgvs
          in: query
          required: false
          schema:
            type: string
        - name: rsid
          in: query
          required: false
          schema:
            type: string
        - name: ca_id
          in: query
          required: false
          schema:
            type: string
        - name: variant_id
          in: query
          required: false
          schema:
            type: string
        - name: region
          in: query
          required: false
          schema:
            type: string
        - name: GENCODE_category
          in: query
          required: false
          schema:
            type: string
            enum:
              - coding
              - noncoding
        - name: mouse_strain
          in: query
          required: false
          schema:
            type: string
            enum:
              - 129S1_SvImJ
              - A_J
              - CAST_EiJ
              - NOD_ShiLtJ
              - NZO_HlLtJ
              - PWK_PhJ
              - WSB_EiJ
        - name: organism
          in: query
          required: false
          schema:
            type: string
            enum:
              - Mus musculus
              - Homo sapiens
            default: Homo sapiens
        - name: page
          in: query
          required: false
          schema:
            type: number
            default: 0
        - name: limit
          in: query
          required: false
          schema:
            type: number
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                    chr:
                      type: string
                    pos:
                      type: number
                    rsid:
                      type: array
                      items:
                        type: string
                      nullable: true
                    ref:
                      type: string
                    alt:
                      type: string
                    spdi:
                      type: string
                    hgvs:
                      type: string
                    ca_id:
                      type: string
                      nullable: true
                    strain:
                      type: array
                      items:
                        type: string
                      nullable: true
                    qual:
                      type: string
                      nullable: true
                    files_filesets:
                      type: string
                      nullable: true
                    annotations:
                      type: object
                      properties:
                        bravo_af:
                          type: number
                          nullable: true
                        gnomad_af_total:
                          type: number
                          nullable: true
                        gnomad_af_afr:
                          type: number
                          nullable: true
                        gnomad_af_afr_female:
                          type: number
                          nullable: true
                        gnomad_af_afr_male:
                          type: number
                          nullable: true
                        gnomad_af_ami:
                          type: number
                          nullable: true
                        gnomad_af_ami_female:
                          type: number
                          nullable: true
                        gnomad_af_ami_male:
                          type: number
                          nullable: true
                        gnomad_af_amr:
                          type: number
                          nullable: true
                        gnomad_af_amr_female:
                          type: number
                          nullable: true
                        gnomad_af_amr_male:
                          type: number
                          nullable: true
                        gnomad_af_asj:
                          type: number
                          nullable: true
                        gnomad_af_asj_female:
                          type: number
                          nullable: true
                        gnomad_af_asj_male:
                          type: number
                          nullable: true
                        gnomad_af_eas:
                          type: number
                          nullable: true
                        gnomad_af_eas_female:
                          type: number
                          nullable: true
                        gnomad_af_eas_male:
                          type: number
                          nullable: true
                        gnomad_af_female:
                          type: number
                          nullable: true
                        gnomad_af_fin:
                          type: number
                          nullable: true
                        gnomad_af_fin_female:
                          type: number
                          nullable: true
                        gnomad_af_fin_male:
                          type: number
                          nullable: true
                        gnomad_af_male:
                          type: number
                          nullable: true
                        gnomad_af_nfe:
                          type: number
                          nullable: true
                        gnomad_af_nfe_female:
                          type: number
                          nullable: true
                        gnomad_af_nfe_male:
                          type: number
                          nullable: true
                        gnomad_af_oth:
                          type: number
                          nullable: true
                        gnomad_af_oth_female:
                          type: number
                          nullable: true
                        gnomad_af_oth_male:
                          type: number
                          nullable: true
                        gnomad_af_sas:
                          type: number
                          nullable: true
                        gnomad_af_sas_male:
                          type: number
                          nullable: true
                        gnomad_af_sas_female:
                          type: number
                          nullable: true
                        gnomad_af_raw:
                          type: number
                          nullable: true
                        GENCODE_category:
                          type: string
                          nullable: true
                        funseq_description:
                          type: string
                          nullable: true
                      additionalProperties: false
                      nullable: true
                    source:
                      type: string
                    source_url:
                      type: string
                    organism:
                      type: string
                      nullable: true
                  required:
                    - _id
                    - chr
                    - pos
                    - ref
                    - alt
                    - annotations
                    - source
                    - source_url
                    - organism
                  additionalProperties: false
        default:
          $ref: '#/components/responses/error'
components:
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                    - message
                  additionalProperties: false
            required:
              - message
              - code
            additionalProperties: false

````