GT-Scan

Contents:


URL

https://gt-scan.csiro.au/api

New job (POST)

Submits a job for a given genomic sequence and range.

/submit/

Parameters

FieldTypeDescription
genomeStringThe reference genome
fastaStringThe nucleotide sequence. Should only contain the DNA characters [ATCGN].
ruleStringThe target rule. See the New job page for more info.
filterStringThe off-target filter. See the New job page for more info.
mismatchesNumberThe number of mismatches allowed in the high-specificity region [0-3].

Success 200

FieldTypeDescription
JobIDStringThe new Job-ID.

Retrieve job status (GET)

Reads the current status of the job.

/:id/status/

Parameters

FieldTypeDescription
:idStringThe Job-ID

Success 200

FieldTypeDescription
statusCodeNumber0, 2, 4, 8
messageStringA more verbose message
colorStringUnused

Retrieve job summary (GET)

Reads the job details

/:id/summary/

Parameters

FieldTypeDescription
:idStringThe Job-ID

Success 200

FieldTypeDescription
genomeStringThe genome searched.
regionStringThe genomic region of the submitted sequence (if found).
lengthStringThe length of the submitted sequence.
ruleStringThe target rule (HTML formatted).
filterStringThe off-target filter.
mmlimitStringThe chromosome name.
timeStringThe time taken to complete the job.

Retrieve job targets (GET)

Reads the targets for a specific job

/:id/targets/

Parameters

FieldTypeDescription
:idStringThe Job-ID

Success 200

FieldTypeDescription
dataArrayAn array of objects, each representing a target.
positionNumberThe position of the target in the input sequence.
strandStringThe strand [+, -] (relative to the input sequence) the target is on.
sequenceStringThe nucleotide sequence of the target (HTML formatted).
ot_zeroNumberThe number of potential off-targets with no mismatches.
ot_oneNumberThe number of potential off-targets with one mismatch.
ot_twoNumberThe number of potential off-targets with two mismatches.
ot_threeNumberThe number of potential off-targets with three mismatches.