Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Recent eBird Sightings Summary By Location - Version 1.0

Panel
Table of Contents

Summary

This API provides a summary of eBird and eTT observations for an eBird hotspot, over the past few days.

Google Gadgets

There are Google Gadgets with eBird Trail Tacker and eBird branding which can be used to consume the data provided by this API. Information about using those gadgets.

Suggestions for Improvement

  • For both gadgets:
    • Ability to sort by Most Recently Observed (followed by taxonomic order)
    • Ability to sort by High Count (followed by taxonomic order)
  • For eBird gadget:
    • Show first and last name of reporting observer
  • For eTT gadget:
    • link to AAB species on species names
    • link to map showing location of sighting (using eTT map)
    • identify rarities and specialties

...

API

What wildcards be used in the match string?

URL

description

status

notes

ws/ref/country/list

Return entire list of country names and codes

not coded

 

ws/ref/country/find?match=<string to match>

Return list of country names and their codes that match

not coded

http://ebird.org/ws1.0/product/byloc/recent

Return summary of recent sightings for most active hotspot over the past 24 hours

deployed

 

http://ebird.org/ws1.0/product/byloc/recent?locID=L97555&locID=L259855&daysBack=7

Return summary of recent sightings at the given locID(s)

deployed

 

Parameter Descriptions

parameter

required

default

value options

example value

description

status

locID

no

match

yes, for /find

n/a

 

String to match against "country" names. What kind of wildcards can be used?

locID of hotspot locations

L97555

The data summary is computed using data submitted to the given locIDs (up to three). The eBird-1.0-HotSpot web service lists valid hot spot locIDs.

deployed not coded

locale

no

en_US

Java standard locale codes

locale in which to perform matching, and in which to provide names in response (when possible)

not coded

format

no

csv

  • csv
  • xml

format to use for response

not coded

noCSV Result Format
Panel

<country code>, <name associated with country code>
<country code>, <name associated with country code>
<country code>, <name associated with country code>

XML Result Format

en_US

Language/locale of common names provided in the response (when translations are available)

deployed

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

Results are cached on the server for 30 minutes, so repeated calls to the same URL will usually result in exacted the same response. The time that the response was actually computed is provided in the header time stamp.

XML Result Format

No Format

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <header>
        
No Format

<response>
  <header>
    <locale country="US" language="en"/>
        <timestamp>2008-0206-21T1227T15:3757:3258.546877-0504:00</timestamp>
        <criteria>
            <property nameid="matchlocID" value="L97555" description="somethingSapsucker Woods"/>
         </criteria>   <property id="daysBack" value="7"/>
    <comment>
    </comment>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>
        <location countryCode="" >name of the country </location>
    <location countryCode="" >name of the country </location>
    <location countryCode="" >name of the country </location>
</response>
    <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>

Potential Improvements

  • Support more time frames (week, month).
  • Support multiple points (via point in polygon computation).
Wiki Markup
{import:eBird-footer}