eBird & AKN Frequency Histogram API

location

• exactly one location parameter is required

location

One of eBird standard subnational1 codes , 2-letter ISO codes, integers 1-66, ebird subnat2 codes

US-FL

n/a

locationType

One of subnational1,country,bcr,subnational2

n/a

period

• period parameters are optional
• if specified, both must be provided
• constraint beginYear <= endYear
  

beginYear

defines beginning of period of interest, in YYYY format

2000

1900

endYear

defines end of period of interest, in YYYY format

2000

2008 (i.e., current year)

collection

• defines dataset of interest
• required

collection

AKN collection codes, eBird project IDs; initially there will be no away to request the entirety of AKN data as a collection

sample AKN collection codes:
ARCTICSURVEY, BBS, Banding, GBBC, HawkCount, KBMNPC, LACP, LBMP, MBW, MMP, PFW, PIF_CA_AREA, PIF_CA_PC, PRBO-PC, RMBO-SS, RMBO_PT,  

sample eBird collection codes:
EBIRD, EBIRD_AK, EBIRD_BCN, EBIRD_CA, EBIRD_CAN, EBIRD_CBW, EBIRD_CUBA, EBIRD_GCBO, EBIRD_HISP, EBIRD_KLAM_SISK, EBIRD_LWBA, EBIRD_MA, EBIRD_MEX, EBIRD_NY, EBIRD_PR, EBIRD_PRIMIG, EBIRD_TX, EBIRD_USVI, EBIRD_VT, EBIRD_WI

EBIRD_PR

n/a

species

• defines species of interest
• optional

species

either "all" or scientific name of single species of interest; we will handle lists of species at a later date

Sialia sialis

all

output

• defines form of output
• optional

output

"f" = returns frequency (float, 0.0-1.0)
"c" = returns category (integer, 1-5)
"i" = returns image for single species; valid only when single species is requested; implemented at a later date

f

f

locale

•  defines language to use for common names
• optional

locale

Java standard locale code

en_US

en_US