# FireBrowse Beta API API

> FireBrowse Beta API API on Apizie: 30 endpoints (Retrieve all data by genes Gistic2 results., Retrieve Gistic2 significantly amplified genes results., Retrieve Gistic2 significantly deleted genes results., Retrieve focal data by genes Gistic2 results., …) returned as clean JSON through one API key. 30 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/open-data:firebrowse/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:firebrowse`
- Category: Open Data
- Status: live
- Source: https://firebrowse.org
- Page: https://zieapi.vercel.app/api/open-data/firebrowse
- OpenAPI: https://zieapi.vercel.app/api/open-data/firebrowse/openapi.json

A simple and elegant way to explore cancer data

## Endpoints

### Retrieve all data by genes Gistic2 results.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/all`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| gene | array | no | Comma separated list of gene name(s). |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve Gistic2 significantly amplified genes results.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/amplified`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| gene | array | no | Comma separated list of gene name(s). |
| q | number | no | Only return results with Q-value <= given threshold. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve Gistic2 significantly deleted genes results.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/deleted`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| gene | array | no | Comma separated list of gene name(s). |
| q | number | no | Only return results with Q-value <= given threshold. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve focal data by genes Gistic2 results.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/focal`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| gene | array | no | Comma separated list of gene name(s). |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve all thresholded by genes Gistic2 results.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/thresholded`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| gene | array | no | Comma separated list of gene name(s). |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve aggregated analysis features table.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/feature-table`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| date | array | no | Select one or more date stamps. |
| column | array | no | Comma separated list of which data columns/fields to return. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |

### Retrieve MutSig final analysis MAF.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/maf`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| tool | array | no | Narrow search to include only data/results produced by the selected Firehose tool. |
| gene | array | no | Comma separated list of gene name(s). |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| column | array | no | Comma separated list of which data columns/fields to return. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve Significantly Mutated Genes (SMG).
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/smg`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| tool | array | no | Narrow search to include only data/results produced by the selected Firehose tool. |
| rank | integer | no | Number of significant genes to return. |
| gene | array | no | Comma separated list of gene name(s). |
| q | number | no | Only return results with Q-value <= given threshold. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve links to summary reports from Firehose analysis runs.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/reports`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| date | array | no | Select one or more date stamps. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| name | array | no | Narrow search to one or more report names. |
| type | array | no | Narrow search to one or more report types. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Returns RNASeq expression quartiles, e.g. suitable for drawing a boxplot.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/m-rnaseq-quartiles`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| gene | string | yes | Enter a single gene name. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| protocol | array | no | Narrow search to one or more sample characterization protocols from the scrollable list. |
| sample_type | array | no | For which type of sample(s) should quartiles be computed? |
| Exclude | array | no | Comma separated list of TCGA participants, identified by barcodes such as TCGA-GF-A4EO, denoting samples to exclude from computation. |

### Retrieve standard data archives.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/standard-data`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| date | array | no | Select one or more date stamps. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| data_type | array | no | Narrow search to one or more TCGA data types from the scrollable list. |
| tool | array | no | Narrow search to include only data/results produced by the selected Firehose tool. |
| platform | array | no | Narrow search to one or more TCGA data generation platforms from the scrollable list. |
| center | array | no | Narrow search to one or more TCGA centers from the scrollable list. |
| level | array | no | Narrow search to one or more TCGA data levels. |
| protocol | array | no | Narrow search to one or more sample characterization protocols from the scrollable list. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Obtain identities of TCGA consortium member centers.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/centers`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| center | array | no | Narrow search to one or more TCGA centers from the scrollable list. |

### Retrieve names of all TCGA clinical data elements (CDEs).
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/clinical-names`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |

### Retrieve names of CDEs normalized by Firehose and selected for analyses.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/clinical-names-fh`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |

### Translate TCGA cohort abbreviations to full disease names.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/cohorts`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |

### Retrieve sample counts.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/counts`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| date | array | no | Select one or more date stamps. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| sample_type | array | no | Narrow search to one or more TCGA sample types from the scrollable list. |
| data_type | array | no | Narrow search to one or more TCGA data types from the scrollable list. |
| totals | boolean | no | Output an entry providing the totals for each data type. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve dates of all GDAC Firehose stddata & analyses runs that have been ingested into FireBrowse.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/dates`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |

### Simple way to discern whether API server is up and running
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/heart-beat`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |

### Retrieve names of all columns in the mutation annotation files (MAFs) served by FireBrowse.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/mafcol-names`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |

### Retrieve list of all TCGA patients.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/patients`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Translate TCGA platform codes to full platform names.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/platforms`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| platform | array | no | Narrow search to one or more TCGA data generation platforms from the scrollable list. |

### Given a TCGA barcode, return its short letter sample type code.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/barcode`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| TCGA_Barcode | string | yes | Enter a single TCGA barcode, of any form: e.g. TCGA-GF-A4EO-06 or TCGA-EL-A3D5-01A-22D-A202-08 |

### Translate from numeric to symbolic TCGA sample codes.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| code | array | yes | Narrow search to one or more TCGA sample type codes. |

### Translate from symbolic to numeric TCGA sample codes.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/short-letter-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| short_letter_code | array | yes | TCGA sample type short letter code(s) (e.g. TP, NB, etc.). |

### Return all TCGA sample type codes, both numeric and symbolic.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/sample-types`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |

### Obtain identities of tissue source sites in TCGA.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/tssites`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| tss_code | array | no | Narrow search to one or more TSS codes |

### Retrieve TCGA CDEs verbatim, i.e. not normalized by Firehose.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/clinical`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| cde_name | array | no | Retrieve results only for specified CDEs, per the Metadata/ClinicalNames function |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve CDEs normalized by Firehose and selected for analyses.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/clinical-fh`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| fh_cde_name | array | no | Retrieve results only for the CDEs specified from the scrollable list. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve mRNASeq data.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/m-rnaseq`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| gene | array | no | Comma separated list of gene name(s). |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| sample_type | array | no | Narrow search to one or more TCGA sample types from the scrollable list. |
| protocol | array | no | Narrow search to one or more sample characterization protocols from the scrollable list. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

### Retrieve miRSeq data.
`GET https://zieapi.vercel.app/v1/open-data:firebrowse/mi-rseq`

| Parameter | Type | Required | Description |
|---|---|---|---|
| format | string | no | Format of result. |
| mir | array | no | Comma separated list of miR names (e.g. hsa-let-7b-5p,hsa-let-7a-1). |
| cohort | array | no | Narrow search to one or more TCGA disease cohorts from the scrollable list. |
| tcga_participant_barcode | array | no | Comma separated list of TCGA participant barcodes (e.g. TCGA-GF-A4EO). |
| tool | array | no | Narrow search to include only data/results produced by the selected Firehose tool. |
| sample_type | array | no | Narrow search to one or more TCGA sample types from the scrollable list. |
| page | array | no | Which page (slice) of entire results set should be returned. |
| page_size | array | no | Number of records per page of results. Max is 2000. |
| sort_by | string | no | Which column in the results should be used for sorting paginated results? |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:firebrowse/all" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the FireBrowse Beta API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/open-data:firebrowse/all with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the FireBrowse Beta API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the FireBrowse Beta API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:firebrowse.

### What is the status of the FireBrowse Beta API API?
Live: works with just an Apizie key