Table of Contents |
---|
Description
Get a list of eBird hotspots, for a specific region.
This is part of the eBird version 1.1 API.
URL
Base URL
...
http://ebird.org/ws1.1/ref/hotspot/region
...
Examples
Minimal:
http://ebird.org/ws1.1/ref/hotspot/region?rtype=subnational1&r=US-NV
...
Fully
...
specified:
...
http://ebird.org/ws1.1/ref/hotspot/region?rtype=subnational1&r=US-NV&fmt=xml
...
http://ebird.org/ws1.1/ref/hotspot/region?rtype=subnational1&r=US-NV&back=7&fmt=xml
...
Parameter Descriptions
Parameter Name | Required | Default | Value Options | Example Value | Description |
---|---|---|---|---|---|
rtype | auto-determined from 'r' parameter | country,subnational1,subnational2 | subnational1 | the region type you are interested in. | |
r | yes |
|
| region code corresponding to selected region type. see region code reference | |
back |
| 1 - 30 integer | 7 | the number of days back to look for sightings; all 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
No Format |
---|
\\ | subnational1 \\ | the region type you are interested in.|
| r \\ | yes \\ | | \\ | | region code corresponding to selected region type. see [region code reference|eBird-1.1-RegionCodeReference]\\ |
| back \\ | | \\ | 1 - 30 integer | 7 | the number of days back to look for sightings; all hotspots are returned if this parameter is not present \\ |
| fmt \\ | | csv\\ | csv, xml \\ | csv\\ | format of the response \\ |
h2. 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|
h3. Example Responses
h4. CSV
{noformat}
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
No Format |
---|
{noformat} h4. XML {noformat} <response> <header> <locale country="" language="en"/> <timestamp> 2009-06-24T10:42:47.647-04:00 </timestamp> <criteria> <fmt> xml </fmt> <r> US-NV </r> <rtype> subnational1 </rtype> </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> {noformat} h2. Caching Information For details on caching of results by our servers, see [ |
Caching Information
For details on caching of results by our servers, see eBird-1.1-CacheInformation
Wiki Markup |
---|
]
{import:eBird-footer} |