eBird Web Services - Version 1.1

NOTE: Please migrate to  Version 2.0 of the APIs. These 1.1

...

APIs are no longer available

Endpoints

• ebird.org/ws1.1
  This is the root of version 1.1. of eBird-specific web services.
  • ws1.1/data
    This path contains raw data services.
    • ws1.1/data/obs/notablegeo/recent
      This data service provides notable sightings (rare & unusual) on a state or country basis. Records returned are species oriented. (I.e. not checklists) returns recent nearby observations
    • ws1.1/data/obs/geo_spp/recent
      returns recent nearby observations of a species
    • ws1.1/data/obs/hotspot/list
      This data service provides list of eBird hotspots on a state or country basis.recent
      returns recent observations at hotspots
    • ws1.1
    /product
    This path contains raw data services.
    • /data/obs/hotspot_spp/recent
      returns recent observations of a species at hotspots
    • ws1.1/productdata/obs/bylocloc/recent
      This data service provides a summary of recent sightings for up to three hotspot locIDs.
• ebird.org/wstools1.1
  This is location of gadget code and demo pages.
• ebird.org/wsresource1.1
  This is the root of the static resources that version 1.1 of the web services require.
  • wsresource1.1/images
  • wsresource1.1/css
  • wsresource1.1/js

Supported URL Patterns

• • • returns recent observations at locations
    • ws1.1/data/obs/loc_spp/recent
      returns recent observations of a species at locations
    • ws1.1/data/obs/region/recent
      returns recent observations in a region
    • ws1.1/data/obs/region_spp/recent
      returns recent observations of a species in a region
    • ws1.1/data/notable

...

• • • /geo/recent
      returns recent nearby notable observations

...

• • • ws1.1/data/notable

...

not deployed

...

...

• • • /hotspot/recent
      returns recent notable observations at

...

• • • hotspots

...

not deployed

...

• • • ws1.1/data/notable/

...

• • • loc/recent
      returns recent notable observations

...

• • • at locations
    • ws1.1/data/notable/region

...

not deployed

...

...

• • • /recent
      returns recent

...

• • • notable observations

...

• • • in a

...

• • • region
    • ws1.1/data/

...

not deployed

...

• • • nearest/geo_spp/recent
      returns nearest locations with observations of a species

...

not deployed

...

URL PATTERN: /WHAT-IS-RETURNED/HOW-IS-IT-QUERIED/TIME-FRAME-OF-INTEREST

 what-is-returned

• notable - notable sightings only
• obs -  all sightings
• hotspot - sightings at hotspots only
• nearest - nearest sightings of a species from a given point.

how-is-it-queried

• geo - sightings within a circle defined by a lat/lng and distance.
• hotspot - sightings at hotspots.

Append "_spp" to any of these patterns to change your query to recent observations of a particular species.

time-frame-of-interest

...

• • ws1.1/product
    This path contains products consisting of aggregated raw data.
    • ws1.1/product/obs/hotspot/recent
      This service provides a summary of recent sightings for birding hotspots.
  • ws1.1/ref
    This path contains supporting lookup services for the /data and /product services
    • ws1.1/ref/taxa
      returns species in the ebird taxonomy
    • ws1.1/ref/hotspot/region
      provides a list of eBird hotspots for a given region, optionally filtered to those with recent data
    • ws1.1/ref/hotspot/geo
      provides a list of nearby eBird hotspots, optionally filtered to those with recent data
    • ws1.1/ref/location
      returns location-based look-up data
  • ebird.org/wstools1.1
    This is location of gadget code and demo pages.
  • ebird.org/tools/google
    This is location of original gadget code and demo pages.
    • ebird.org/tools/google/notable-birds.xml
      This is location of gadget code for notable birds by state within the US.
    • ebird.org/tools/google/notable-birds-canada.xml
      This is location of gadget code for notable birds by province/territory within the Canada
  • ebird.org/wsresource1.1
    This is the root of the static resources that version 1.1 of the web services require.
  • wsresource1.1/images
  • wsresource1.1/css
  • wsresource1.1/js

Making Sense of Endpoint URLs

There is a rational behind the URLs we use for endpoints. Find out what they mean.