v1

latestOpenAPI 3.0.12026-08-06107337528.9 KB
Gene

Get a gene product report by taxon

Get a gene product report by taxon. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.

get/gene/taxon/{taxon}/product_report

Path parameters

taxonstring required

NCBI Taxonomy ID or name (common or scientific) that the genes are annotated at

Query parameters

table_fieldsstring[]

Specify which fields to include in the tabular report. Additional fields are described here: Create a table from the gene data reports. Use of this parameter requires the HTTP header, accept: text/tab-separated-values.

table_formatstring

Specify a predefined set of fields for the tabular report using built-in templates. Use of this parameter requires the HTTP header, accept: text/tab-separated-values.

include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'

Specify when to include the table header when requesting a tabular report.

page_sizeinteger

The maximum number of gene reports to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, page_token can be used to retrieve the remaining results.

page_tokenstring

A page token is returned when the results count exceeds page size. Use this token along with previous request parameters to retrieve the next page of results. When page_token is empty, all results have been retrieved.

querystring

Limit to genes that match the specified gene symbol, name (description), alias, locus tag or protein name.

typesV2GeneType[]

Limit to genes matching the specified gene type.

tax_search_subtreeboolean

If true, include genes from taxonomic ranks below the requested taxon.

Response

A successful response

total_countinteger
next_page_tokenstring