eBird

Supported technology/Online Database

ebird.org

Platform Gundi v2
Type Pull integration
Data Events
Direction Data provider

Setup You, in the portal

eBird sends bird sightings to EarthRanger through Gundi. Gundi checks eBird every hour for your area, and each sighting shows up as an event on the map.

What you'll receive

We add details here as we confirm what eBird sends. If you know something we're missing, let us know.

Positions No
Alerts and events Yes. Each eBird sighting in your area becomes an ebird_observation event, titled after the bird's common name. If a sighting is edited in eBird later, Gundi updates the event. See eBird Event Type.
Sensor readings No. Each event carries the common and scientific names, species code, how many birds were counted, the location name and ID, whether the location is private, whether eBird marked it valid and reviewed, the checklist ID and the eBird credit line.
Photos and files No
Past data Yes. Every check covers the last 2 days of sightings, so late checklists are still picked up. You can set this to 1 to 30 days with Number of Days in the Route settings. Unreviewed sightings are left out unless you turn on Include Unreviewed.

How this integration works

This is a pull integration. Gundi checks the data provider for new data on a schedule, using the account details you enter in the Route, and passes what it finds on to your destination.

Who's involved

  • You create the Route in Gundi and enter your provider account details, or give them to Gundi support when the setup badge says so.
  • The data provider keeps your account and devices active.
  • Your destination, for example EarthRanger, is where the data shows up.
  • Gundi support helps only when the setup badge at the top of this page says so.

Historical data

When you first connect, Gundi fetches a limited amount of past data. How far back it goes depends on the integration and is shown under "Past data" above.

When data doesn't show up

Check your Route Activity Logs first: wrong account details and provider outages show up there. Then check with the provider that your devices are reporting.

How often data arrives

Gundi checks on a schedule. Where we know how often, it's shown under "Data Pull Frequency" on this page. New data arrives after the next check, plus the time the device takes to upload it to the provider.

Prerequisites

Data Source

eBird API Key: Log in to your eBird account and generate an API key from the eBird Keygen page.

Area of Interest: You can define your area of interest in several ways:

  • Geographic location: Specify latitude and longitude coordinates.
  • eBird Hotspot: Use the unique identifier for a specific eBird Hotspot.
  • Region Code: Use the ISO two-letter country code for a broader region.
  • Species Code: Specify a specific bird species (may have limited accuracy).

Data Delivery

EarthRanger

To send data to EarthRanger, you will need:

  • A special EarthRanger user (e.g., “Gundi Service Account”) for this integration. Please refer to EarthRanger's documentation or contact Support.
  • A long-lived token for authentication assigned to the user created in the previous step. Please refer to EarthRanger's documentation or contact Support.
  • Confirm that the required event type and schema are configured in EarthRanger. 
    • Required event type: ebird_observation
    • Schema: Set to automatic schema. EarthRanger will auto-populate the properties of the event template.
  • Update the EarthRanger user (e.g., “Gundi Service Account”) to give it permission to the event type.
 
 

Smart Connect

To send data to SMART:

  • Ensure that the necessary categories and attributes are set up in your SMART CA data model before proceeding.
 
 

Configuration in Gundi

1. Login to Gundi and click Create Route.  
2. Select eBird.  
3. Enter your eBird API Key. Generate your key here.  
4. Set the number of days of data to retrieve.  
5. List eBird species codes to filter the query. If left blank, all species will be included.  

You can find the species code in the URL of the eBird species profile. Example:


6. Select the language for species information.  
7. Choose between:  

  • Fetching data around a specific location (provide latitude, longitude, and search distance in kilometers).  
  • Fetching data within a region (enter the Region Code from this list.

8. Choose whether to include unreviewed observations.  
9. Select your Workspace.  
10. Enter a Route Name (e.g., eBird - Project Name).  
11. Click Next.  
12. Click Add destination on the flow map and select a destination. Refer to our guide for details.

Next Steps

EarthRanger

The following configurations are optional:

1. Select the data you want to see in the map.

1.1. Log in to EarthRanger as an admin.
1.2. Go to Source providers.
1.3. Click on Subject Details Configuration.
1.4. Configure the additional information you would like to see on the map.

2. Rename your Subjects.

3. Assign your Subjects to a Subject Group.

Please refer to EarthRanger's documentation or contact Support.

 
 

Movebank

 
 

Additional Resources

Notes for Support

We suggest consulting the eBird documentation for details on specific functionalities.

Internal Documentation: https://allenai.atlassian.net/wiki/spaces/ER/pages/30496456711/eBird 

 
 

Data Pull Frequency

Approximately every hour.

Other Online Database

iNaturalist
Back to the integration catalog Need help setting this up? Contact us