Endpoints

Endpoints

The base-url needs to be supplemented with a suffix (path) to the resource. The base url and path together form the endpoint. All API endpoints are listed below.

Please note that the root url ("/") is not a valid endpoint and will thus result in a 404 (Not Found) error.

Model List Endpoints

Endpoints that result in a list of models

/models

List of all models.

/samples/<sample_id>/models

A list of models that originate from a specific sample

Example: /samples/SIDS00002/models

/patients/<patient_id>/models

A list of models from a particular patient
Example: /patients/SIDP00003/models

/patients/<patient_id>/samples/<sample_id>/models

Models from one sample of a particular patient.

/models/by_<mut_type>/<gene_identifier>

A list of models that have a mutation type in a specific gene.
Valid <mut_type>s are 'frameshift', 'snp', 'insertion', 'deletion', 'splice_variant' or 'mutation'. Use 'mutation' to list models with any kind of mutation in the specified gene.
Example: /models/by_snp/BRAF
Example: /models/by_frameshift/TP53

/models/by_<mut_type>/<gene_identifier>/<variant>

A list of models that have a mutation type in a specific protein location in a specific gene.
Example: /models/by_snp/BRAF/V600 - for any model with a BRAF mutation at the V600 location
Example: /models/by_snp/BRAF/V600E - for any model with a BRAF V600E mutation

/search/<q>

Search for models by name, synonym or any identifier (Sanger, Cellosaurus, DepMap, COSMIC). Example: /search/A549, /search/CVCL_0023

/models/parent/<parent_id>

Models derived from a parental model (sub-clones and derivatives). Example: /models/parent/SIDM00003

/model_ids

All model IDs as a simple list, without model details. Much faster than paging through /models when you only need the IDs.

Single Model Endpoints

Endpoints that result in a single model.

/models/<id>

Example /models/SIDM00003

/models/<source>/<source_id>

Use any identifier that is annotated. The identifier source is case-insensitive, but the identifier is case-sensitive.
Example: /models/cosmic_id/909751
Example: /models/CCLE_ID/769P_KIDNEY

/models/<model_id>/files

/models/<source>/<source_id>/files

View a list of all files attached to a model

Model Annotation

/cancer_types

/cancer_types/<id>

The cancer types used to classify models.

/model_msi_status

/model_msi_status/<id>

Microsatellite instability (MSI) status of models.

/models/<model_id>/datasets/growth_rate

Growth rate and doubling time of a model, from the GDSC drug screens. Example: /models/SIDM00003/datasets/growth_rate

/datasets/growth_rate

Growth rates for all models.

Samples & Patients

/samples

/samples/<id>

All samples, or one sample. Example: /samples/SIDS00002

/patients

/patients/<id>

All patients, or one patient. Example: /patients/SIDP00003

/patients/<patient_id>/samples

The samples taken from one patient. Example: /patients/SIDP00003/samples

Mutations & Cancer Drivers

/models/<model_id>/datasets/mutations

/models/<source>/<source_id>/datasets/mutations

All mutations for a specific model.
Example: /models/SIDM00003/datasets/mutations
Example: /models/COSMIC_ID/905975/datasets/mutations

/models/<model_id>/datasets/cancer_drivers

/models/<source>/<source_id>/datasets/cancer_drivers

Cancer driver mutations for a specific model.

/models/<model_id>/datasets/cancer_drivers/by_<category>

/models/<source>/<source_id>/datasets/cancer_drivers/by_<category>

Cancer drivers of a specific model, ranked by how often they occur in a specific <category>.
Example: /models/SIDM00002/datasets/cancer_drivers/by_tissue - shows all drivers for model SIDM00002, ranked by how often they occur in its tissue.

/genes/<gene_id>/datasets/mutations

All mutations in a gene, across every model.

/datasets/mutations

The full mutation dataset, page by page. For bulk analysis, the download files are much faster.

Copy Number Variation

/models/<model_id>/datasets/genecnv

/models/<source>/<source_id>/datasets/genecnv

Gene level CNV of a specific model

/genes/<gene_id>/datasets/genecnv

Gene-level copy number for one gene across all models.

/models/<model_id>/datasets/segmentcnv

Segment-level copy number for a model. Example: /models/SIDM00003/datasets/segmentcnv

Gene Expression

/models/<model_id>/datasets/rnaseq

RNA-seq gene expression for a model (read counts and TPM). Example: /models/SIDM00003/datasets/rnaseq

/genes/<gene_id>/datasets/rnaseq

Expression of one gene across all models.

Proteomics

/models/<model_id>/datasets/proteomics

Protein abundance for a model. Example: /models/SIDM00003/datasets/proteomics

/genes/<gene_id>/datasets/proteomics

Abundance of one protein across all models.

Gene Fusions

/models/<model_id>/datasets/fusions

Gene fusions detected in a model. Example: /models/SIDM00003/datasets/fusions

/genes/<gene_id>/datasets/fusions

Fusions involving one gene, across all models.

CRISPR Knockout Screens

/models/<model_id>/datasets/crispr_ko

CRISPR knockout gene fitness scores for a model. Example: /models/SIDM00003/datasets/crispr_ko

/genes/<gene_id>/datasets/crispr_ko

Knockout fitness scores for one gene across all screened models.

/cancer_types/<cancer_type_id>/datasets/crispr_ko

Knockout scores for the models of one cancer type.

/genes/<gene_id>/essentiality_profiles

A gene's essentiality profile across screened models.

/genes/<gene_id>/crispr_depletion sgRNA-level depletion data for a gene.

Drug Sensitivity

/drugs

/drugs/<id>

All screened drugs, or one drug.

/models/<model_id>/nlmes

Fitted dose–response curves (IC50 and AUC) for every drug screened on a model. Example: /models/SIDM00003/nlmes

/drugs/<drug_id>/nlmes

Fitted dose–response curves for one drug across all models.

Gene Tractability

/genes/<gene_id>/datasets/gene_tractability

/datasets/gene_tractability

How tractable a gene is as a drug target.

Datasets & Downloads

/datasets

/datasets/<id>

The datasets available in the API, with their versions.

/models/<model_id>/files

/model_files

/model_files/<id>

Files attached to models (already partly listed under Single Model Endpoints).

/download_files

The bulk download catalogue: categories of files, as on the website's Downloads page. Add ?include=groups.files for the individual files.