Versions Compared

Key

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

h2. Description

Returns the nearest N locations (specified with the maxResults parameter) with observations of a species.

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

h2. URL

*Base URL*

[
Table of Contents

Description

Returns the nearest N locations (specified with the maxResults parameter) with observations of a species.

 This is part of the eBird version 1.1 API.

URL

Base URL

http://ebird.org/ws1.1/data/nearest/geo_spp/recent

...

Examples

Minimal:

]

*Examples*

Minimal:

[http://ebird.org/ws1.1/data/nearest/geo_spp/recent?lng=-76.51&lat=42.46&sci=branta%20canadensis

...

]

Fully specified:

...



[http://ebird.org/ws1.1/data/nearest/geo_spp/recent?lng=-76.51&lat=42.46&sci=branta%20canadensis&hotspot=true&dist=2&back=5&maxResults=500&locale=en_US&fmt=json&includeProvisional=true

...

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

...

 

...

14

...

1 - 30 integer

...

7

...

the number of days back to look for observations

...

maxResults

...

 

...

1000

...

1 - 1000 integer

...

10

...

the maximum number of result rows to return in this request

...

locale

...

 

...

en_US

...

Java standard locale codes

...

fr_CA

...

]

h2. 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 \\ | | 14 \\ | 1 - 30 integer | 7 | the number of days back to look for observations \\ |
| maxResults | | 1000 | 1 - 1000 integer \\ | 10 \\ | the maximum number of result rows to return in this request \\ |
| 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

...

sci

...

yes

...

 

...

any scientific name

...

larus%20delawarensis

...

]. \\ |
| fmt \\ | | xml\\ | json, xml \\ | json \\ | format of the response \\ |
| sci \\ | yes \\ | | any scientific name \\ | larus%20delawarensis \\ | scientific name of the species of interest  (not case sensitive).  See [eBird-1.1-SpeciesReference] for a complete list of supported scientific

...

 

...

hotspot

...

 

...

false

...

true,false

...

false

...

set to true if results should be limited to sightings at hotspots

...

 

...

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

...

 names | |
| hotspot \\ | | false \\ | true,false \\ | false \\ | set to true if results should be limited to sightings at hotspots \\ | |
| 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-SimpleResultsDescription

...

}

{import:eBird-

...

footer}