Data.EBird.Client.Hotspots

Types and functions for hotspot-related eBird API queries.

Region hotspots

regionHotspots

Arguments

:: RegionCode

Region(s) to get hotspots in

-> RegionHotspotsParams

Optional parameters

default: defaultRegionHotspotsParams

-> ClientM [Hotspot]

Get all hotspots in a list of one or more regions (RegionCode).

For example, get the hotspots in Albany County, Wyoming and Park County, Wyoming that have been visited in the last 5 days (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $ regionHotspots "US-WY-001,US-WY-029" (def & #back ?~ 5)

See the eBird API documentation for the corresponding endpoint.

newtype RegionHotspotsParams

Optional parameters accepted by the RegionHotspotsAPI.

Note that defaultRegionHotspotsParams (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 _regionHotspotsParamsBack field to 10:

def & regionHotspotsParamsBack ?~ 10

Or, using -XOverloadedLabels:

def & #back ?~ 10

Constructors

RegionHotspotsParams

Fields

• _regionHotspotsParamsBack :: Maybe Integer

  Only fetch hotspots that have been visited within this many days ago

  1 - 30, default: no limit

Instances

Read RegionHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

readsPrec :: Int -> ReadS RegionHotspotsParams

readList :: ReadS [RegionHotspotsParams]

readPrec :: ReadPrec RegionHotspotsParams

readListPrec :: ReadPrec [RegionHotspotsParams]

Show RegionHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

showsPrec :: Int -> RegionHotspotsParams -> ShowS

show :: RegionHotspotsParams -> String

showList :: [RegionHotspotsParams] -> ShowS

Default RegionHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

def :: RegionHotspotsParams

Eq RegionHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

(==) :: RegionHotspotsParams -> RegionHotspotsParams -> Bool

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

(k ~ An_Iso, a ~ Maybe Integer, b ~ Maybe Integer) => LabelOptic "back" k RegionHotspotsParams RegionHotspotsParams a b

Defined in Data.EBird.Client.Hotspots

Methods

labelOptic :: Optic k NoIx RegionHotspotsParams RegionHotspotsParams a b

defaultRegionHotspotsParams :: RegionHotspotsParams

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 RegionHotspotsParams

regionHotspotsParamsBack :: Iso' RegionHotspotsParams (Maybe Integer)

Nearby hotspots

nearbyHotspots

Arguments

:: Double

Latitude of the location to get hotspots near

-> Double

Longitude of the location to get hotspots near

-> NearbyHotspotsParams

Optional parameters

default: defaultNearbyHotspotsParams

-> ClientM [Hotspot]

Get all hotspots within a radius of some latitude/longitude.

For example, get the hotspots within 30km of Cody, Wyoming that have been visited in the last 5 days (using -XOverloadedLabels and -XOverloadedStrings):

askEBird $
  nearbyHotspots
    44.526340 (-109.056534)
    (def & #radius ?~ 30 & #back ?~ 5)

See the eBird API documentation for the corresponding endpoint.

data NearbyHotspotsParams

Optional parameters accepted by the NearbyHotspotsAPI.

Note that defaultNearbyHotspotsParams (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 _nearbyHotspotsParamsBack field to 10:

def & nearbyHotspotsParamsBack ?~ 10

Or, using -XOverloadedLabels:

def & #back ?~ 10

Constructors

NearbyHotspotsParams

Fields

• _nearbyHotspotsParamsBack :: Maybe Integer

  Only fetch hotspots that have been visited within this many days ago

  1 - 30, default: no limit

• _nearbyHotspotsParamsRadius :: Maybe Integer

Instances

Read NearbyHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

readsPrec :: Int -> ReadS NearbyHotspotsParams

readList :: ReadS [NearbyHotspotsParams]

readPrec :: ReadPrec NearbyHotspotsParams

readListPrec :: ReadPrec [NearbyHotspotsParams]

Show NearbyHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

showsPrec :: Int -> NearbyHotspotsParams -> ShowS

show :: NearbyHotspotsParams -> String

showList :: [NearbyHotspotsParams] -> ShowS

Default NearbyHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

def :: NearbyHotspotsParams

Eq NearbyHotspotsParams

Defined in Data.EBird.Client.Hotspots

Methods

(==) :: NearbyHotspotsParams -> NearbyHotspotsParams -> Bool

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

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

Defined in Data.EBird.Client.Hotspots

Methods

labelOptic :: Optic k NoIx NearbyHotspotsParams NearbyHotspotsParams a b

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

Defined in Data.EBird.Client.Hotspots

Methods

labelOptic :: Optic k NoIx NearbyHotspotsParams NearbyHotspotsParams a b

defaultNearbyHotspotsParams :: NearbyHotspotsParams

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 NearbyHotspotsParams

nearbyHotspotsParamsRadius :: Lens' NearbyHotspotsParams (Maybe Integer)

nearbyHotspotsParamsBack :: Lens' NearbyHotspotsParams (Maybe Integer)

Hotspot info

hotspotInfo

Arguments

:: Text

Hotspot location ID, e.g. "L2373040"

-> ClientM LocationData

Get information about a hotspot.

For example, get information for a hotspot with location ID "L2373040" (using -XOverloadedStrings):

askEBird $ hotspotInfo L2373040

Note that the endpoint for this query is simple enough that hotspotInfo is equivalent to the generated hotspotInfo_.

See the eBird API documentation for the corresponding endpoint.