Description
Returns location-based look-up data based on the rtype (Region Type) parameter; rtype options are: bcr, country, subnational1, and subnational2. Non-parameterized list URIs - lists all records for a specific rtype, list plus sub-category parameter URIs - lists those records matching the sub-category parameter, find URIs - search for matching records in the primary name field on whole word or partial word stubs passed visa the match parameter.
This is part of the eBird version 1.1 API.
URL
Base URL
http://ebird.org/ws1.1/ref/location
Examples
Minimal list:
http://ebird.org/ws1.1/ref/location/list?rtype=bcr
http://ebird.org/ws1.1/ref/location/list?rtype=country
http://ebird.org/ws1.1/ref/location/list?rtype=subnational1
http://ebird.org/ws1.1/ref/location/list?rtype=subnational2
Minimal find:
http://ebird.org/ws1.1/ref/location/find?rtype=bcr&match=north
http://ebird.org/ws1.1/ref/location/find?rtype=country&match=stan
http://ebird.org/ws1.1/ref/location/find?rtype=subnational1&match=new
http://ebird.org/ws1.1/ref/location/find?rtype=subnational2&match=west
Fully specified:
http://ebird.org/ws1.1/ref/taxa/ebird?cat=species&fmt=xml&locale=en_US
Parameter Descriptions
Parameter Name |
Required |
Default |
Value Options |
Example Value |
Description |
|---|---|---|---|---|---|
cat |
no |
species |
domestic,form,hybrid,intergrade,issf,slash,species,spuh |
hybrid |
For more info about the meaning of species categories, see http://ebird.org/content/ebird/about/ebird-taxonomy |
locale |
no |
en_US |
fr_CA,es_MX,es_PR,ht_HT,fr,fr_HT,es_CU,es_PA,es_DO,en_NZ,es,es_CL |
fr_CA |
The locale for the taxon common name |
fmt |
no |
csv |
xml,csv |
xml |
|
Resources
The human readable version of the current eBird taxonomy can also be downloaded here.
Result Fields
Field (XML) |
Description |
|---|---|
sci-name |
Scientific name |
com-name |
Common name |
taxon-id |
Taxonomic Concept identifier, note this is currently in test |
Example Responses
CSV
Rhea americana,Greater Rhea,TC000004 Rhea pennata,Lesser Rhea, TC000005
XML
<response>
<header>
<locale country="" language="en"/>
<timestamp>
2009-07-08T10:39:42.150-04:00
</timestamp>
<criteria>
<locale country="" language="en"/>
<cat>
species
</cat>
<fmt>
xml
</fmt>
</criteria>
</header>
<result>
<taxa>
<com-name>
Greater Rhea
</com-name>
<sci-name>
Rhea americana
</sci-name>
<taxon-id>
TC00000004
</taxon-id>
</taxa>
<taxa>
<com-name>
Lesser Rhea
</com-name>
<sci-name>
Rhea pennata
</sci-name>
<taxon-id>
TC00000005
</taxon-id>
</taxa>
</response>
Caching Information
For details on caching of results by our servers, see eBird-1.1-CacheInformation
Unknown macro: {import}