NCncats
Organelle

Get an organelle data report by taxon

Changed on

Get an organelle data report in JSON format.

get/organelle/taxon/{taxons}/dataset_report

Request

  • Base URL
    https://api.ncbi.nlm.nih.gov/datasets/v2
  • Auth
    API key in header api-key

Path parameters

taxonsstring[] required

NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank

Query parameters

organelle_typesV2reportsOrganelleType[]

Limit results to the specified organelle types.

first_release_datestring date-time

Limit results to organelle genomes released on or after the specified date.

last_release_datestring date-time

Limit results to organelle genomes released on or before the specified date.

tax_exact_matchboolean

If true, only return assemblies with the given NCBI Taxonomy ID, or name. Otherwise, assemblies from taxonomy subtree are included, too.

sort.fieldstring
sort.direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASCENDING' | 'SORT_DIRECTION_DESCENDING'
returned_content'COMPLETE' | 'ASSM_ACC'

Return complete organelle reports or nucleotide accessions only.

page_sizeinteger

The maximum number of organelle assemblies 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 from an OrganelleMetadata call with more than page_size results. Use this token, along with the previous OrganelleMetadata parameters, to retrieve the next page of results. When page_token is empty, all results have been retrieved.

table_format'ORGANELLE_TABLE_FORMAT_NO_TABLE' | 'SUMMARY'

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.

Response

A successful response

total_countinteger
next_page_tokenstring

Changes

  • e5d4400c8e5dRevision changes
    • info

      added the media type application/x-ndjson for the response with the status

    • info

      added the media type text/tab-separated-values for the response with the status

    • info

      added the optional property /// to the response with the status

  • 6b24249801ecRevision changes
    • breaking

      for the query request parameter include_tabular_header, default value INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY was added

    • breaking

      for the query request parameter returned_content, default value COMPLETE was added

    • breaking

      for the query request parameter sort.direction, default value SORT_DIRECTION_UNSPECIFIED was added

    • breaking

      for the query request parameter table_format, default value ORGANELLE_TABLE_FORMAT_NO_TABLE was added

    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value ORGANELLE_TYPE_UNKNOWN was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_WARNING_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value TOPOLOGY_UNKNOWN was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status