{toc}
h2. Description
This service provides a summary of recent eBird and eTT observations for eBird hotspots. It is basically equivalent to [eBird-1.1-RecentObservationsAtHotspots] except for an additional result field that reveals the number of checklists reporting the species. This is part of the [eBird version 1.1 API|eBird- API 1.1].
h2. Google Gadgets
There are Google Gadgets with eBird Trail Tacker and eBird branding which can be used to consume the data provided by this API. [Information about using those gadgets|eBird-1.0-RecentByLoc-Gadgets].
h2. URL
*Base URL*
[http://ebird.org/ws1.1/product/obs/hotspot/recent]
*Examples*
Minimal:
[http://ebird.org/ws1.1/product/obs/hotspot/recent?r=L99381]
Fully specified:
[http://ebird.org/ws1.1/product/obs/hotspot/recent?r=L99381&r=L104031&back=5&maxResults=500&detail=simple&locale=en_US&fmt=xml&includeProvisional=true]
h2. Parameter Descriptions
|| Parameter Name || Required || Default \\ || Value Options \\ || Example Value \\ || Description ||
| back \\ | | 14 \\ | 1 - 30 integer | 7 | the number of days back to look for observations \\ |
| maxResults | | \\ | 1 - 10000 integer \\ | 10 \\ | the maximum number of result rows to return in this request; to get all results do not include this parameter \\ |
| locale \\ | | en_US | Java standard locale codes | fr_CA \\ | Language/locale of response (when translations are available). See [http://java.sun.com/javase/6/docs/api/java/util/Locale.html]. \\ |
| fmt \\ | | xml\\ | json, xml \\ | json \\ | format of the response \\ |
| r | yes | | any hotspot locID | L99381 \\ | Code(s) for region of interest; here, regions are the locIDs of hotspots. LocIDs that are not valid or are not hotspots are ignored. Maximum of 10 locIDs. |
| includeProvisional \\ | | false \\ | true,false \\ | false \\ | set to true if you'd like flagged records that have not yet been reviewed to be included in the results\\ |
h2. Result Field Descriptions
|| *Field* (JSON) \\ || Field (XML) \\ || *Description* \\ ||
| comName \\ | com-name \\ | species common name. not included in the 'simple' detail if a scientific name was specified as an input parameter \\ |
| sciName \\ | sci-name \\ | species scientific name. not included in the 'simple' detail if a scientific name was specified as an input parameter |
| obsDt | obs-dt \\ | observation date formatted according to [ISO 8601|http://en.wikipedia.org/wiki/ISO_8601] (e.g. 'YYYY-MM-DD', or 'YYYY-MM-DD hh:mm'). Hours and minutes are excluded if the observer did not report an observation time. \\ |
| howMany | how-many \\ | The number observed. Not included if only presence was noted \\ |
| locID | loc-id \\ | unique identifier for the location \\ |
| locName | loc-name \\ | location name \\ |
| lat | lat \\ | latitude of the location \\ |
| lng | lng \\ | longitude of the location |
| numChecklists | num-checklists | the number of checklists reporting the species |
| obsReviewed | obs-reviewed \\ | 'true' if obs has been reviewed. 'false' otherwise \\ |
| obsValid | obs-valid \\ | 'true' if obs has been deemed valid by a regional reviewer. 'false' otherwise \\ |
h4. XML Example Result
{noformat}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<header>
<locale country="US" language="en"/>
<timestamp>
2009-07-01T10:29:53.035-04:00
</timestamp>
<criteria>
<command>
<fmt>
xml
</fmt>
<include-provisional>
true
</include-provisional>
<r>
L99381
</r>
<back>
30
</back>
<max-results>
500
</max-results>
<detail>
simple
</detail>
</command>
</criteria>
</header>
<result>
<sighting>
<loc-id>
L99381
</loc-id>
<obs-dt>
2009-06-24 17:00
</obs-dt>
<obs-reviewed>
false
</obs-reviewed>
<obs-valid>
true
</obs-valid>
<num-checklists>
4
</num-checklists>
<loc-name>
Stewart Park
</loc-name>
<how-many>
1
</how-many>
<lat>
42.4613266
</lat>
<lng>
-76.5059255
</lng>
<com-name>
Barn Swallow
</com-name>
<sci-name>
Hirundo rustica
</sci-name>
</sighting>
</result>
</response>
{noformat}
h4. JSON Example Result
{noformat}
[{
"locID": "L99381",
"lat": 42.4613266,
"howMany": 1,
"locName": "Stewart Park",
"obsValid": true,
"lng": -76.5059255,
"sciName": "Hirundo rustica",
"numChecklists": 4,
"obsReviewed": false,
"obsDt": "2009-06-24 17:00",
"comName": "Barn Swallow"
}]
{noformat}
{import:eBird-footer}
| 
