Data.EBird.Client.Observations

Types and functions for observation-related eBird API queries.

Recent observations

recentObservations

Arguments

:: Text

eBird API key

-> RegionCode

Region(s) to get observations from

-> RecentObservationsParams

Optional parameters

default: defaultRecentObservationsParams

-> ClientM [Observation 'Simple]

Get a list of recent observations within a region. Results only include the most recent observation for each species in the region.

For example, get up to 10 recent observations from the last 5 days in Park County, Wyoming (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentObservations key
    "US-WY-029"
    (def & #maxResults ?~ 10 & #back ?~ 5)

See the eBird API documentation for the corresponding endpoint.

data RecentObservationsParams

Optional parameters accepted by the RecentObservationsAPI.

Note that defaultRecentObservationsParams (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 _recentObservationsParamsBack field to 30:

def & recentObservationsParamsBack ?~ 30

Or, using -XOverloadedLabels:

def & #back ?~ 30

Constructors

RecentObservationsParams

Fields

• _recentObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentObservationsParamsCategories :: Maybe TaxonomyCategories

  Only include observations in these taxonomy categories

  default: all categories

• _recentObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentObservationsParamsProvisional :: Maybe Bool

  Include observations which have not been reviewed

  default: False

• _recentObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentObservationsParamsExtraRegions :: Maybe RegionCode

  Up to 10 extra regions to get observations from

  default: none

• _recentObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentObservationsParams

readList :: ReadS [RecentObservationsParams]

readPrec :: ReadPrec RecentObservationsParams

readListPrec :: ReadPrec [RecentObservationsParams]

Show RecentObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentObservationsParams -> ShowS

show :: RecentObservationsParams -> String

showList :: [RecentObservationsParams] -> ShowS

Default RecentObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentObservationsParams

Eq RecentObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentObservationsParams -> RecentObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentObservationsParams RecentObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

(k ~ A_Lens, a ~ Maybe RegionCode, b ~ Maybe RegionCode) => LabelOptic "extraRegions" k RecentObservationsParams RecentObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentObservationsParams RecentObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentObservationsParams RecentObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "provisional" k RecentObservationsParams RecentObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentObservationsParams RecentObservationsParams a b

defaultRecentObservationsParams :: RecentObservationsParams

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 RecentObservationsParams

recentObservationsParamsProvisional :: Lens' RecentObservationsParams (Maybe Bool)

recentObservationsParamsMaxResults :: Lens' RecentObservationsParams (Maybe Integer)

recentObservationsParamsLocale :: Lens' RecentObservationsParams (Maybe SPPLocale)

recentObservationsParamsHotspot :: Lens' RecentObservationsParams (Maybe Bool)

recentObservationsParamsExtraRegions :: Lens' RecentObservationsParams (Maybe RegionCode)

recentObservationsParamsCategories :: Lens' RecentObservationsParams (Maybe TaxonomyCategories)

recentObservationsParamsBack :: Lens' RecentObservationsParams (Maybe Integer)

Recent notable observations

recentNotableObservations

Arguments

:: Text

eBird API key

-> RegionCode

Region(s) to get observations from

-> RecentNotableObservationsParams

Optional parameters

default: defaultRecentNotableObservationsParams

-> ClientM [SomeObservation]

Get a list of recent notable observations within a region. Results only include the most recent observation for each species in the region.

For example, get up to 10 recent notable observations from the last 30 days in Park County, Wyoming (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentNotableObservations key
    "US-WY-029"
    (def & #maxResults ?~ 10 & #back ?~ 30)

See the eBird API documentation for the corresponding endpoint.

data RecentNotableObservationsParams

Optional parameters accepted by the RecentNotableObservationsAPI.

Note that defaultRecentNotableObservationsParams (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 _recentNotableObservationsParamsBack field to 30:

def & recentNotableObservationsParamsBack ?~ 30

Or, using -XOverloadedLabels:

def & #back ?~ 30

Constructors

RecentNotableObservationsParams

Fields

• _recentNotableObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentNotableObservationsParamsDetail :: Maybe DetailLevel

  Detail level for the resulting observations

  default: Simple

• _recentNotableObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentNotableObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentNotableObservationsParamsExtraRegions :: Maybe RegionCode

  Up to 10 extra regions to get observations from

  default: none

• _recentNotableObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentNotableObservationsParams

readList :: ReadS [RecentNotableObservationsParams]

readPrec :: ReadPrec RecentNotableObservationsParams

readListPrec :: ReadPrec [RecentNotableObservationsParams]

Show RecentNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentNotableObservationsParams -> ShowS

show :: RecentNotableObservationsParams -> String

showList :: [RecentNotableObservationsParams] -> ShowS

Default RecentNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentNotableObservationsParams

Eq RecentNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentNotableObservationsParams -> RecentNotableObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentNotableObservationsParams RecentNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNotableObservationsParams RecentNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe DetailLevel, b ~ Maybe DetailLevel) => LabelOptic "detail" k RecentNotableObservationsParams RecentNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNotableObservationsParams RecentNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe RegionCode, b ~ Maybe RegionCode) => LabelOptic "extraRegions" k RecentNotableObservationsParams RecentNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNotableObservationsParams RecentNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentNotableObservationsParams RecentNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNotableObservationsParams RecentNotableObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNotableObservationsParams RecentNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentNotableObservationsParams RecentNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNotableObservationsParams RecentNotableObservationsParams a b

defaultRecentNotableObservationsParams :: RecentNotableObservationsParams

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 RecentNotableObservationsParams

recentNotableObservationsParamsMaxResults :: Lens' RecentNotableObservationsParams (Maybe Integer)

recentNotableObservationsParamsLocale :: Lens' RecentNotableObservationsParams (Maybe SPPLocale)

recentNotableObservationsParamsHotspot :: Lens' RecentNotableObservationsParams (Maybe Bool)

recentNotableObservationsParamsExtraRegions :: Lens' RecentNotableObservationsParams (Maybe RegionCode)

recentNotableObservationsParamsDetail :: Lens' RecentNotableObservationsParams (Maybe DetailLevel)

recentNotableObservationsParamsBack :: Lens' RecentNotableObservationsParams (Maybe Integer)

Recent species observations

recentSpeciesObservations

Arguments

:: Text

eBird API key

-> RegionCode

Region(s) to get observations from

-> SpeciesCode

Species to get observations of (e.g. "barswa" for Barn Swallow)

-> RecentSpeciesObservationsParams

Optional parameters

default: defaultRecentSpeciesObservationsParams

-> ClientM [Observation 'Simple]

Get a list of recent observations of a specific species within a region.

For example, get observations of Peregrine Falcons from the last 30 days in Park County, Wyoming (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentSpeciesObservations key
    "US-WY-029"
    "perfal"
    (def & #back ?~ 30)

See the eBird API documentation for the corresponding endpoint.

data RecentSpeciesObservationsParams

Optional parameters accepted by the RecentSpeciesObservationsAPI.

Note that defaultRecentSpeciesObservationsParams (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 _recentSpeciesObservationsParamsBack field to 30:

def & recentSpeciesObservationsParamsBack ?~ 30

Or, using -XOverloadedLabels:

def & #back ?~ 30

Constructors

RecentSpeciesObservationsParams

Fields

• _recentSpeciesObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentSpeciesObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentSpeciesObservationsParamsProvisional :: Maybe Bool

  Include observations which have not been reviewed

  default: False

• _recentSpeciesObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentSpeciesObservationsParamsExtraRegions :: Maybe RegionCode

  Up to 10 extra regions to get observations from

  default: none

• _recentSpeciesObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentSpeciesObservationsParams

readList :: ReadS [RecentSpeciesObservationsParams]

readPrec :: ReadPrec RecentSpeciesObservationsParams

readListPrec :: ReadPrec [RecentSpeciesObservationsParams]

Show RecentSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentSpeciesObservationsParams -> ShowS

show :: RecentSpeciesObservationsParams -> String

showList :: [RecentSpeciesObservationsParams] -> ShowS

Default RecentSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentSpeciesObservationsParams

Eq RecentSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentSpeciesObservationsParams -> RecentSpeciesObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe RegionCode, b ~ Maybe RegionCode) => LabelOptic "extraRegions" k RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "provisional" k RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentSpeciesObservationsParams RecentSpeciesObservationsParams a b

defaultRecentSpeciesObservationsParams :: RecentSpeciesObservationsParams

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 RecentSpeciesObservationsParams

recentSpeciesObservationsParamsProvisional :: Lens' RecentSpeciesObservationsParams (Maybe Bool)

recentSpeciesObservationsParamsMaxResults :: Lens' RecentSpeciesObservationsParams (Maybe Integer)

recentSpeciesObservationsParamsLocale :: Lens' RecentSpeciesObservationsParams (Maybe SPPLocale)

recentSpeciesObservationsParamsHotspot :: Lens' RecentSpeciesObservationsParams (Maybe Bool)

recentSpeciesObservationsParamsExtraRegions :: Lens' RecentSpeciesObservationsParams (Maybe RegionCode)

recentSpeciesObservationsParamsBack :: Lens' RecentSpeciesObservationsParams (Maybe Integer)

Recent nearby observations

recentNearbyObservations

Arguments

:: Text

eBird API key

-> Double

Latitude of the location to get observations near

-> Double

Longitude of the location to get observations near

-> RecentNearbyObservationsParams

Optional parameters

default: defaultRecentNearbyObservationsParams

-> ClientM [Observation 'Simple]

Get a list of recent observations within some radius of some latitude/longitude.

For example, get up to 5 nearby observations within 10km of Cody, Wyoming (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentNearbyObservations key
    44.526340 (-109.056534)
    (def & #maxResults ?~ 5 & #radius ?~ 10)

See the eBird API documentation for the corresponding endpoint.

data RecentNearbyObservationsParams

Optional parameters accepted by the RecentNearbyObservationsAPI.

Note that defaultRecentNearbyObservationsParams (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 _recentNearbyObservationsParamsRadius field to 10km:

def & recentNearbyObservationsParamsRadius ?~ 10

Or, using -XOverloadedLabels:

def & #radius ?~ 10

Constructors

RecentNearbyObservationsParams

Fields

• _recentNearbyObservationsParamsRadius :: Maybe Integer

  Search radius from the given latitude/longitude in kilometers

  0 - 50, default: 25

• _recentNearbyObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentNearbyObservationsParamsCategories :: Maybe TaxonomyCategories

  Only include observations in these taxonomy categories

  default: all

• _recentNearbyObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentNearbyObservationsParamsProvisional :: Maybe Bool

  Include observations which have not been reviewed

  default: False

• _recentNearbyObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentNearbyObservationsParamsSortBy :: Maybe SortObservationsBy

  Sort observations by taxonomy (SortObservationsBySpecies) or by date (SortObservationsByDate, most recent first)

  default: SortObservationsByDate

• _recentNearbyObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentNearbyObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentNearbyObservationsParams

readList :: ReadS [RecentNearbyObservationsParams]

readPrec :: ReadPrec RecentNearbyObservationsParams

readListPrec :: ReadPrec [RecentNearbyObservationsParams]

Show RecentNearbyObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentNearbyObservationsParams -> ShowS

show :: RecentNearbyObservationsParams -> String

showList :: [RecentNearbyObservationsParams] -> ShowS

Default RecentNearbyObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentNearbyObservationsParams

Eq RecentNearbyObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentNearbyObservationsParams -> RecentNearbyObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentNearbyObservationsParams RecentNearbyObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentNearbyObservationsParams RecentNearbyObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentNearbyObservationsParams RecentNearbyObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "provisional" k RecentNearbyObservationsParams RecentNearbyObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "radius" k RecentNearbyObservationsParams RecentNearbyObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

(k ~ A_Lens, a ~ Maybe SortObservationsBy, b ~ Maybe SortObservationsBy) => LabelOptic "sortBy" k RecentNearbyObservationsParams RecentNearbyObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyObservationsParams RecentNearbyObservationsParams a b

defaultRecentNearbyObservationsParams :: RecentNearbyObservationsParams

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 RecentNearbyObservationsParams

recentNearbyObservationsParamsSortBy :: Lens' RecentNearbyObservationsParams (Maybe SortObservationsBy)

recentNearbyObservationsParamsRadius :: Lens' RecentNearbyObservationsParams (Maybe Integer)

recentNearbyObservationsParamsProvisional :: Lens' RecentNearbyObservationsParams (Maybe Bool)

recentNearbyObservationsParamsMaxResults :: Lens' RecentNearbyObservationsParams (Maybe Integer)

recentNearbyObservationsParamsLocale :: Lens' RecentNearbyObservationsParams (Maybe SPPLocale)

recentNearbyObservationsParamsHotspot :: Lens' RecentNearbyObservationsParams (Maybe Bool)

recentNearbyObservationsParamsCategories :: Lens' RecentNearbyObservationsParams (Maybe TaxonomyCategories)

recentNearbyObservationsParamsBack :: Lens' RecentNearbyObservationsParams (Maybe Integer)

Recent nearby species observations

recentNearbySpeciesObservations

Arguments

:: Text

eBird API key

-> SpeciesCode

Species to get observations of (e.g. "bohwax" for Bohemian Waxwing)

-> Double

Latitude of the location to get observations near

-> Double

Longitude of the location to get observations near

-> RecentNearbySpeciesObservationsParams

Optional parameters

default: defaultRecentNearbySpeciesObservationsParams

-> ClientM [Observation 'Simple]

Get a list of recent observations of a species within some radius of some latitude/longitude.

For example, get up to 5 nearby observations of Peregrine Falcons within 50km of Cody, Wyoming (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentNearbySpeciesObservations key
    "perfal"
    44.526340 (-109.056534)
    (def & #radius ?~ 50 & #maxResults ?~ 5)

See the eBird API documentation for the corresponding endpoint.

data RecentNearbySpeciesObservationsParams

Optional parameters accepted by the RecentNearbySpeciesObservationsAPI.

Note that defaultRecentNearbySpeciesObservationsParams (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 _recentNearbySpeciesObservationsParamsRadius field to 10km:

def & recentNearbySpeciesObservationsParamsRadius ?~ 10

Or, using -XOverloadedLabels:

def & #radius ?~ 10

Constructors

RecentNearbySpeciesObservationsParams

Fields

• _recentNearbySpeciesObservationsParamsRadius :: Maybe Integer

  Search radius from the given latitude/longitude in kilometers

  0 - 50, default: 25

• _recentNearbySpeciesObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentNearbySpeciesObservationsParamsCategories :: Maybe TaxonomyCategories

  Only include observations in these taxonomy categories

  default: all

• _recentNearbySpeciesObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentNearbySpeciesObservationsParamsProvisional :: Maybe Bool

  Include observations which have not been reviewed

  default: False

• _recentNearbySpeciesObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentNearbySpeciesObservationsParamsSortBy :: Maybe SortObservationsBy

  Sort observations by taxonomy (SortObservationsBySpecies) or by date (SortObservationsByDate, most recent first)

  default: SortObservationsByDate

• _recentNearbySpeciesObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentNearbySpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentNearbySpeciesObservationsParams

readList :: ReadS [RecentNearbySpeciesObservationsParams]

readPrec :: ReadPrec RecentNearbySpeciesObservationsParams

readListPrec :: ReadPrec [RecentNearbySpeciesObservationsParams]

Show RecentNearbySpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentNearbySpeciesObservationsParams -> ShowS

show :: RecentNearbySpeciesObservationsParams -> String

showList :: [RecentNearbySpeciesObservationsParams] -> ShowS

Default RecentNearbySpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentNearbySpeciesObservationsParams

Eq RecentNearbySpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentNearbySpeciesObservationsParams -> RecentNearbySpeciesObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "provisional" k RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "radius" k RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe SortObservationsBy, b ~ Maybe SortObservationsBy) => LabelOptic "sortBy" k RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbySpeciesObservationsParams RecentNearbySpeciesObservationsParams a b

defaultRecentNearbySpeciesObservationsParams :: RecentNearbySpeciesObservationsParams

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 RecentNearbySpeciesObservationsParams

recentNearbySpeciesObservationsParamsSortBy :: Lens' RecentNearbySpeciesObservationsParams (Maybe SortObservationsBy)

recentNearbySpeciesObservationsParamsRadius :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer)

recentNearbySpeciesObservationsParamsProvisional :: Lens' RecentNearbySpeciesObservationsParams (Maybe Bool)

recentNearbySpeciesObservationsParamsMaxResults :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer)

recentNearbySpeciesObservationsParamsLocale :: Lens' RecentNearbySpeciesObservationsParams (Maybe SPPLocale)

recentNearbySpeciesObservationsParamsHotspot :: Lens' RecentNearbySpeciesObservationsParams (Maybe Bool)

recentNearbySpeciesObservationsParamsCategories :: Lens' RecentNearbySpeciesObservationsParams (Maybe TaxonomyCategories)

recentNearbySpeciesObservationsParamsBack :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer)

Recent nearest species observations

recentNearestSpeciesObservations

Arguments

:: Text

eBird API key

-> SpeciesCode

Species to get observations of (e.g. "bohwax" for Bohemian Waxwing)

-> Double

Latitude of the location to get observations near

-> Double

Longitude of the location to get observations near

-> RecentNearestSpeciesObservationsParams

Optional parameters

default: defaultRecentNearestSpeciesObservationsParams

-> ClientM [Observation 'Simple]

Get a list of recent observations of some species nearest to some latitude/longitude.

For example, get the 5 nearest observations of Black-throated Gray Warblers within 50km of Capitol Reef National Park (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentNearestSpeciesObservations key
    "btywar"
    38.366970 (-111.261504)
    (def & #radius ?~ 50 & #maxResults ?~ 5)

See the eBird API documentation for the corresponding endpoint.

data RecentNearestSpeciesObservationsParams

Optional parameters accepted by the RecentNearestSpeciesObservationsAPI.

Note that defaultRecentNearestSpeciesObservationsParams (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 _recentNearestSpeciesObservationsParamsRadius field to 10km:

def & recentNearestSpeciesObservationsParamsRadius ?~ 10

Or, using -XOverloadedLabels:

def & #radius ?~ 10

Constructors

RecentNearestSpeciesObservationsParams

Fields

• _recentNearestSpeciesObservationsParamsRadius :: Maybe Integer

  Search radius from the given latitude/longitude in kilometers

  0 - 50, default: 25

• _recentNearestSpeciesObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentNearestSpeciesObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentNearestSpeciesObservationsParamsProvisional :: Maybe Bool

  Include observations which have not been reviewed

  default: False

• _recentNearestSpeciesObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentNearestSpeciesObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentNearestSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentNearestSpeciesObservationsParams

readList :: ReadS [RecentNearestSpeciesObservationsParams]

readPrec :: ReadPrec RecentNearestSpeciesObservationsParams

readListPrec :: ReadPrec [RecentNearestSpeciesObservationsParams]

Show RecentNearestSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentNearestSpeciesObservationsParams -> ShowS

show :: RecentNearestSpeciesObservationsParams -> String

showList :: [RecentNearestSpeciesObservationsParams] -> ShowS

Default RecentNearestSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentNearestSpeciesObservationsParams

Eq RecentNearestSpeciesObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentNearestSpeciesObservationsParams -> RecentNearestSpeciesObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "provisional" k RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "radius" k RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearestSpeciesObservationsParams RecentNearestSpeciesObservationsParams a b

defaultRecentNearestSpeciesObservationsParams :: RecentNearestSpeciesObservationsParams

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 RecentNearestSpeciesObservationsParams

recentNearestSpeciesObservationsParamsRadius :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer)

recentNearestSpeciesObservationsParamsProvisional :: Lens' RecentNearestSpeciesObservationsParams (Maybe Bool)

recentNearestSpeciesObservationsParamsMaxResults :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer)

recentNearestSpeciesObservationsParamsLocale :: Lens' RecentNearestSpeciesObservationsParams (Maybe SPPLocale)

recentNearestSpeciesObservationsParamsHotspot :: Lens' RecentNearestSpeciesObservationsParams (Maybe Bool)

recentNearestSpeciesObservationsParamsBack :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer)

Recent nearby notable observations

recentNearbyNotableObservations

Arguments

:: Text

eBird API key

-> Double

Latitude of the location to get observations near

-> Double

Longitude of the location to get observations near

-> RecentNearbyNotableObservationsParams

Optional parameters

default: defaultRecentNearbyNotableObservationsParams

-> ClientM [SomeObservation]

Get a list of recent notable observations of some near some latitude/longitude.

For example, get 5 notable observations within 25km of Capitol Reef National Park (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  recentNearbyNotableObservations key
    38.366970 (-111.261504)
    (def & #radius ?~ 25 & #maxResults ?~ 5)

See the eBird API documentation for the corresponding endpoint.

data RecentNearbyNotableObservationsParams

Optional parameters accepted by the RecentNearbyNotableObservationsAPI.

Note that defaultRecentNearbyNotableObservationsParams (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 _recentNearbyNotableObservationsParamsRadius field to 10km:

def & recentNearbyNotableObservationsParamsRadius ?~ 10

Or, using -XOverloadedLabels:

def & #radius ?~ 10

Constructors

RecentNearbyNotableObservationsParams

Fields

• _recentNearbyNotableObservationsParamsRadius :: Maybe Integer

  Search radius from the given latitude/longitude in kilometers

  0 - 50, default: 25

• _recentNearbyNotableObservationsParamsDetail :: Maybe DetailLevel

  Detail level for the resulting observations

  default: Simple

• _recentNearbyNotableObservationsParamsBack :: Maybe Integer

  How many days back to look for observations

  1 - 30, default: 14

• _recentNearbyNotableObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _recentNearbyNotableObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _recentNearbyNotableObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read RecentNearbyNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS RecentNearbyNotableObservationsParams

readList :: ReadS [RecentNearbyNotableObservationsParams]

readPrec :: ReadPrec RecentNearbyNotableObservationsParams

readListPrec :: ReadPrec [RecentNearbyNotableObservationsParams]

Show RecentNearbyNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> RecentNearbyNotableObservationsParams -> ShowS

show :: RecentNearbyNotableObservationsParams -> String

showList :: [RecentNearbyNotableObservationsParams] -> ShowS

Default RecentNearbyNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: RecentNearbyNotableObservationsParams

Eq RecentNearbyNotableObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: RecentNearbyNotableObservationsParams -> RecentNearbyNotableObservationsParams -> Bool

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

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe DetailLevel, b ~ Maybe DetailLevel) => LabelOptic "detail" k RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "radius" k RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx RecentNearbyNotableObservationsParams RecentNearbyNotableObservationsParams a b

defaultRecentNearbyNotableObservationsParams :: RecentNearbyNotableObservationsParams

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 RecentNearbyNotableObservationsParams

recentNearbyNotableObservationsParamsRadius :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer)

recentNearbyNotableObservationsParamsMaxResults :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer)

recentNearbyNotableObservationsParamsLocale :: Lens' RecentNearbyNotableObservationsParams (Maybe SPPLocale)

recentNearbyNotableObservationsParamsHotspot :: Lens' RecentNearbyNotableObservationsParams (Maybe Bool)

recentNearbyNotableObservationsParamsDetail :: Lens' RecentNearbyNotableObservationsParams (Maybe DetailLevel)

recentNearbyNotableObservationsParamsBack :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer)

Historical observations

historicalObservations

Arguments

:: Text

eBird API key

-> RegionCode

Region(s) to get observations from

-> EBirdDate

Date to get observations on, from year 1800 to present

-> HistoricalObservationsParams

Optional parameters

default: defaultHistoricalObservationsParams

-> ClientM [SomeObservation]

Get a list of observations for each species seen on a specific date.

For example, get a list of 10 fully detailed observations for each species seen on July 11th, 2023 in Park County, Wyoming (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  historicalObservations key
    "US-WY-029"
    "2023-07-11"
    (def & #maxResults ?~ 10 & #detail ?~ Full)

See the eBird API documentation for the corresponding endpoint.

data HistoricalObservationsParams

Optional parameters accepted by the HistoricalObservationsAPI.

Note that defaultHistoricalObservationsParams (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 _historicalObservationsParamsDetail field to Full:

def & historicalObservationsParamsDetail ?~ Full

Or, using -XOverloadedLabels:

def & #detail ?~ Full

Constructors

HistoricalObservationsParams

Fields

• _historicalObservationsParamsCategories :: Maybe TaxonomyCategories

  Only include observations in these taxonomy categories

  default: all

• _historicalObservationsParamsDetail :: Maybe DetailLevel

  Detail level for the resulting observations

  default: Simple

• _historicalObservationsParamsHotspot :: Maybe Bool

  Only get observations from hotspots

  default: False

• _historicalObservationsParamsProvisional :: Maybe Bool

  Include observations which have not been reviewed

  default: False

• _historicalObservationsParamsMaxResults :: Maybe Integer

  Maximum number of observations to get

  1 - 10000, default: all

• _historicalObservationsParamsSelect :: Maybe SelectObservation

  Whether to display the first or last observation of a species on the date, in the case that there are multiple observations of the same species on the date

  default: SelectLastObservation

• _historicalObservationsParamsExtraRegions :: Maybe RegionCode

  Up to 50 extra regions to get observations from

  default: none

• _historicalObservationsParamsLocale :: Maybe SPPLocale

  Return observations with common names in this locale

  default: En

Instances

Read HistoricalObservationsParams

Defined in Data.EBird.Client.Observations

Methods

readsPrec :: Int -> ReadS HistoricalObservationsParams

readList :: ReadS [HistoricalObservationsParams]

readPrec :: ReadPrec HistoricalObservationsParams

readListPrec :: ReadPrec [HistoricalObservationsParams]

Show HistoricalObservationsParams

Defined in Data.EBird.Client.Observations

Methods

showsPrec :: Int -> HistoricalObservationsParams -> ShowS

show :: HistoricalObservationsParams -> String

showList :: [HistoricalObservationsParams] -> ShowS

Default HistoricalObservationsParams

Defined in Data.EBird.Client.Observations

Methods

def :: HistoricalObservationsParams

Eq HistoricalObservationsParams

Defined in Data.EBird.Client.Observations

Methods

(==) :: HistoricalObservationsParams -> HistoricalObservationsParams -> Bool

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

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

(k ~ A_Lens, a ~ Maybe DetailLevel, b ~ Maybe DetailLevel) => LabelOptic "detail" k HistoricalObservationsParams HistoricalObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

(k ~ A_Lens, a ~ Maybe RegionCode, b ~ Maybe RegionCode) => LabelOptic "extraRegions" k HistoricalObservationsParams HistoricalObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "hotspot" k HistoricalObservationsParams HistoricalObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

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

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

(k ~ A_Lens, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "maxResults" k HistoricalObservationsParams HistoricalObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "provisional" k HistoricalObservationsParams HistoricalObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

(k ~ A_Lens, a ~ Maybe SelectObservation, b ~ Maybe SelectObservation) => LabelOptic "select" k HistoricalObservationsParams HistoricalObservationsParams a b

Defined in Data.EBird.Client.Observations

Methods

labelOptic :: Optic k NoIx HistoricalObservationsParams HistoricalObservationsParams a b

defaultHistoricalObservationsParams :: HistoricalObservationsParams

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 HistoricalObservationsParams

historicalObservationsParamsSelect :: Lens' HistoricalObservationsParams (Maybe SelectObservation)

historicalObservationsParamsProvisional :: Lens' HistoricalObservationsParams (Maybe Bool)

historicalObservationsParamsMaxResults :: Lens' HistoricalObservationsParams (Maybe Integer)

historicalObservationsParamsLocale :: Lens' HistoricalObservationsParams (Maybe SPPLocale)

historicalObservationsParamsHotspot :: Lens' HistoricalObservationsParams (Maybe Bool)

historicalObservationsParamsExtraRegions :: Lens' HistoricalObservationsParams (Maybe RegionCode)

historicalObservationsParamsDetail :: Lens' HistoricalObservationsParams (Maybe DetailLevel)

historicalObservationsParamsCategories :: Lens' HistoricalObservationsParams (Maybe TaxonomyCategories)