> ## 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 Variant Linkage Disequilibrium

> Retrieve genetic variants in linkage disequilibrium (LD).

The following parameters can be used to set thresholds on r2 and d_prime: gt (>), gte (>=), lt (\<), lte (\<=).

Set verbose = true to retrieve full info on the variants.

At least one of these fields is required: variant_id, spdi, hgvs, rsid, ca_id, or region.

Example: variant_id = NC_000011.10:9083634:A:T,

spdi = NC_000011.10:9083634:A:T,

hgvs = NC_000011.10:g.9083635A>T,

rsid = rs60960132,

ca_id = CA217534780,

region = chr17:7166090-7166095 (maximum length: 10kb),

r2 = gte:0.8,

d_prime = gt:0.9,

ancestry = EUR.

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/variant-ld
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/variant-ld:
    get:
      summary: Variants Variant Linkage Disequilibrium
      description: >-
        Retrieve genetic variants in linkage disequilibrium (LD).


        The following parameters can be used to set thresholds on r2 and
        d_prime: gt (>), gte (>=), lt (\<), lte (\<=).


        Set verbose = true to retrieve full info on the variants.


        At least one of these fields is required: variant_id, spdi, hgvs, rsid,
        ca_id, or region.


        Example: variant_id = NC_000011.10:9083634:A:T,


        spdi = NC_000011.10:9083634:A:T,


        hgvs = NC_000011.10:g.9083635A>T,


        rsid = rs60960132,


        ca_id = CA217534780,


        region = chr17:7166090-7166095 (maximum length: 10kb),


        r2 = gte:0.8,


        d_prime = gt:0.9,


        ancestry = EUR.


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


        Pagination is 0-based.
      operationId: variantsFromVariantID
      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: r2
          in: query
          required: false
          schema:
            type: string
        - name: d_prime
          in: query
          required: false
          schema:
            type: string
        - name: ancestry
          in: query
          required: false
          schema:
            type: string
            enum:
              - AFR
              - EAS
              - EUR
              - SAS
        - name: organism
          in: query
          required: false
          schema:
            type: string
            enum:
              - Homo sapiens
            default: Homo sapiens
        - name: verbose
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
        - 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:
                    chr:
                      type: string
                      nullable: true
                    ancestry:
                      type: string
                      nullable: true
                    d_prime:
                      type: number
                      nullable: true
                    r2:
                      type: number
                      nullable: true
                    label:
                      type: string
                    variant_1_base_pair:
                      type: string
                    variant_1_rsid:
                      type: string
                    variant_2_base_pair:
                      type: string
                    variant_2_rsid:
                      type: string
                    variant_1_pos:
                      type: number
                      nullable: true
                    variant_1_spdi:
                      type: string
                      nullable: true
                    variant_1_hgvs:
                      type: string
                      nullable: true
                    variant_2_pos:
                      type: number
                      nullable: true
                    variant_2_spdi:
                      type: string
                      nullable: true
                    variant_2_hgvs:
                      type: string
                      nullable: true
                    source:
                      type: string
                    source_url:
                      type: string
                    sequence_variant:
                      anyOf:
                        - type: string
                        - 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
                    name:
                      type: string
                  required:
                    - chr
                    - ancestry
                    - d_prime
                    - r2
                    - label
                    - variant_1_base_pair
                    - variant_1_rsid
                    - variant_2_base_pair
                    - variant_2_rsid
                    - name
                  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

````