Contents:
URL
https://0hbx4gdq2g.execute-api.ap-southeast-2.amazonaws.com/prod
Search by region (POST)
Searches for and scores CRISPR targets within the specified organism and location. Alternatively, just specify a sequence.
/submit
Parameters
| Field | Type | Description |
|---|
| species | String | The species to query (i.e. "homo_sapiens", "mus_musculus") |
| chromosome | String | The chromosome to query (i.e. "1", "2", "X", "Y", "M") |
| start | Number | The start position of the sequence in the chromosome (1-based). |
| end | Number | The end position of the sequence in the chromosome (1-based). |
| Field | Type | Description |
|---|
| sequence | String | The nucleotide sequence. Should only contain the DNA characters [ATCGN]. |
Success 200
| Field | Type | Description |
|---|
| JobID | String | The new Job-ID. |
Error 400
| Field | Type | Description |
|---|
| message | String | A descriptive error message. |
Retrieve job (GET)
Reads the job information
/results/:id
Parameters
| Field | Type | Description |
|---|
| id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|
| id | String | The Job-ID. |
| genome | Number | The reference genome name. |
| chromosome | String | The chromosome name. |
| location | Number | The location of the sequence in the chromosome. |
Retrieve job targets (GET)
Reads the targets for a specific job
/results/:id/targets
Parameters
| Field | Type | Description |
|---|
| id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|
| recordsTotal | Number | The total number of items matching the query. |
| data | Array | An array of objects, each representing a target. |
| position | Number | The position of the target in the input sequence. |
| location | Number | The location of the target in the chromosome. |
| strand | String | The strand [+, -] the target is present on. |
| sequence | String | The nucleotide sequence of the target. |
| gc | Number | The GC content of the target. |
| tuscan | Number | The TUSCAN score. |