Versions Compared

Key

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

h2. Description

Returns a list of notable bird species (along with their most recent sighting and location) in a given area.

 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 notable bird species (along with their most recent sighting and location) in a given area.

 This is part of the eBird version 1.1 API.

URL

Base URL

http://ebird.org/ws1.1/data/notable/region/recent

...

Examples

Minimal:

]\\

*Examples*

Minimal:

[http://ebird.org/ws1.1/data/notable/region/recent?rtype=subnational1&r=US-NV

...

]

Fully specified:

...



[http://ebird.org/ws1.1/data/notable/region/recent?rtype=subnational1&r=US-NV&back=5&maxResults=500&locale=en_US&fmt=json

...

Parameter Descriptions

...

Parameter Name

...

Required

...

Default

...

Value Options

...

Example Value

...

Description

...

rtype

...

yes

...

 

]

h2. Parameter Descriptions

|| Parameter Name || Required || Default \\ || Value Options \\ || Example Value \\ || Description ||
| rtype \\ | yes \\ | | 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

...

 

...

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.  currently, only the 'simple' format is supported for this service.  see result field descriptions 

...

locale

...

 

...

en_US

...

Java standard locale codes

...

fr_CA

...

 \\ | 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 \\ | | 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.  currently, only the 'simple' format is supported for this service.  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

...

hotspot

...

 

...

false

...

true,false

...

false

...

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

...

]. \\ |
| fmt \\ | | xml \\ | json, xml \\ | json \\ | format of the response \\ |
| hotspot \\ | | false \\ | true,false \\ | false \\ | set to true if results should be limited to sightings at birding hotspots |
{include:eBird-1.1-FullResultsDescription

...

}

{import:eBird-

...

footer}