Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{toc}

h2. 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|eBird-1.1].

h2. URL

*Base URL*

[http://ebird.org/ws1.1/ref/taxa]

*Examples*

Minimal:

[http://ebird.org/ws1.1/ref/taxa/ebird]

Fully specified:

[http://ebird.org/ws1.1/ref/taxa/ebird?cat=species&fmt=xml&version=1.049&locale=en_US]

h2. Parameter Descriptions

|| Parameter Name || Required || Default || Value Options || Example Value || Description ||
| cat | no | species | subspecies,slash,domestic,species,spuh,hybrid | 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 \\ | |
| version \\ | no \\ | 1.049 \\ | 1.049 \\ | 1.049 \\ | the taxonomic authority version number \\ |

h3. Resources

The human readable version of the current eBird taxonomy can also be downloaded  [here|http://ebird.org/content/ebird/about/ebird-taxonomy]. 

h2. Result Fields

|| *Field (XML)* || *Description* ||
| sci-name | Scientific name |
| com-name | Common name |

h3. Example Responses


h4. CSV

{noformat}
Rhea americana,Greater Rhea
Rhea pennata,Lesser Rhea
{noformat}

h4. XML

{noformat}
<response>
    <header>
        <locale country="" language="en"/>
        <timestamp>
            2009-07-08T10:39:42.150-04:00
        </timestamp>
        <criteria>
            <locale country="" language="en"/>
            <cat>
                species
            </cat>
            <version>
                1.049
            </version>
            <fmt>
                xml
            </fmt>
        </criteria>
    </header>
    <result>
    <taxa>
        <com-name>
            Greater Rhea
        </com-name>
        <sci-name>
            Rhea americana
        </sci-name>
    </taxa>
    <taxa>
        <com-name>
            Lesser Rhea
        </com-name>
        <sci-name>
            Rhea pennata
        </sci-name>
    </taxa>
</response>
{noformat}

h2. Caching Information

For details on caching of results by our servers, see [eBird-1.1-CacheInformation]
{import:eBird-footer}