api.md

Data

Observations

Types:

from phoebe_bird.types.data import Observation

Recent

Types:

from phoebe_bird.types.data.observations import RecentListResponse

Methods:

• client.data.observations.recent.list(region_code, **params) -> RecentListResponse

Notable

Types:

from phoebe_bird.types.data.observations.recent import NotableListResponse

Methods:

• client.data.observations.recent.notable.list(region_code, **params) -> NotableListResponse

Species

Types:

from phoebe_bird.types.data.observations.recent import SpecieRetrieveResponse

Methods:

• client.data.observations.recent.species.retrieve(species_code, *, region_code, **params) -> SpecieRetrieveResponse

Historic

Types:

from phoebe_bird.types.data.observations.recent import HistoricListResponse

Methods:

• client.data.observations.recent.historic.list(d, *, region_code, y, m, **params) -> HistoricListResponse

Geo

Recent

Types:

from phoebe_bird.types.data.observations.geo import RecentListResponse

Methods:

• client.data.observations.geo.recent.list(**params) -> RecentListResponse

Species

Types:

from phoebe_bird.types.data.observations.geo.recent import SpecieListResponse

Methods:

• client.data.observations.geo.recent.species.list(species_code, **params) -> SpecieListResponse

Notable

Types:

from phoebe_bird.types.data.observations.geo.recent import NotableListResponse

Methods:

• client.data.observations.geo.recent.notable.list(**params) -> NotableListResponse

Nearest

GeoSpecies

Types:

from phoebe_bird.types.data.observations.nearest import GeoSpecieListResponse

Methods:

• client.data.observations.nearest.geo_species.list(species_code, **params) -> GeoSpecieListResponse

Product

Lists

Types:

from phoebe_bird.types.product import ListRetrieveResponse

Methods:

• client.product.lists.retrieve(region_code, **params) -> ListRetrieveResponse

Historical

Types:

from phoebe_bird.types.product.lists import HistoricalRetrieveResponse

Methods:

• client.product.lists.historical.retrieve(d, *, region_code, y, m, **params) -> HistoricalRetrieveResponse

Top100

Types:

from phoebe_bird.types.product import Top100RetrieveResponse

Methods:

• client.product.top100.retrieve(d, *, region_code, y, m, **params) -> Top100RetrieveResponse

Stats

Types:

from phoebe_bird.types.product import StatRetrieveResponse

Methods:

• client.product.stats.retrieve(d, *, region_code, y, m) -> StatRetrieveResponse

SpeciesList

Types:

from phoebe_bird.types.product import SpeciesListListResponse

Methods:

• client.product.species_list.list(region_code) -> SpeciesListListResponse

Checklist

Types:

from phoebe_bird.types.product import ChecklistViewResponse

Methods:

• client.product.checklist.view(sub_id) -> ChecklistViewResponse

Ref

Region

Adjacent

Types:

from phoebe_bird.types.ref.region import AdjacentListResponse

Methods:

• client.ref.region.adjacent.list(region_code) -> AdjacentListResponse

Info

Types:

from phoebe_bird.types.ref.region import InfoRetrieveResponse

Methods:

• client.ref.region.info.retrieve(region_code, **params) -> InfoRetrieveResponse

List

Types:

from phoebe_bird.types.ref.region import ListListResponse

Methods:

• client.ref.region.list.list(parent_region_code, *, region_type, **params) -> ListListResponse

Hotspot

Types:

from phoebe_bird.types.ref import HotspotListResponse

Methods:

• client.ref.hotspot.list(region_code, **params) -> HotspotListResponse

Geo

Types:

from phoebe_bird.types.ref.hotspot import GeoRetrieveResponse

Methods:

• client.ref.hotspot.geo.retrieve(**params) -> GeoRetrieveResponse

Info

Types:

from phoebe_bird.types.ref.hotspot import InfoRetrieveResponse

Methods:

• client.ref.hotspot.info.retrieve(loc_id) -> InfoRetrieveResponse

Taxonomy

Ebird

Types:

from phoebe_bird.types.ref.taxonomy import EbirdRetrieveResponse

Methods:

• client.ref.taxonomy.ebird.retrieve(**params) -> EbirdRetrieveResponse

Forms

Types:

from phoebe_bird.types.ref.taxonomy import FormListResponse

Methods:

• client.ref.taxonomy.forms.list(species_code) -> FormListResponse

Locales

Types:

from phoebe_bird.types.ref.taxonomy import LocaleListResponse

Methods:

• client.ref.taxonomy.locales.list() -> LocaleListResponse

Versions

Types:

from phoebe_bird.types.ref.taxonomy import VersionListResponse

Methods:

• client.ref.taxonomy.versions.list() -> VersionListResponse

SpeciesGroups

Types:

from phoebe_bird.types.ref.taxonomy import SpeciesGroupListResponse

Methods:

• client.ref.taxonomy.species_groups.list(species_grouping, **params) -> SpeciesGroupListResponse