Data.EBird.Client.Taxonomy

Types and functions for taxonomy-related eBird API queries.

Documentation

taxonomy

Arguments

:: TaxonomyParams

Optional parameters

default: defaultTaxonomyParams

-> ClientM [Taxon]

Get any version of the eBird taxonomy, with optional filtering based on taxonomy categories and species.

For example, get the taxa for species in the "hybrid" category:

askEBird $ taxonomy (def & #categories ?~ "hybrid")

See the eBird API documentation for the corresponding endpoint.

data TaxonomyParams

Optional parameters accepted by the TaxonomyAPI.

Note that defaultTaxonomyParams (or the Default instance's def value) may be used to accept the defaults of the eBird API.

Additionally, note that there are optics available for manipulating this type. For example, if you would like to just set the _taxonomyParamsSpecies field to "bohwax":

def & taxonomyParamsSpecies ?~ "bohwax"

Or, using -XOverloadedLabels:

def & #species ?~ "bohwax"

Constructors

TaxonomyParams

Fields

• _taxonomyParamsCategories :: Maybe TaxonomyCategories

  Only include species of these TaxonomyCategorys in the taxonomy

  default: all categories

• _taxonomyParamsLocale :: Maybe SPPLocale

  Use this locale for common names

  default: En

• _taxonomyParamsSpecies :: Maybe SpeciesCodes

  Only fetch records for these species

  default: all

• _taxonomyParamsVersion :: Maybe Text

  Fetch this version of the eBird taxonomy

  default: latest

Instances

Read TaxonomyParams

Defined in Data.EBird.Client.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxonomyParams

readList :: ReadS [TaxonomyParams]

readPrec :: ReadPrec TaxonomyParams

readListPrec :: ReadPrec [TaxonomyParams]

Show TaxonomyParams

Defined in Data.EBird.Client.Taxonomy

Methods

showsPrec :: Int -> TaxonomyParams -> ShowS

show :: TaxonomyParams -> String

showList :: [TaxonomyParams] -> ShowS

Default TaxonomyParams

Defined in Data.EBird.Client.Taxonomy

Methods

def :: TaxonomyParams

Eq TaxonomyParams

Defined in Data.EBird.Client.Taxonomy

Methods

(==) :: TaxonomyParams -> TaxonomyParams -> Bool

(/=) :: TaxonomyParams -> TaxonomyParams -> Bool

(k ~ A_Lens, a ~ Maybe TaxonomyCategories, b ~ Maybe TaxonomyCategories) => LabelOptic "categories" k TaxonomyParams TaxonomyParams a b

Defined in Data.EBird.Client.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomyParams TaxonomyParams a b

(k ~ A_Lens, a ~ Maybe SPPLocale, b ~ Maybe SPPLocale) => LabelOptic "locale" k TaxonomyParams TaxonomyParams a b

Defined in Data.EBird.Client.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomyParams TaxonomyParams a b

(k ~ A_Lens, a ~ Maybe SpeciesCodes, b ~ Maybe SpeciesCodes) => LabelOptic "species" k TaxonomyParams TaxonomyParams a b

Defined in Data.EBird.Client.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomyParams TaxonomyParams a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "version" k TaxonomyParams TaxonomyParams a b

Defined in Data.EBird.Client.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomyParams TaxonomyParams a b

defaultTaxonomyParams :: TaxonomyParams

Note that this value does not actually use the eBird API default values. It simply sets every option to Nothing, which means we just don't send any of these parameters to the eBird API and they will use their own defaults.

Optics for TaxonomyParams

taxonomyParamsVersion :: Lens' TaxonomyParams (Maybe Text)

taxonomyParamsSpecies :: Lens' TaxonomyParams (Maybe SpeciesCodes)

taxonomyParamsLocale :: Lens' TaxonomyParams (Maybe SPPLocale)

taxonomyParamsCategories :: Lens' TaxonomyParams (Maybe TaxonomyCategories)

taxonomicForms

Arguments

:: Text

eBird API key

-> SpeciesCode

The species to get subspecies of

-> ClientM SpeciesCodes

Get the list of subspecies of a given species recognized in the eBird taxonomy.

For example, get subspecies of Canada Goose (using -XOverloadedStrings):

askEBird $ taxonomicForms key "cangoo"

Note that the endpoint for this query is simple enough that taxonomicForms is equivalent to the generated taxonomicForms_.

See the eBird API documentation for the corresponding endpoint.

taxaLocaleCodes

Arguments

:: Text

eBird API key

-> TaxaLocaleCodesParams

Optional parameters

default: defaultTaxaLocaleCodesParams

-> ClientM [SPPLocaleListEntry]

Get the supported locale codes and names for species common names, with the last time they were updated.

For example:

askEBird $ taxaLocaleCodes key def

See the eBird API documentation for the corresponding endpoint.

newtype TaxaLocaleCodesParams

Optional parameters accepted by the TaxaLocaleCodesAPI.

Note that defaultTaxaLocaleCodesParams (or the Default instance's def value) may be used to accept the defaults of the eBird API.

Additionally, note that there are optics available for manipulating this type. For example, if you would like to just set the _taxaLocaleCodesParamsLocale field to Es:

def & taxaLocaleCodesParamsLocale ?~ Es

Or, using -XOverloadedLabels:

def & #locale ?~ Es

Constructors

TaxaLocaleCodesParams

Fields

• _taxaLocaleCodesParamsLocale :: Maybe SPPLocale

  Value for the "Accept-Language" header, for translated language names, when available

  default: En

Instances

Read TaxaLocaleCodesParams

Defined in Data.EBird.Client.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxaLocaleCodesParams

readList :: ReadS [TaxaLocaleCodesParams]

readPrec :: ReadPrec TaxaLocaleCodesParams

readListPrec :: ReadPrec [TaxaLocaleCodesParams]

Show TaxaLocaleCodesParams

Defined in Data.EBird.Client.Taxonomy

Methods

showsPrec :: Int -> TaxaLocaleCodesParams -> ShowS

show :: TaxaLocaleCodesParams -> String

showList :: [TaxaLocaleCodesParams] -> ShowS

Default TaxaLocaleCodesParams

Defined in Data.EBird.Client.Taxonomy

Methods

def :: TaxaLocaleCodesParams

Eq TaxaLocaleCodesParams

Defined in Data.EBird.Client.Taxonomy

Methods

(==) :: TaxaLocaleCodesParams -> TaxaLocaleCodesParams -> Bool

(/=) :: TaxaLocaleCodesParams -> TaxaLocaleCodesParams -> Bool

(k ~ An_Iso, a ~ Maybe SPPLocale, b ~ Maybe SPPLocale) => LabelOptic "locale" k TaxaLocaleCodesParams TaxaLocaleCodesParams a b

Defined in Data.EBird.Client.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxaLocaleCodesParams TaxaLocaleCodesParams a b

defaultTaxaLocaleCodesParams :: TaxaLocaleCodesParams

Note that this value does not actually use the eBird API default values. It simply sets every option to Nothing, which means we just don't send any of these parameters to the eBird API and they will use their own defaults.

Optics for TaxaLocaleCodesParams

taxaLocaleCodesParamsLocale :: Iso' TaxaLocaleCodesParams (Maybe SPPLocale)

Taxonomy versions

taxonomyVersions :: ClientM [TaxonomyVersionListEntry]

Get all versions of the taxonomy, with a flag indicating which is latest.

For example:

askEBird taxonomyVersions

Note that the endpoint for this query is simple enough that taxonomyVersions is equivalent to the generated taxonomyVersions_.

See the eBird API documentation for the corresponding endpoint.

Taxonomic groups

taxonomicGroups

Arguments

:: SPPGrouping

MerlinGrouping groups like birds together, with falcons next to hawks, while EBirdGrouping groups in taxonomy order

-> TaxonomicGroupsParams

Optional parameters

default: defaultTaxonomicGroupsParams

-> ClientM [TaxonomicGroupListEntry]

Get the list of species groups, in either Merlin or eBird grouping.

For example, get the taxonomic groups using eBird grouping order (using -XOverloadedStrings):

askEBird $ taxonomicGroups "ebird" def

See the eBird API documentation for the corresponding endpoint.

newtype TaxonomicGroupsParams

Optional parameters accepted by the TaxonomicGroupsAPI.

Note that defaultTaxonomicGroupsParams (or the Default instance's def value) may be used to accept the defaults of the eBird API.

Additionally, note that there are optics available for manipulating this type. For example, if you would like to just set the _taxonomicGroupsParamsLocale field to Es:

def & taxonomicGroupsParamsLocale ?~ Es

Or, using -XOverloadedLabels:

def & #locale ?~ Es

Constructors

TaxonomicGroupsParams

Fields

• _taxonomicGroupsParamsLocale :: Maybe SPPLocale

  Locale to use for species group names. En is used for any locale whose translations are unavailable at this endpoint

  default: En

Instances

Read TaxonomicGroupsParams

Defined in Data.EBird.Client.Taxonomy

Methods

readsPrec :: Int -> ReadS TaxonomicGroupsParams

readList :: ReadS [TaxonomicGroupsParams]

readPrec :: ReadPrec TaxonomicGroupsParams

readListPrec :: ReadPrec [TaxonomicGroupsParams]

Show TaxonomicGroupsParams

Defined in Data.EBird.Client.Taxonomy

Methods

showsPrec :: Int -> TaxonomicGroupsParams -> ShowS

show :: TaxonomicGroupsParams -> String

showList :: [TaxonomicGroupsParams] -> ShowS

Default TaxonomicGroupsParams

Defined in Data.EBird.Client.Taxonomy

Methods

def :: TaxonomicGroupsParams

Eq TaxonomicGroupsParams

Defined in Data.EBird.Client.Taxonomy

Methods

(==) :: TaxonomicGroupsParams -> TaxonomicGroupsParams -> Bool

(/=) :: TaxonomicGroupsParams -> TaxonomicGroupsParams -> Bool

(k ~ An_Iso, a ~ Maybe SPPLocale, b ~ Maybe SPPLocale) => LabelOptic "locale" k TaxonomicGroupsParams TaxonomicGroupsParams a b

Defined in Data.EBird.Client.Taxonomy

Methods

labelOptic :: Optic k NoIx TaxonomicGroupsParams TaxonomicGroupsParams a b

defaultTaxonomicGroupsParams :: TaxonomicGroupsParams

Note that this value does not actually use the eBird API default values. It simply sets every option to Nothing, which means we just don't send any of these parameters to the eBird API and they will use their own defaults.

Optics for TaxonomicGroupsParams

taxonomicGroupsParamsLocale :: Iso' TaxonomicGroupsParams (Maybe SPPLocale)