Copyright | (c) 2023 Finley McIlwaine |
---|---|
License | MIT (see LICENSE) |
Maintainer | Finley McIlwaine <finleymcilwaine@gmail.com> |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Types and functions for observation-related eBird API queries.
Synopsis
- recentObservations :: Text -> RegionCode -> RecentObservationsParams -> ClientM [Observation 'Simple]
- data RecentObservationsParams = RecentObservationsParams {
- _recentObservationsParamsBack :: Maybe Integer
- _recentObservationsParamsCategories :: Maybe TaxonomyCategories
- _recentObservationsParamsHotspot :: Maybe Bool
- _recentObservationsParamsProvisional :: Maybe Bool
- _recentObservationsParamsMaxResults :: Maybe Integer
- _recentObservationsParamsExtraRegions :: Maybe RegionCode
- _recentObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentObservationsParams :: 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)
- recentNotableObservations :: Text -> RegionCode -> RecentNotableObservationsParams -> ClientM [SomeObservation]
- data RecentNotableObservationsParams = RecentNotableObservationsParams {
- _recentNotableObservationsParamsBack :: Maybe Integer
- _recentNotableObservationsParamsDetail :: Maybe DetailLevel
- _recentNotableObservationsParamsHotspot :: Maybe Bool
- _recentNotableObservationsParamsMaxResults :: Maybe Integer
- _recentNotableObservationsParamsExtraRegions :: Maybe RegionCode
- _recentNotableObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentNotableObservationsParams :: 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)
- recentSpeciesObservations :: Text -> RegionCode -> SpeciesCode -> RecentSpeciesObservationsParams -> ClientM [Observation 'Simple]
- data RecentSpeciesObservationsParams = RecentSpeciesObservationsParams {
- _recentSpeciesObservationsParamsBack :: Maybe Integer
- _recentSpeciesObservationsParamsHotspot :: Maybe Bool
- _recentSpeciesObservationsParamsProvisional :: Maybe Bool
- _recentSpeciesObservationsParamsMaxResults :: Maybe Integer
- _recentSpeciesObservationsParamsExtraRegions :: Maybe RegionCode
- _recentSpeciesObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentSpeciesObservationsParams :: 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)
- recentNearbyObservations :: Text -> Double -> Double -> RecentNearbyObservationsParams -> ClientM [Observation 'Simple]
- data RecentNearbyObservationsParams = RecentNearbyObservationsParams {
- _recentNearbyObservationsParamsRadius :: Maybe Integer
- _recentNearbyObservationsParamsBack :: Maybe Integer
- _recentNearbyObservationsParamsCategories :: Maybe TaxonomyCategories
- _recentNearbyObservationsParamsHotspot :: Maybe Bool
- _recentNearbyObservationsParamsProvisional :: Maybe Bool
- _recentNearbyObservationsParamsMaxResults :: Maybe Integer
- _recentNearbyObservationsParamsSortBy :: Maybe SortObservationsBy
- _recentNearbyObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentNearbyObservationsParams :: 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)
- recentNearbySpeciesObservations :: Text -> SpeciesCode -> Double -> Double -> RecentNearbySpeciesObservationsParams -> ClientM [Observation 'Simple]
- data RecentNearbySpeciesObservationsParams = RecentNearbySpeciesObservationsParams {
- _recentNearbySpeciesObservationsParamsRadius :: Maybe Integer
- _recentNearbySpeciesObservationsParamsBack :: Maybe Integer
- _recentNearbySpeciesObservationsParamsCategories :: Maybe TaxonomyCategories
- _recentNearbySpeciesObservationsParamsHotspot :: Maybe Bool
- _recentNearbySpeciesObservationsParamsProvisional :: Maybe Bool
- _recentNearbySpeciesObservationsParamsMaxResults :: Maybe Integer
- _recentNearbySpeciesObservationsParamsSortBy :: Maybe SortObservationsBy
- _recentNearbySpeciesObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentNearbySpeciesObservationsParams :: 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)
- recentNearestSpeciesObservations :: Text -> SpeciesCode -> Double -> Double -> RecentNearestSpeciesObservationsParams -> ClientM [Observation 'Simple]
- data RecentNearestSpeciesObservationsParams = RecentNearestSpeciesObservationsParams {
- _recentNearestSpeciesObservationsParamsRadius :: Maybe Integer
- _recentNearestSpeciesObservationsParamsBack :: Maybe Integer
- _recentNearestSpeciesObservationsParamsHotspot :: Maybe Bool
- _recentNearestSpeciesObservationsParamsProvisional :: Maybe Bool
- _recentNearestSpeciesObservationsParamsMaxResults :: Maybe Integer
- _recentNearestSpeciesObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentNearestSpeciesObservationsParams :: 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)
- recentNearbyNotableObservations :: Text -> Double -> Double -> RecentNearbyNotableObservationsParams -> ClientM [SomeObservation]
- data RecentNearbyNotableObservationsParams = RecentNearbyNotableObservationsParams {
- _recentNearbyNotableObservationsParamsRadius :: Maybe Integer
- _recentNearbyNotableObservationsParamsDetail :: Maybe DetailLevel
- _recentNearbyNotableObservationsParamsBack :: Maybe Integer
- _recentNearbyNotableObservationsParamsHotspot :: Maybe Bool
- _recentNearbyNotableObservationsParamsMaxResults :: Maybe Integer
- _recentNearbyNotableObservationsParamsLocale :: Maybe SPPLocale
- defaultRecentNearbyNotableObservationsParams :: 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)
- historicalObservations :: Text -> RegionCode -> EBirdDate -> HistoricalObservationsParams -> ClientM [SomeObservation]
- data HistoricalObservationsParams = HistoricalObservationsParams {
- _historicalObservationsParamsCategories :: Maybe TaxonomyCategories
- _historicalObservationsParamsDetail :: Maybe DetailLevel
- _historicalObservationsParamsHotspot :: Maybe Bool
- _historicalObservationsParamsProvisional :: Maybe Bool
- _historicalObservationsParamsMaxResults :: Maybe Integer
- _historicalObservationsParamsSelect :: Maybe SelectObservation
- _historicalObservationsParamsExtraRegions :: Maybe RegionCode
- _historicalObservationsParamsLocale :: Maybe SPPLocale
- defaultHistoricalObservationsParams :: 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)
Recent observations
:: Text | eBird API key |
-> RegionCode | Region(s) to get observations from |
-> RecentObservationsParams | Optional parameters default: |
-> 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 Source #
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
RecentObservationsParams | |
|
Instances
defaultRecentObservationsParams :: RecentObservationsParams Source #
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
recentObservationsParamsLocale :: Lens' RecentObservationsParams (Maybe SPPLocale) Source #
recentObservationsParamsExtraRegions :: Lens' RecentObservationsParams (Maybe RegionCode) Source #
recentObservationsParamsCategories :: Lens' RecentObservationsParams (Maybe TaxonomyCategories) Source #
Recent notable observations
recentNotableObservations Source #
:: Text | eBird API key |
-> RegionCode | Region(s) to get observations from |
-> RecentNotableObservationsParams | Optional parameters |
-> 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 Source #
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
RecentNotableObservationsParams | |
|
Instances
defaultRecentNotableObservationsParams :: RecentNotableObservationsParams Source #
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) Source #
recentNotableObservationsParamsLocale :: Lens' RecentNotableObservationsParams (Maybe SPPLocale) Source #
recentNotableObservationsParamsHotspot :: Lens' RecentNotableObservationsParams (Maybe Bool) Source #
recentNotableObservationsParamsExtraRegions :: Lens' RecentNotableObservationsParams (Maybe RegionCode) Source #
recentNotableObservationsParamsDetail :: Lens' RecentNotableObservationsParams (Maybe DetailLevel) Source #
recentNotableObservationsParamsBack :: Lens' RecentNotableObservationsParams (Maybe Integer) Source #
Recent species observations
recentSpeciesObservations Source #
:: 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 |
-> 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 Source #
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
RecentSpeciesObservationsParams | |
|
Instances
defaultRecentSpeciesObservationsParams :: RecentSpeciesObservationsParams Source #
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) Source #
recentSpeciesObservationsParamsMaxResults :: Lens' RecentSpeciesObservationsParams (Maybe Integer) Source #
recentSpeciesObservationsParamsLocale :: Lens' RecentSpeciesObservationsParams (Maybe SPPLocale) Source #
recentSpeciesObservationsParamsHotspot :: Lens' RecentSpeciesObservationsParams (Maybe Bool) Source #
recentSpeciesObservationsParamsExtraRegions :: Lens' RecentSpeciesObservationsParams (Maybe RegionCode) Source #
recentSpeciesObservationsParamsBack :: Lens' RecentSpeciesObservationsParams (Maybe Integer) Source #
Recent nearby observations
recentNearbyObservations Source #
:: 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 |
-> 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 Source #
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
RecentNearbyObservationsParams | |
|
Instances
defaultRecentNearbyObservationsParams :: RecentNearbyObservationsParams Source #
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) Source #
recentNearbyObservationsParamsRadius :: Lens' RecentNearbyObservationsParams (Maybe Integer) Source #
recentNearbyObservationsParamsProvisional :: Lens' RecentNearbyObservationsParams (Maybe Bool) Source #
recentNearbyObservationsParamsMaxResults :: Lens' RecentNearbyObservationsParams (Maybe Integer) Source #
recentNearbyObservationsParamsLocale :: Lens' RecentNearbyObservationsParams (Maybe SPPLocale) Source #
recentNearbyObservationsParamsCategories :: Lens' RecentNearbyObservationsParams (Maybe TaxonomyCategories) Source #
Recent nearby species observations
recentNearbySpeciesObservations Source #
:: 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 |
-> 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 Source #
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
RecentNearbySpeciesObservationsParams | |
|
Instances
defaultRecentNearbySpeciesObservationsParams :: RecentNearbySpeciesObservationsParams Source #
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) Source #
recentNearbySpeciesObservationsParamsRadius :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer) Source #
recentNearbySpeciesObservationsParamsProvisional :: Lens' RecentNearbySpeciesObservationsParams (Maybe Bool) Source #
recentNearbySpeciesObservationsParamsMaxResults :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer) Source #
recentNearbySpeciesObservationsParamsLocale :: Lens' RecentNearbySpeciesObservationsParams (Maybe SPPLocale) Source #
recentNearbySpeciesObservationsParamsHotspot :: Lens' RecentNearbySpeciesObservationsParams (Maybe Bool) Source #
recentNearbySpeciesObservationsParamsCategories :: Lens' RecentNearbySpeciesObservationsParams (Maybe TaxonomyCategories) Source #
recentNearbySpeciesObservationsParamsBack :: Lens' RecentNearbySpeciesObservationsParams (Maybe Integer) Source #
Recent nearest species observations
recentNearestSpeciesObservations Source #
:: 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 |
-> 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 Source #
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
RecentNearestSpeciesObservationsParams | |
|
Instances
defaultRecentNearestSpeciesObservationsParams :: RecentNearestSpeciesObservationsParams Source #
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) Source #
recentNearestSpeciesObservationsParamsProvisional :: Lens' RecentNearestSpeciesObservationsParams (Maybe Bool) Source #
recentNearestSpeciesObservationsParamsMaxResults :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer) Source #
recentNearestSpeciesObservationsParamsLocale :: Lens' RecentNearestSpeciesObservationsParams (Maybe SPPLocale) Source #
recentNearestSpeciesObservationsParamsHotspot :: Lens' RecentNearestSpeciesObservationsParams (Maybe Bool) Source #
recentNearestSpeciesObservationsParamsBack :: Lens' RecentNearestSpeciesObservationsParams (Maybe Integer) Source #
Recent nearby notable observations
recentNearbyNotableObservations Source #
:: 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 |
-> 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 Source #
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
RecentNearbyNotableObservationsParams | |
|
Instances
defaultRecentNearbyNotableObservationsParams :: RecentNearbyNotableObservationsParams Source #
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) Source #
recentNearbyNotableObservationsParamsMaxResults :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer) Source #
recentNearbyNotableObservationsParamsLocale :: Lens' RecentNearbyNotableObservationsParams (Maybe SPPLocale) Source #
recentNearbyNotableObservationsParamsHotspot :: Lens' RecentNearbyNotableObservationsParams (Maybe Bool) Source #
recentNearbyNotableObservationsParamsDetail :: Lens' RecentNearbyNotableObservationsParams (Maybe DetailLevel) Source #
recentNearbyNotableObservationsParamsBack :: Lens' RecentNearbyNotableObservationsParams (Maybe Integer) Source #
Historical observations
historicalObservations Source #
:: 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: |
-> 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 Source #
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
HistoricalObservationsParams | |
|
Instances
defaultHistoricalObservationsParams :: HistoricalObservationsParams Source #
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) Source #
historicalObservationsParamsMaxResults :: Lens' HistoricalObservationsParams (Maybe Integer) Source #
historicalObservationsParamsLocale :: Lens' HistoricalObservationsParams (Maybe SPPLocale) Source #
historicalObservationsParamsExtraRegions :: Lens' HistoricalObservationsParams (Maybe RegionCode) Source #
historicalObservationsParamsDetail :: Lens' HistoricalObservationsParams (Maybe DetailLevel) Source #
historicalObservationsParamsCategories :: Lens' HistoricalObservationsParams (Maybe TaxonomyCategories) Source #