api.md

Data

Observations

Response Types:

• phoebe.Observation

Recent

Methods:

• client.Data.Observations.Recent.List(ctx context.Context, regionCode string, query phoebe.DataObservationRecentListParams) ([]phoebe.Observation, error)

Notable

Methods:

• client.Data.Observations.Recent.Notable.List(ctx context.Context, regionCode string, query phoebe.DataObservationRecentNotableListParams) ([]phoebe.Observation, error)

Species

Methods:

• client.Data.Observations.Recent.Species.Get(ctx context.Context, regionCode string, speciesCode string, query phoebe.DataObservationRecentSpecieGetParams) ([]phoebe.Observation, error)

Historic

Methods:

• client.Data.Observations.Recent.Historic.List(ctx context.Context, regionCode string, y int64, m int64, d int64, query phoebe.DataObservationRecentHistoricListParams) ([]phoebe.Observation, error)

Geo

Recent

Methods:

• client.Data.Observations.Geo.Recent.List(ctx context.Context, query phoebe.DataObservationGeoRecentListParams) ([]phoebe.Observation, error)

Species

Methods:

• client.Data.Observations.Geo.Recent.Species.List(ctx context.Context, speciesCode string, query phoebe.DataObservationGeoRecentSpecieListParams) ([]phoebe.Observation, error)

Notable

Methods:

• client.Data.Observations.Geo.Recent.Notable.List(ctx context.Context, query phoebe.DataObservationGeoRecentNotableListParams) ([]phoebe.Observation, error)

Nearest

GeoSpecies

Methods:

• client.Data.Observations.Nearest.GeoSpecies.List(ctx context.Context, speciesCode string, query phoebe.DataObservationNearestGeoSpecieListParams) ([]phoebe.Observation, error)

Product

Lists

Response Types:

• phoebe.ProductListGetResponse

Methods:

• client.Product.Lists.Get(ctx context.Context, regionCode string, query phoebe.ProductListGetParams) ([]phoebe.ProductListGetResponse, error)

Historical

Response Types:

• phoebe.ProductListHistoricalGetResponse

Methods:

• client.Product.Lists.Historical.Get(ctx context.Context, regionCode string, y int64, m int64, d int64, query phoebe.ProductListHistoricalGetParams) ([]phoebe.ProductListHistoricalGetResponse, error)

Top100

Response Types:

• phoebe.ProductTop100GetResponse

Methods:

• client.Product.Top100.Get(ctx context.Context, regionCode string, y int64, m int64, d int64, query phoebe.ProductTop100GetParams) ([]phoebe.ProductTop100GetResponse, error)

Stats

Response Types:

• phoebe.ProductStatGetResponse

Methods:

• client.Product.Stats.Get(ctx context.Context, regionCode string, y int64, m int64, d int64) (phoebe.ProductStatGetResponse, error)

SpeciesList

Methods:

• client.Product.SpeciesList.List(ctx context.Context, regionCode string) ([]string, error)

Checklist

Response Types:

• phoebe.ProductChecklistViewResponse

Methods:

• client.Product.Checklist.View(ctx context.Context, subID string) (phoebe.ProductChecklistViewResponse, error)

Ref

Region

Adjacent

Response Types:

• phoebe.RefRegionAdjacentListResponse

Methods:

• client.Ref.Region.Adjacent.List(ctx context.Context, regionCode string) ([]phoebe.RefRegionAdjacentListResponse, error)

Info

Response Types:

• phoebe.RefRegionInfoGetResponse

Methods:

• client.Ref.Region.Info.Get(ctx context.Context, regionCode string, query phoebe.RefRegionInfoGetParams) (phoebe.RefRegionInfoGetResponse, error)

List

Response Types:

• phoebe.RefRegionListListResponse

Methods:

• client.Ref.Region.List.List(ctx context.Context, regionType string, parentRegionCode string, query phoebe.RefRegionListListParams) ([]phoebe.RefRegionListListResponse, error)

Hotspot

Response Types:

• phoebe.RefHotspotListResponse

Methods:

• client.Ref.Hotspot.List(ctx context.Context, regionCode string, query phoebe.RefHotspotListParams) ([]phoebe.RefHotspotListResponse, error)

Geo

Response Types:

• phoebe.RefHotspotGeoGetResponse

Methods:

• client.Ref.Hotspot.Geo.Get(ctx context.Context, query phoebe.RefHotspotGeoGetParams) ([]phoebe.RefHotspotGeoGetResponse, error)

Info

Response Types:

• phoebe.RefHotspotInfoGetResponse

Methods:

• client.Ref.Hotspot.Info.Get(ctx context.Context, locID string) (phoebe.RefHotspotInfoGetResponse, error)

Taxonomy

Ebird

Response Types:

• phoebe.RefTaxonomyEbirdGetResponse

Methods:

• client.Ref.Taxonomy.Ebird.Get(ctx context.Context, query phoebe.RefTaxonomyEbirdGetParams) ([]phoebe.RefTaxonomyEbirdGetResponse, error)

Forms

Methods:

• client.Ref.Taxonomy.Forms.List(ctx context.Context, speciesCode string) ([]string, error)

Locales

Response Types:

• phoebe.RefTaxonomyLocaleListResponse

Methods:

• client.Ref.Taxonomy.Locales.List(ctx context.Context, query phoebe.RefTaxonomyLocaleListParams) ([]phoebe.RefTaxonomyLocaleListResponse, error)

Versions

Response Types:

• phoebe.RefTaxonomyVersionListResponse

Methods:

• client.Ref.Taxonomy.Versions.List(ctx context.Context) ([]phoebe.RefTaxonomyVersionListResponse, error)

SpeciesGroups

Response Types:

• phoebe.RefTaxonomySpeciesGroupListResponse

Methods:

• client.Ref.Taxonomy.SpeciesGroups.List(ctx context.Context, speciesGrouping phoebe.RefTaxonomySpeciesGroupListParamsSpeciesGrouping, query phoebe.RefTaxonomySpeciesGroupListParams) ([]phoebe.RefTaxonomySpeciesGroupListResponse, error)