Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter Name

Required

Default

Value Options

Example Value

Description

cat

no

species

domestic,form,hybrid,intergrade,issf,slash,species,spuh

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

The locale for the taxon common name

fmt

no

csv

xml,json,csv

xml

 

...

Field (XML)

Description

sci-name

Scientific name

com-name

Common name

taxon-id

Taxonomic Concept identifier, note this is currently in test

species-codeAn internal code for the taxon
categoryThe taxonomic category (species, slash, etc.)
taxon-orderA float representing the taxonomic order
com-name-codesSpace-delimited quick find codes for English primary common name
sci-name-codesSpace-delimited quick find codes for scientific name
banding-codesOfficial USGS banding codespecies-codeAn internal code for the taxon

Example Responses

CSV

SCIENTIFIC_NAME

...

COMMON_NAME

...

TAXON_ID

...

SPECIES_CODE

...

CATEGORY

...

TAXON_ORDERCOM_NAME_CODESSCI_NAME_CODESBANDING_CODES
Struthio camelus

...

Ostrich

...

TC000001

...

ostric1

...

species

...

XML

...

1SOOS OSTR COOSSTCA  

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

Wiki Markup{import:eBird-footer}