eBird Hot Spot List Web Service API
API
This functionality is contained in the IS/DataDelivery code base.
URL |
description |
status |
notes |
---|---|---|---|
ws/data/hotspot/list?countryCode=<2-letter ISO country code> |
Return list of hotspots found in the given country |
coded and deployed |
|
ws/data/hotspot/list?subnational1Code=<subnational1 code> |
Return list of hotspots names found in the given "state" |
coded and deployed |
|
parameter |
required |
default |
value options |
description |
status |
---|---|---|---|---|---|
countryCode |
one of countryCode and subnational1Code is required |
n/a |
|
coded and deployed |
|
subnational1Code |
one of countryCode and subnational1Code is required |
n/a |
|
coded and deployed |
|
format |
no |
csv |
|
format to use for response; this parameter is case sensitive |
coded and deployed |
Test URLS
Development URL |
Deployed URL |
Expected Response |
Notes |
||
---|---|---|---|---|---|
|
empty list in CSV format |
|
|||
|
list in CSV format |
Country code in uppercase is valid. |
|||
|
empty list in CSV format |
Country code in lowercase is invalid. |
|||
http://localhost/ws1.0/data/hotspot/list?countryCode=US&format=xml |
|
list in XML format |
|
||
http://localhost/ws1.0/data/hotspot/list?countryCode=US&format=csv |
|
list in CSV format |
|
||
http://localhost/ws1.0/data/hotspot/list?countryCode=US&format=XML |
|
list in CSV format |
"XML" is not a valid format option. Only "xml" and "csv" are valid options. An invalid option will default to "csv" format. |
||
http://localhost/ws1.0/data/hotspot/list?countryCode=US&format=qqq |
|
list in CSV format |
Bad format value is ignored and defaults to "csv". |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="74e21fe4-e9fb-4986-b73e-5c5ca95b78e3"><ac:plain-text-body><![CDATA[ |
[][http://localhost/ws1.0/data/hotspot/list?subnational1Code=] |
|
empty list in CSV format |
|
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="135afcec-d8c2-41f0-80cf-7f7730e8a49b"><ac:plain-text-body><![CDATA[ |
[][http://localhost/ws1.0/data/hotspot/list?subnational1Code=US-FL] |
|
list in CSV format |
Subnational1 code in uppercase is valid. |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d68712fc-7f32-423a-b0a6-587b0f238698"><ac:plain-text-body><![CDATA[ |
[][http://localhost/ws1.0/data/hotspot/list?subnational1Code=us-fl] |
|
empty list in CSV format |
Subnational1 code in lowercase is invalid. |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0fcd897a-c888-4c0b-95ad-f5be4bf3f2fa"><ac:plain-text-body><![CDATA[ |
[][][http://localhost/ws1.0/data/hotspot/list?subnational1Code=US-FL&format=xml] |
|
list in XML format |
|
]]></ac:plain-text-body></ac:structured-macro> |
CSV Result Format
<loc ID>, <country code>, <subnational1 code>, <latitude>, <longitude>, "<name>"
<loc ID>, <country code>, <subnational1 code>, <latitude>, <longitude>, "<name>"
<loc ID>, <country code>, <subnational1 code>, <latitude>, <longitude>, "<name>"
<loc ID>, <country code>, <subnational1 code>, <latitude>, <longitude>, "<name>"
Example
L453718, US, US-RI, 41.3302, -71.8375, "Avondale Farm"
L231740, US, US-RI, 41.4496915, -71.3987547, "Beavertail State Park"
L466297, US, US-RI, 41.3202, -71.8303, "Big Maschaug Pond, Watch Hill"
L490189, US, US-RI, 41.3623801, -71.4880371, "Camp Cronin"
L487743, US, US-RI, 41.8591418, -71.3376617, "Central Pond Reservoir"
L466303, US, US-RI, 41.3571, -71.6374, "Charlestown Breachway"
L166174, US, US-RI, 41.49133, -71.292656, "Easton Pond"
L487669, US, US-RI, 41.7074586, -71.6359663, "Flat River Reservoir"
L357306, US, US-RI, 41.9668934, -71.5573883, "Fort Refuge"
L384479, US, US-RI, 41.4743419, -71.3398933, "Ft. Adams State Park"
XML Result Format
Example
<?xml version="1.0" encoding="UTF-8"?> <response> <header> <locale country="US" language="en"/> <timestamp>2008-07-25T10:54:16.432-04:00</timestamp> <criteria> <property id="subnational11Code" value="US-RI" description="Rhode Island"/> </criteria> <comment/> </header> <result> <hotspot> <loc-id>L453718</loc-id> <location>Avondale Farm</location> <longitude>-71.8375</longitude> <latitude>41.3302</latitude> <subnational1-code>US-RI</subnational1-code> <country-code>US</country-code> </hotspot> <hotspot> <loc-id>L231740</loc-id> <location>Beavertail State Park</location> <longitude>-71.3987547</longitude> <latitude>41.4496915</latitude> <subnational1-code>US-RI</subnational1-code> <country-code>US</country-code> </hotspot> </result> </response>