Contents:
URL
https://gt-scan.csiro.au/api
New job (POST)
Submits a job for a given genomic sequence and range.
/submit/
Parameters
| Field | Type | Description |
|---|---|---|
| genome | String | The reference genome |
| fasta | String | The nucleotide sequence. Should only contain the DNA characters [ATCGN]. |
| rule | String | The target rule. See the New job page for more info. |
| filter | String | The off-target filter. See the New job page for more info. |
| mismatches | Number | The number of mismatches allowed in the high-specificity region [0-3]. |
Success 200
| Field | Type | Description |
|---|---|---|
| JobID | String | The new Job-ID. |
Retrieve job status (GET)
Reads the current status of the job.
/:id/status/
Parameters
| Field | Type | Description |
|---|---|---|
| :id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|---|---|
| statusCode | Number | 0, 2, 4, 8 |
| message | String | A more verbose message |
| color | String | Unused |
Retrieve job summary (GET)
Reads the job details
/:id/summary/
Parameters
| Field | Type | Description |
|---|---|---|
| :id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|---|---|
| genome | String | The genome searched. |
| region | String | The genomic region of the submitted sequence (if found). |
| length | String | The length of the submitted sequence. |
| rule | String | The target rule (HTML formatted). |
| filter | String | The off-target filter. |
| mmlimit | String | The chromosome name. |
| time | String | The time taken to complete the job. |
Retrieve job targets (GET)
Reads the targets for a specific job
/:id/targets/
Parameters
| Field | Type | Description |
|---|---|---|
| :id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|---|---|
| data | Array | An array of objects, each representing a target. |
| position | Number | The position of the target in the input sequence. |
| strand | String | The strand [+, -] (relative to the input sequence) the target is on. |
| sequence | String | The nucleotide sequence of the target (HTML formatted). |
| ot_zero | Number | The number of potential off-targets with no mismatches. |
| ot_one | Number | The number of potential off-targets with one mismatch. |
| ot_two | Number | The number of potential off-targets with two mismatches. |
| ot_three | Number | The number of potential off-targets with three mismatches. |