TUSCAN

Contents:


URL

https://rylyx4l7j3.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

FieldTypeDescription
speciesStringThe species to query (i.e. "homo_sapiens", "mus_musculus")
chromosomeStringThe chromosome to query (i.e. "1", "2", "X", "Y", "M")
startNumberThe start position of the sequence in the chromosome (1-based).
endNumberThe end position of the sequence in the chromosome (1-based).
FieldTypeDescription
sequenceStringThe nucleotide sequence. Should only contain the DNA characters [ATCGN].

Success 200

FieldTypeDescription
JobIDStringThe new Job-ID.

Error 400

FieldTypeDescription
messageStringA descriptive error message.

Retrieve job (GET)

Reads the job information

/results/:id

Parameters

FieldTypeDescription
idStringThe Job-ID

Success 200

FieldTypeDescription
idStringThe Job-ID.
genomeNumberThe reference genome name.
chromosomeStringThe chromosome name.
locationNumberThe location of the sequence in the chromosome.
altlocationNumberThe location of the sequence in the chromosome (converted to GRCh38).

Retrieve job targets (GET)

Reads the targets for a specific job

/results/:id/targets

Parameters

FieldTypeDescription
idStringThe Job-ID

Success 200

FieldTypeDescription
recordsTotalNumberThe total number of items matching the query.
dataArrayAn array of objects, each representing a target.
positionNumberThe position of the target in the input sequence.
locationNumberThe location of the target in the chromosome.
strandStringThe strand [+, -] the target is present on.
sequenceStringThe nucleotide sequence of the target.
gcNumberThe GC content of the target.
tuscanNumberThe TUSCAN score.