Page History

{toc}

h2. Description

Get a list of [eBird hotspots|http://ebird.org/content/ebird/about/hotspots],  for a specific region.

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

h2. URL

*Base URL*

[

Description

Get a list of eBird hotspots,  for a specific region.

This is part of the eBird version 1.1 API.

URL

Base URL

http://ebird.org/ws1.1/ref/hotspot/region

...

Examples

Minimal:

]\\

*Examples*

Minimal:

[http://ebird.org/ws1.1/ref/hotspot/region?rtype=subnational1&r=US-NV

...

]

Fully specified:

...

[http://ebird.org/ws1.1/ref/hotspot/region?rtype=subnational1&r=US-NV&fmt=xml

...

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

...

fmt

...

...

csv

...

csv, xml

...

csv

...

format of the response

CSV Result Format

 \\ | 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]\\ |
| fmt \\ | | csv\\ | csv, xml \\ | csv\\ | format of the response \\ |

h2. CSV Result Format

{panel}
<loc ID>,<country code>,<subnational1 code>,<subnational2 code>,<latitude>,<longitude>,"<name>"

<loc ID>,<country code>,<subnational1 code>,<subnational2 code>,<latitude>,<longitude>,<name>

Example

{panel}
*Example*
{panel}
L269709,US,US-NV,US-NV-031,39.5384031,-119.8360348,"Lake Park, Reno"

L124349,US,US-NV,US-NV-031,39.645836,-119.83723,Lemmon Valley Marsh

L124350,US,US-NV,US-NV-031,39.500583,-119.80673,Virginia Lake

L125288,US,US-NV,US-NV-031,39.305553,-119.90611,Ophir

XML Result Format

Example

 Trail
{panel}

h2. XML Result Format

*Example*
{panel}
{noformat}
<response>
    <header>
        <locale country="" language="en"/>
        <timestamp>
            2009-06-24T10:42:47.647-04:00
        </timestamp>
        <criteria>
            <fmt>
                xml
            </fmt>
            <r>
                US-NV
            </r>
            <rtype>
                subnational1
            </rtype>
        </criteria>
    </header>
    <result>
        <location>
            <loc-id>
                L124349
            </loc-id>
            <country-code>
                US
            </country-code>
            <subnational1-code>
                US-NV
            </subnational1-code>
            <lng>
                -119.83723
            </lng>
            <lat>
                39.645836
            </lat>
            <subnational2-code>
                US-NV-031
            </subnational2-code>
            <loc-name>
                Lemmon Valley Marsh
            </loc-name>
        </location>
        <location>
            <loc-id>
                L124350
            </loc-id>
            <country-code>
                US
            </country-code>
            <subnational1-code>
                US-NV
            </subnational1-code>
            <lng>
                -119.80673
            </lng>
            <lat>
                39.500583
            </lat>
            <subnational2-code>
                US-NV-031
            </subnational2-code>
            <loc-name>
                Virginia Lake
            </loc-name>
        </location>
    </result>
</response>
{noformat}
{panel}

{import:eBird-footer}