Description
This can be used in two different ways:
- get a list of eBird hotspots near the given latitude and longitude. Leave off the "back" parameter in your request to return all hotspots, regardless of whether they have bird observations.
- get a list of eBird hotspots near the given latitude and longitude that have recent sightings. Include the "back" parameter in your request to filter hotspot list based on "recent" observations..
This is part of the eBird version 1.1 API.
URL
Base URL
http://ebird.org/ws1.1/ref/hotspot/geo
Examples
Minimal:
http://ebird.org/ws1.1/ref/hotspot/geo?lat=42.46&lng=-71.25
Fully specified:
http://ebird.org/ws1.1/ref/hotspot/geo?lng=-76.51&lat=42.46&dist=2&back=5&fmt=xml
Parameter Descriptions
Parameter Name |
Required |
Default |
Value Options |
Example Value |
Description |
---|---|---|---|---|---|
lat |
yes |
|
-90.00 - 90.00 decimal |
42.46 |
decimal latitude, two decimal places of precision required |
lng |
yes |
|
-180.00 - 180.00 decimal |
-76.51 |
decimal longitude, two decimal places of precision required |
dist |
|
25 |
0 - 50 integer |
15 |
distance defining area of interest from given lat/lng in kilometers |
back |
|
|
1 - 30 integer |
7 |
the number of days back to look for sightings; all nearby hotspots are returned if this parameter is not present |
fmt |
|
csv |
csv, xml |
csv |
format of the response |
Result Fields
Field (XML) |
Description |
---|---|
loc-id |
unique id for the location |
country-code |
country ISO code |
subnational1-code |
state/province ISO code |
subnational2-code |
county code |
lat |
latitude of the location |
lng |
longitude of the location |
loc-name |
location name |
Example Responses
CSV
L269709,US,US-NV,US-NV-031,39.5384031,-119.8360348,"Lake Park, Reno" L124349,US,US-NV,US-NV-031,39.645836,-119.83723,Lemmon Valley Marsh L124350,US,US-NV,US-NV-031,39.500583,-119.80673,Virginia Lake L125288,US,US-NV,US-NV-031,39.305553,-119.90611,Ophir Trail
XML
<response> <header> <locale country="" language="en"/> <timestamp> 2009-06-24T10:42:47.647-04:00 </timestamp> <criteria> <fmt> xml </fmt> <lat> 42.46 </lat> <lng> -76.51 </lng> </criteria> </header> <result> <location> <loc-id> L124349 </loc-id> <country-code> US </country-code> <subnational1-code> US-NV </subnational1-code> <lng> -119.83723 </lng> <lat> 39.645836 </lat> <subnational2-code> US-NV-031 </subnational2-code> <loc-name> Lemmon Valley Marsh </loc-name> </location> <location> <loc-id> L124350 </loc-id> <country-code> US </country-code> <subnational1-code> US-NV </subnational1-code> <lng> -119.80673 </lng> <lat> 39.500583 </lat> <subnational2-code> US-NV-031 </subnational2-code> <loc-name> Virginia Lake </loc-name> </location> </result> </response>
Caching Information
For details on caching of results by our servers, see eBird-1.1-CacheInformation
1 Comment
Paul Allen
Enhancement Suggestion
We have had a request to include the date/time of the last observation (if any) made at the hotspot as part of the information provided by this interface.