Firebrowse

FireBrowse Beta API

A simple and elegant way to explore cancer data

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

A simple and elegant way to explore cancer data

Endpoints 30

Analyses

  • GETRetrieve all data by genes Gistic2 results./Analyses/CopyNumber/Genes/All?format=json&cohort=ACC&gene=string&tcga_participant_barcode=string&page=1&page_size=250&sort_by=cohortThis service provides access to the Gistic2 all_data_by_genes.txt output data. This data is a gene-level table of copy number values for all samples. The…
  • GETRetrieve Gistic2 significantly amplified genes results./Analyses/CopyNumber/Genes/Amplified?format=json&cohort=ACC&gene=string&q=0.0&page=1&page_size=250&sort_by=cohortThis service provides access to the Gistic2 amp_genes.conf_99.txt output data. At least 1 gene or cohort must be supplied.
  • GETRetrieve Gistic2 significantly deleted genes results./Analyses/CopyNumber/Genes/Deleted?format=json&cohort=ACC&gene=string&q=0.0&page=1&page_size=250&sort_by=cohortThis service provides access to the Gistic2 del_genes.conf_99.txt output data. At least 1 gene or cohort must be supplied.
  • GETRetrieve focal data by genes Gistic2 results./Analyses/CopyNumber/Genes/Focal?format=json&cohort=ACC&gene=string&tcga_participant_barcode=string&page=1&page_size=250&sort_by=cohortThis service provides access to the Gistic2 focal_data_by_genes.txt output data. This output is similar to the all_data_by_genes.txt output, but using only…
  • GETRetrieve all thresholded by genes Gistic2 results./Analyses/CopyNumber/Genes/Thresholded?format=json&cohort=ACC&gene=string&tcga_participant_barcode=string&page=1&page_size=250&sort_by=cohortThis service provides access to the Gistic2 all_thresholded_by_genes.txt output data. A gene-level table of discrete amplification and deletion indicators for…
  • GETRetrieve aggregated analysis features table./Analyses/FeatureTable?format=tsv&cohort=ACC&date=2016_01_28&column=string&page=1&page_size=250This service returns part or all of the so-called <strong>feature table</strong>; which aggregates the most important findings across ALL pipelines in the…
  • GETRetrieve MutSig final analysis MAF./Analyses/Mutation/MAF?format=json&cohort=ACC&tool=MutSig2CV&gene=string&tcga_participant_barcode=string&column=string&page=1&page_size=250&sort_by=cohortThis service returns columns from the MAF generated by MutSig. Results may be filtered by gene, cohort, tool, or barcode, but at least one gene OR barcode OR…
  • GETRetrieve Significantly Mutated Genes (SMG)./Analyses/Mutation/SMG?format=json&cohort=ACC&tool=MutSig2CV&rank=0&gene=string&q=0.0&page=1&page_size=250&sort_by=rankThis service provides a list of significantly mutated genes, as scored by MutSig. It may be filtered by cohort, rank, gene, tool and/or Q-value threshold, but…
  • GETRetrieve links to summary reports from Firehose analysis runs./Analyses/Reports?format=json&date=2016_01_28&cohort=ACC&name=Aggregate_AnalysisFeatures&type=Aggregate&page=1&page_size=250&sort_by=dateThis service returns URLs to the analysis result reports for runs of the Broad Institute GDAC Firehose analysis pipeline. At least one year of run reports are…
  • GETReturns RNASeq expression quartiles, e.g. suitable for drawing a boxplot./Analyses/mRNASeq/Quartiles?format=json&gene=string&cohort=ACC&protocol=RSEM&sample_type=tumors&Exclude=stringFor a given gene compute quartiles and extrema, suitable e.g. for drawing a boxplot (Tukey 1977). Results may be filtered by cohort, sample type, patient…

Archives

  • GETRetrieve standard data archives./Archives/StandardData?format=json&date=2016_01_28&cohort=ACC&data_type=Clinical&tool=Clinical_Pick_Tier1&platform=454&center=bcgsc.ca&level=1&protocol=birdseed_genotype&page=1&page_size=250&sort_by=cohortThis service returns the archive URLs for our Firehose standard data runs, providing a RESTful interface similar in spirit to the command line <a…

Metadata

  • GETObtain identities of TCGA consortium member centers./Metadata/Centers?format=json&center=bcgsc.caBy default this function returns a table of all consortium members in TCGA, aka centers; it provides both the HTTP domain and full organizational name of each…
  • GETRetrieve names of all TCGA clinical data elements (CDEs)./Metadata/ClinicalNames?format=jsonRetrieve names of all patient-level clinical data elements (CDES) available in TCGA, unioned across all disease cohorts. A CDE will be listed here only when…
  • GETRetrieve names of CDEs normalized by Firehose and selected for analyses./Metadata/ClinicalNames_FH?format=jsonThis service returns the names of patient-level clinical data elements (CDEs) that have been normalized by Firehose for use in analyses, unioned across all…
  • GETTranslate TCGA cohort abbreviations to full disease names./Metadata/Cohorts?format=json&cohort=ACCBy default this function returns a table containing all TCGA cohort abbreviations and their corresponding disease names. A subset of that table may be…
  • GETRetrieve sample counts./Metadata/Counts?format=json&date=2016_01_28&cohort=ACC&sample_type=FFPE&data_type=bcr&totals=true&sort_by=cohortReturns the aliquot counts for each disease cohort, per sample type and data type. The sample type designation of "Tumor" may be used to aggregate the count…
  • GETRetrieve dates of all GDAC Firehose stddata & analyses runs that have been ingested into FireBrowse./Metadata/Dates?format=json
  • GETSimple way to discern whether API server is up and running/Metadata/HeartBeat?format=jsonReturns a message to indicate that API (server) is up and running, or times out if not.
  • GETRetrieve names of all columns in the mutation annotation files (MAFs) served by FireBrowse./Metadata/MAFColNames?format=jsonRetrieve the names of all columns in the mutation annotation files (MAFs) hosted by FireBrowse. For more information on the mutation data, and how it is…
  • GETRetrieve list of all TCGA patients./Metadata/Patients?format=json&cohort=ACC&page=1&page_size=250&sort_by=cohortThis service returns a list of all TCGA patient barcodes in FireBrowse, optionally filtered by disease cohort. The barcodes are obtained directy from the…
  • GETTranslate TCGA platform codes to full platform names./Metadata/Platforms?format=json&platform=454By default this function returns a table of all of the technology platforms used to sequence or characterize samples in TCGA--both their short platform codes…
  • GETGiven a TCGA barcode, return its short letter sample type code./Metadata/SampleType/Barcode/:TCGA_Barcode?format=json
  • GETTranslate from numeric to symbolic TCGA sample codes./Metadata/SampleType/Code/:code?format=jsonConvert a TCGA numeric sample type code (e.g. 01, 02) to its corresponding symbolic (short letter) code (e.g. TP, TR).
  • GETTranslate from symbolic to numeric TCGA sample codes./Metadata/SampleType/ShortLetterCode/:short_letter_code?format=jsonConvert a TCGA sample type code in symbolic form (or 'short letter code' like TP, TR) to its corresponding numeric form (e.g. 01, 02).
  • GETReturn all TCGA sample type codes, both numeric and symbolic./Metadata/SampleTypes?format=json
  • GETObtain identities of tissue source sites in TCGA./Metadata/TSSites?format=json&tss_code=01By default this function returns a table of all sites which contributed source tissue to TCGA, aka TSS's. A subset of this table may be obtained by explicitly…

Samples

  • GETRetrieve TCGA CDEs verbatim, i.e. not normalized by Firehose./Samples/Clinical?format=json&cohort=ACC&tcga_participant_barcode=string&cde_name=string&page=1&page_size=150&sort_by=cohortThis service returns patient clinical data from TCGA, verbatim. It differs from the Samples/Clinical_FH method by providing access to all TCGA CDEs in their…
  • GETRetrieve CDEs normalized by Firehose and selected for analyses./Samples/Clinical_FH?format=json&cohort=ACC&tcga_participant_barcode=string&fh_cde_name=age_at_diagnosis&page=1&page_size=250&sort_by=cohortThis service returns patient-level clinical data elements (CDEs) that have been normalized by Firehose for use in analyses. Results may be selected by disease…
  • GETRetrieve mRNASeq data./Samples/mRNASeq?format=json&gene=string&cohort=ACC&tcga_participant_barcode=string&sample_type=NB&protocol=RSEM&page=1&page_size=250&sort_by=cohortThis service returns sample-level log2 mRNASeq expression values. Results may be filtered by gene, cohort, barcode, sample type or characterization protocol,…
  • GETRetrieve miRSeq data./Samples/miRSeq?format=json&mir=string&cohort=ACC&tcga_participant_barcode=string&tool=miRseq_Mature_Preprocess&sample_type=NB&page=1&page_size=250&sort_by=cohortThis service returns sample-level log2 miRSeq expression values. Results may be filtered by miR, cohort, barcode, sample type or Firehose preprocessing tool,…

API details

Base URL
http://firebrowse.org/api/v1
Authentication
None declared in the description
Operations
30 operations on 30 pathsGET 30
Main resources
Metadata 15Analyses 10Samples 4Archives 1
Response formats
application/json text/plain text/tab-separated-values
Description format
Swagger 2.0, API version 1.1.38 (2018-02-26 11:01:29 484103261f6…
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the FireBrowse Beta API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the FireBrowse Beta API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Retrieve all data by genes Gistic2 results.” (GET /Analyses/CopyNumber/Genes/All?format=json&cohort=ACC&gene=string&tcga_participant_barcode=string&page=1&page_size=250&sort_by=cohort), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the FireBrowse Beta API?

A simple and elegant way to explore cancer data It is listed under Data & analytics and has 30 endpoints.

Who publishes the FireBrowse Beta API?

It is listed from Firebrowse's public API description (an OpenAPI document), not published by Firebrowse on Swastik Codes. Anyone who controls firebrowse.org can claim the profile by adding a DNS TXT record.

What is the base URL of the FireBrowse Beta API?

Requests go to http://firebrowse.org/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the FireBrowse Beta API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the FireBrowse Beta API have?

30 operations on 30 paths (30 GET). The largest groups are Metadata, Analyses, Samples, Archives.

Is forking the FireBrowse Beta API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.