mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes module

async mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.asyncio(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• order (ListMgnifyGenomesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• search (None | str | Unset) – Search with genome taxonomies and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeList

Return type:

NinjaPaginationResponseSchemaGenomeList | None

async mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.asyncio_detailed(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• order (ListMgnifyGenomesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• search (None | str | Unset) – Search with genome taxonomies and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeList]

mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.sync(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• order (ListMgnifyGenomesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• search (None | str | Unset) – Search with genome taxonomies and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

NinjaPaginationResponseSchemaGenomeList

Return type:

NinjaPaginationResponseSchemaGenomeList | None

mgnipy.emgapi_v2_client.api.genomes.list_mgnify_genomes.sync_detailed(*, client, order=<mgnipy.emgapi_v2_client.types.Unset object>, biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>, page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)

List all genomes across MGnify Genome catalogues

MGnify Genomes are either isolates, or MAGs derived from binned metagenomes.

Parameters:

• order (ListMgnifyGenomesOrderType0 | None | Unset)

• biome_lineage (None | str | Unset) – The lineage to match, including all descendant biomes

• search (None | str | Unset) – Search with genome taxonomies and accessions

• page (int | Unset) – Default: 1.

• page_size (int | None | Unset)

• client (AuthenticatedClient | Client)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[NinjaPaginationResponseSchemaGenomeList]

Return type:

Response[NinjaPaginationResponseSchemaGenomeList]