Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{toc}

h2. Description

Returns a list of recent sightings of a given species at birding hotspots.

 This is part of the [eBird version 1.1 API|eBird-1.1].

h2. URL

*Base URL*

[
Table of Contents

Description

Returns a list of recent sightings of a given species at birding hotspots.

 This is part of the eBird version 1.1 API.

URL

Base URL

http://ebird.org/ws1.1/data/obs/hotspot/recent

...

Examples

Minimal:

]

*Examples*

Minimal:

[http://ebird.org/ws1.1/data/obs/hotspot/recent?r=L99381

...

]

Fully specified:

...



[http://ebird.org/ws1.1/data/obs/hotspot/recent?r=L99381&r=L104031&back=5&maxResults=500&detail=simple&locale=en_US&fmt=json&includeProvisional=true

...

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

...

detail

...

 

...

simple

...

simple, full

...

simple

...

toggle to restrict results to either all or a subset of sighting fields.  see result field descriptions 

...

locale

...

 

...

en_US

...

Java standard locale codes

...

fr_CA

...

]

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 \\ |
| detail \\ | | simple \\ | simple, full \\ | simple \\ | toggle to restrict results to either all or a subset of sighting fields.  see [result field descriptions|eBird-1.1-FullResultsDescription]  \\ |
| 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

...

]. \\ |
| 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 \\ |
{include:eBird-1.1-FullResultsDescription

...

}

{import:eBird-

...

footer}