Page History

...

URL	description	status	notes
http://ebird.org/data/ebird/byloc/recent?locIDs=L97555,L259855	Return summary of recent sightings at the given locID(s)	deployed

Parameter Descriptions

parameter	required	default	value options	example value	description	status
locIDs	yes	n/a	comma-separated list of up to three locIDs	L97555,L259855	The data summary is computed using data submitted to the given locIDs (up to three). If you ask for more than three locIDs the "extras" are silently ignored. The locIDs are made cannonical before the query is run. That is, they are ordered alphabetically, then truncated to at most 3 IDs. If the locIDs given to the system are not already in cannonical form, they are made cannonical and the request is rebsubmitted through a redirect. This is so that we will be able to use the same cache entry for locIDs=L101,L102,L203 no matter what order they are originally submitted. Note that the query string ?locIDs=L100&locIDs=L101 does not conform to the API and will not work.	deployed
locale	no	en_US	Java standard locale codes	en_US	Language/locale of common names provided in the response (when translations are available)	implemented, not deployed (as of June 27, 2008)
daysBack	no	0	0, 1, 2, 3, 4, 5, 6, 7	7	How many days backwards to look in computing the summary. Zero means use observations submitted for today. One means use observations for today and yesterday. Etc.	deployed

Result Caching

XML Result Format

No Format

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <header>
        <locale country="US" language="en"/>
        <timestamp>2008-06-27T15:57:58.877-04:00</timestamp>
        <criteria>
            <property id="locID" value="L97555" description="Sapsucker Woods"/>
            <property id="daysBack" value="7"/>
        </criteria>
    </header>
    <result>
        <sighting>
            <species-id>cangoo</species-id>
            <scientific-name>Branta canadensis</scientific-name>
            <common-name>Canada Goose</common-name>
            <how-many>20</how-many>
            <num-checklists>2</num-checklists>
            <obs-dt>2008-06-27</obs-dt>
        </sighting>
        <sighting>
            <species-id>norbob</species-id>
            <scientific-name>Colinus virginianus</scientific-name>
            <common-name>Northern Bobwhite</common-name>
            <how-many>1</how-many>
            <num-checklists>1</num-checklists>
            <obs-dt>2008-06-25</obs-dt>
        </sighting>
    </result>
</response>

Sample output for CLO.

The URL is http://ebird.org/data/ebird/byloc/recent?locIDs=L97555

You can ask for up to three locs using the following format:

http://ebird.org/data/ebird/notable/recent?locIDs=L100,L97555,L101

If you ask for more than three locs the "extras" are silently ignored. The locIDs are made cannonical before the query is run. That is, they are ordered alphabetically, then truncated to at most 3 IDs. If the locIDs given to the system are not already in cannonical form, they are made cannonical and the request is rebsubmitted through a redirect. This is so that we will be able to use the same cache entry for locIDs=L101,L102,L203 no matter what order they are originally submitted.

Note
Note that the query string ?locIDs=L100&locIDs=L101 will NOT work.

Caching is turned on to hold results for 30 minutes.

...

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Parameter Descriptions

Result Caching

XML Result Format