regi0.taxonomic.iucn

regi0.taxonomic.iucn.get_common_names(names: Union[list, pandas.Series, str], token: str, add_supplied_names: bool = False, expand: bool = True)

Gets common names for multiple species using the IUCN API.

Parameters

  • names (list, Series or str) – Scientific name(s) to get results for.

  • token (str) – IUCN API authentication token.

  • add_supplied_names (bool) – Add supplied scientific names to the resulting DataFrame.

  • expand (bool) – Whether to expand result rows to match names size. If False, the number of rows will correspond to the number of unique names in names.

Returns

DataFrame with common names.

Return type

DataFrame

regi0.taxonomic.iucn.get_country_occurrence(names: Union[list, pandas.Series, str], token: str, add_supplied_names: bool = False, expand: bool = True) → pandas.DataFrame

Gets country occurrence and related information for multiple species using the IUCN API.

Parameters

  • names (list, Series or str) – Scientific name(s) to get results for.

  • token (str) – IUCN API authentication token.

  • add_supplied_names (bool) – Add supplied scientific names to the resulting DataFrame.

  • expand (bool) – Whether to expand result rows to match names size. If False, the number of rows will correspond to the number of unique names in names.

Returns

DataFrame with information about country occurrence for each name.

Return type

DataFrame

regi0.taxonomic.iucn.get_species_info(names: Union[list, pandas.Series, str], token: str, add_supplied_names: bool = False, expand: bool = True) → pandas.DataFrame

Gets IUCN category and miscellaneous information for multiple species using the IUCN API.

Parameters

  • names (list, Series or str) – Scientific name(s) to get results for.

  • token (str) – IUCN API authentication token.

  • add_supplied_names (bool) – Add supplied scientific names to the resulting DataFrame.

  • expand (bool) – Whether to expand result rows to match names size. If False, the number of rows will correspond to the number of unique names in names.

Returns

DataFrame with IUCN species information for each name.

Return type

DataFrame