Table of Contents |
---|
Description
Returns a list of all species in the eBird taxonomy for the given combination of categories. The default category is "species". Any taxon with the category of 'species' may be used as a parameter in service calls that take a scientific name. Any taxon not in this category will be rejected by these services at this time.
This is part of the eBird version 1.1 API.
URL
Base URL
http://ebird.org/ws1.1/ref/taxa
...
http://ebird.org/ws1.1/ref/taxa/ebird
Fully specified:
http://ebird.org/ws1.1/ref/taxa/ebird?cat=subspecies&cat=species&fmt=xml&version=1.049locale=en_US
http://ebird.org/ws1.1/ref/taxa/ebird?cat=species,hybrid&fmt=json&locale=en_US
Parameter Descriptions
Parameter Name | Required | Default | Value Options | Example Value | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
cat | no | species subspecies | domestic,form,hybrid,intergrade,issf,slash,domestic,species,spuh,hybrid | hybrid | These can be comma-separated to include multiple categories in the results. For more info about the meaning of species categories, see http://ebird.org/content/ebird/about/ebird-taxonomy. | ||||||
locale | no | en_US | en,en_US,de,en_AE,en_AU,en_IN,en_NZ,en_UK,en_ZA,es,es_AR,es_CL,es_CU es_DO,es_ES,es_MX,es_PA,es_PR,fi,fr,fr_HT,ht_HT,in,is,pt_BR,pt_PT,tr,zh 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,json,csv | xml |
| version | no | 1.049 | 1.049 | 1.049 | the taxonomic authority version number |
Resources
The human readable version of the current eBird taxonomy can also be downloaded downloaded here. The following table might be helpful for encoding a scientific name within a URL:
Character | Encoding | ||
---|---|---|---|
Space | %20 | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6e3b0e65-17d9-4ba4-8b38-a9c0a18bd1d8"><ac:plain-text-body><![CDATA[ | Left Square Bracket ("[") | %5B | ]]></ac:plain-text-body></ac:structured-macro> |
Right Square Bracket ("]") | %5D | ||
Forward slash/Virgule ("/") | %2F |
Result Field Descriptions
...
Field (XML)
...
Description
...
sci-name
...
Scientific name
Result Fields
Field (XML) | Description |
---|---|
sci-name | Scientific name |
com-name | Common name |
taxon-id | Taxonomic Concept identifier, note this is currently in test |
species-code | An internal code for the taxon |
category | The taxonomic category (species, slash, etc.) |
taxon-order | A float representing the taxonomic order |
com-name-codes | Space-delimited quick find codes for English primary common name |
sci-name-codes | Space-delimited quick find codes for scientific name |
banding-codes | Official USGS banding code |
Example Responses
CSV
SCIENTIFIC_NAME | COMMON_NAME | TAXON_ID | SPECIES_CODE | CATEGORY | TAXON_ORDER | COM_NAME_CODES | SCI_NAME_CODES | BANDING_CODES | |
Struthio camelus | Ostrich | TC000001 | ostric1 | species | 1 | SOOS OSTR COOS | STCA |
XML
<?xml version="1.0" encoding="UTF-8"?>
<response><header><locale country="US" language="en"/><timestamp>2015-04-10T10:23:47.513-04:00</timestamp><criteria find-command-flag="false"><fmt>xml</fmt><dataset>eBird</dataset><version>1.55</version><cat>species</cat><locale country="US" language="en"/></criteria></header>
<result>
<taxa><taxon-id>TC000001</taxon-id><sci-name-codes>STCA</sci-name-codes><taxon-order>1.0</taxon-order><category>species</category><species-code>ostric1</species-code><com-name-codes>SOOS</com-name-codes><com-name-codes>OSTR</com-name-codes><com-name-codes>COOS</com-name-codes><com-name>Ostrich</com-name><sci-name>Struthio camelus</sci-name></taxa><taxa><taxon-id>TC000004</taxon-id><sci-name-codes>RHAM</sci-name-codes><taxon-order>7.0</taxon-order><category>species</category><species-code>grerhe1</species-code><com-name-codes>GRRH</com-name-codes><com-name>Greater Rhea</com-name><sci-name>Rhea americana</sci-name></taxa>
<taxa><taxon-id>TC000005</taxon-id><sci-name-codes>RHPE</sci-name-codes><taxon-order>13.0</taxon-order><category>species</category><species-code>lesrhe2</species-code><com-name-codes>LERH</com-name-codes><com-name>Lesser Rhea</com-name><sci-name>Rhea pennata</sci-name></taxa><taxa><taxon-id>TC000018</taxon-id><sci-name-codes>NOJU</sci-name-codes><taxon-order>32.0</taxon-order><category>species</category><species-code>tabtin1</species-code><com-name-codes>TBTI</com-name-codes><com-name>Tawny-breasted Tinamou</com-name><sci-name>Nothocercus julius</sci-name></taxa>
</result>
JSON
[{"bandingCodes":[],"category":"species","comName":"Ostrich","comNameCodes":["SOOS","OSTR","COOS"],"sciName":"Struthio camelus","sciNameCodes":["STCA"],"speciesCode":"ostric1","taxonID":"TC000001","taxonOrder":1},{"bandingCodes":[],"category":"species","comName":"Greater Rhea","comNameCodes":["GRRH"],"sciName":"Rhea americana","sciNameCodes":["RHAM"],"speciesCode":"grerhe1","taxonID":"TC000004","taxonOrder":7},{"bandingCodes":[],"category":"species","comName":"Lesser Rhea","comNameCodes":["LERH"],"sciName":"Rhea pennata","sciNameCodes":["RHPE"],"speciesCode":"lesrhe2","taxonID":"TC000005","taxonOrder":13}]
Caching Information
For details on caching of results by our servers, see eBird-1.1-CacheInformation
...
com-name
...