Get transcript region for genes matching id

GET

/genes/{id}

const url = 'https://your-candig-domain/genomics/htsget/v1/genes/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://your-candig-domain/genomics/htsget/v1/genes/example

Get top five transcript regions matching the gene string

Parameters

Path Parameters

required

string format: path

Read or variant object identifier

Responses

200

Success

application/json

object

results

Array<object>

object

gene_name

HUGO gene name

string

transcript_name

Transcript name from NCBI RefSeq Select (https://www.ncbi.nlm.nih.gov/refseq/refseq_select/)

string

regions

Array<object>

object

reference_genome

string

Allowed values: hg37 hg38

region

Represents a genomic interval

object

referenceName

required

Reference sequence name

string

start

The start position of the range on the reference, 0-based, inclusive

integer format: int64

end

The end position of the range on the reference, 0-based, exclusive

integer format: int64

Example

{
  "results": [
    {
      "regions": [
        {
          "reference_genome": "hg37",
          "region": {
            "referenceName": "chr1",
            "start": 12312,
            "end": 99999
          }
        }
      ]
    }
  ]
}