Nearby

GET
https://api.woosmap.com/localities/nearby

Returns worldwide points of interest around a location, sorted by distance. Filter with types and excluded_types.

Ratelimit: 50/1s

Authorization

key
apiKey query

Public key of the project usually starts with woos-

private_key
apiKey query

Private key with or without write permission.

X-Api-Key
apiKey header

Private key with or without write permission.

Header Parameters

Query Parameters

cc_format
CountryCodeFormat

Format of the country code returned in address_components. When unset, mirrors the format used in components, or alpha2 if components is not provided.

Available options: alpha2, alpha3
Example: alpha3
location
string required

Center of the search circle.

Example: 40.71399,-74.00499
radius
integer Defaults to 1000

Radius of the search circle, in meters.

Example: 3000
types
string required

Restricts results to one or more types of points of interest. Use | to provide multiple values.

Show 80 enum values Hide 80 enum values
point_of_interest
beach
government
park
park.national
place_of_worship
police
post_office
sports
sports.golf
sports.winter
transit
transit.station
transit.station.airport
transit.station.rail
transit.station.rail.subway
transit.station.rail.train
transit.station.rail.light_rail
transit.station.rail.monorail
transit.station.rail.funicular
transit.station.rail.tram
business
business.car_repair
business.car_rental
business.cinema
business.conference_centre
business.exhibition_centre
business.theatre
business.nightclub
business.finance
business.finance.bank
business.fuel
business.parking
business.mall
business.food_and_drinks
business.food_and_drinks.bar
business.food_and_drinks.biergarten
business.food_and_drinks.cafe
business.food_and_drinks.fast_food
business.food_and_drinks.pub
business.food_and_drinks.restaurant
business.food_and_drinks.food_court
business.shop
business.shop.mall
business.shop.bakery
business.shop.butcher
business.shop.library
business.shop.grocery
business.shop.sports
business.shop.toys
business.shop.clothes
business.shop.furniture
business.shop.electronics
business.shop.doityourself
business.shop.craft
education
education.school
education.kindergarten
education.university
education.college
education.library
hospitality
hospitality.hotel
hospitality.hostel
hospitality.guest_house
hospitality.bed_and_breakfast
hospitality.motel
medical
medical.hospital
medical.pharmacy
medical.clinic
tourism
tourism.art_gallery
tourism.attraction
tourism.attraction.amusement_park
tourism.attraction.zoo
tourism.attraction.aquarium
tourism.monument
tourism.monument.castle
tourism.museum
Example: point_of_interest
excluded_types
LocalitiesTypesPoi

Restricts results by excluding one or more types of points of interest. Use | to provide multiple values.

Show 80 enum values Hide 80 enum values
point_of_interest
beach
government
park
park.national
place_of_worship
police
post_office
sports
sports.golf
sports.winter
transit
transit.station
transit.station.airport
transit.station.rail
transit.station.rail.subway
transit.station.rail.train
transit.station.rail.light_rail
transit.station.rail.monorail
transit.station.rail.funicular
transit.station.rail.tram
business
business.car_repair
business.car_rental
business.cinema
business.conference_centre
business.exhibition_centre
business.theatre
business.nightclub
business.finance
business.finance.bank
business.fuel
business.parking
business.mall
business.food_and_drinks
business.food_and_drinks.bar
business.food_and_drinks.biergarten
business.food_and_drinks.cafe
business.food_and_drinks.fast_food
business.food_and_drinks.pub
business.food_and_drinks.restaurant
business.food_and_drinks.food_court
business.shop
business.shop.mall
business.shop.bakery
business.shop.butcher
business.shop.library
business.shop.grocery
business.shop.sports
business.shop.toys
business.shop.clothes
business.shop.furniture
business.shop.electronics
business.shop.doityourself
business.shop.craft
education
education.school
education.kindergarten
education.university
education.college
education.library
hospitality
hospitality.hotel
hospitality.hostel
hospitality.guest_house
hospitality.bed_and_breakfast
hospitality.motel
medical
medical.hospital
medical.pharmacy
medical.clinic
tourism
tourism.art_gallery
tourism.attraction
tourism.attraction.amusement_park
tourism.attraction.zoo
tourism.attraction.aquarium
tourism.monument
tourism.monument.castle
tourism.museum
Example: business.food_and_drinks.fast_food|business.food_and_drinks.pub
page
integer Defaults to 1

Selects which page of paginated results to return.

Example: 7
limit
integer Defaults to 10

Defines how many results should be included in a page.

Example: 15

Response

200 application/json

Successful Response

results
object[] required

The array of nearby points of interest.

Show 7 propertiesHide 7 properties
results. public_id
string required

Unique identifier for this place.

results. types
string[] required

An array containing the types of the result.

results. categories
string[] required deprecated

An array containing the categories of the result. This information is now available in the types field and will be removed.

results. name
string required

The name of the result.

results. formatted_address
string | null

Contains the readable text description of the result.

results. geometry
object | null

The location of the result, in latitude and longitude, eventually associated with a Viewport.

Show 3 propertiesHide 3 properties
results.geometry. location
object | null
Show 2 propertiesHide 2 properties
results.geometry.location. lat
number required
results.geometry.location. lng
number required
results.geometry. viewport
object | null
Show 2 propertiesHide 2 properties
results.geometry.viewport. northeast
object required
Show 2 propertiesHide 2 properties
results.geometry.viewport.northeast. lat
number required
results.geometry.viewport.northeast. lng
number required
results.geometry.viewport. southwest
object required
Show 2 propertiesHide 2 properties
results.geometry.viewport.southwest. lat
number required
results.geometry.viewport.southwest. lng
number required
results.geometry. shape
object | null
Show 2 propertiesHide 2 properties
results.geometry.shape. type
string required
Available options: Polygon, MultiPolygon
results.geometry.shape. coordinates
array required
results. address_components
object[] | null
Show 3 propertiesHide 3 properties
results.address_components. types
string[] required
results.address_components. long_name
string | array required
results.address_components. short_name
string | array required
pagination
object required

Helps to navigate through paginated results.

Show 2 propertiesHide 2 properties
pagination. previous_page
integer | null required

If previous results are available, this will contain the value to pass to the page parameter to get the previous page

pagination. next_page
integer | null required

If more results are available, this will contain the value to pass to the page parameter to get the next page

Errors

401

Unable to locate credentials.

application/json
detail
string required
402

Out of free quota.

application/json
detail
string required
403

Credentials found, but not matching.

application/json
detail
string required
422

Validation Error

application/json
detail
object[]
Show 5 propertiesHide 5 properties
detail. loc
any[] required
detail. msg
string required
detail. type
string required
detail. input
any
detail. ctx
object
429

Rate limit reached

application/json
detail
string required
        curl -L 'https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'

    
        const requestOptions = {
  method: "GET",
  redirect: "follow"
};

fetch("https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

    
        import requests

url = "https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY"

payload = {}
headers = {
    'Referer': 'http://localhost'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)


    
        
{
"results": [
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
"types": [
"point_of_interest",
"business.food_and_drinks.fast_food"
],
"categories": [
"business.food_and_drinks.fast_food"
],
"name": "Pret A Manger",
"formatted_address": "Broadway, New York",
"geometry": {
"location": {
"lat": 40.715905992166256,
"lng": -74.00508673226767
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Broadway",
"short_name": "Broadway"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==",
"types": [
"point_of_interest",
"business.food_and_drinks.fast_food"
],
"categories": [
"business.food_and_drinks.fast_food"
],
"name": "Dunkin'",
"formatted_address": "Broadway, New York",
"geometry": {
"location": {
"lat": 40.71602115951586,
"lng": -74.00494482664695
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Broadway",
"short_name": "Broadway"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
"types": [
"point_of_interest",
"business.food_and_drinks.restaurant"
],
"categories": [
"business.food_and_drinks.restaurant"
],
"name": "Chambers",
"formatted_address": "Chambers Street, New York",
"geometry": {
"location": {
"lat": 40.71461844801976,
"lng": -74.00754036678366
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Chambers Street",
"short_name": "Chambers Street"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
"types": [
"point_of_interest",
"business.shop.grocery"
],
"categories": [
"business.shop.grocery"
],
"name": "City Hall Oasis",
"geometry": {
"location": {
"lat": 40.71283012706819,
"lng": -74.00727837935057
},
"viewport": {
"northeast": {
"lat": 40.71286059528623,
"lng": -74.00724213866874
},
"southwest": {
"lat": 40.71279957503111,
"lng": -74.00731464213119
}
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
"types": [
"point_of_interest",
"business.finance.bank"
],
"categories": [
"business.finance.bank"
],
"name": "Citibank",
"formatted_address": "Broadway, New York",
"geometry": {
"location": {
"lat": 40.7130414767567,
"lng": -74.0074818610995
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Broadway",
"short_name": "Broadway"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
"types": [
"point_of_interest",
"business.food_and_drinks.restaurant"
],
"categories": [
"business.food_and_drinks.restaurant"
],
"name": "Saffron",
"geometry": {
"location": {
"lat": 40.71467049963849,
"lng": -74.00767187884445
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
"types": [
"point_of_interest",
"business.food_and_drinks.restaurant"
],
"categories": [
"business.food_and_drinks.restaurant"
],
"name": "Gran Morsi",
"geometry": {
"location": {
"lat": 40.71432885326513,
"lng": -74.00778746528921
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
"types": [
"point_of_interest",
"business.food_and_drinks.bar"
],
"categories": [
"business.food_and_drinks.bar"
],
"name": "Bon Courage",
"formatted_address": "Reade Street, New York",
"geometry": {
"location": {
"lat": 40.71541472882126,
"lng": -74.00719193106873
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Reade Street",
"short_name": "Reade Street"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==",
"types": [
"point_of_interest",
"business.food_and_drinks.fast_food"
],
"categories": [
"business.food_and_drinks.fast_food"
],
"name": "Burger King",
"formatted_address": "Broadway, New York",
"geometry": {
"location": {
"lat": 40.71619516782573,
"lng": -74.00480635760651
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Broadway",
"short_name": "Broadway"
}
]
},
{
"public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
"types": [
"point_of_interest",
"business.theatre"
],
"categories": [
"business.theatre"
],
"name": "The Flea",
"formatted_address": "Thomas Street, New York",
"geometry": {
"location": {
"lat": 40.71609349534023,
"lng": -74.00589281989586
}
},
"address_components": [
{
"types": [
"country",
"administrative_area_level_0",
"division_level_0"
],
"long_name": "United States",
"short_name": "US"
},
{
"types": [
"locality"
],
"long_name": "New York",
"short_name": "New York"
},
{
"types": [
"route"
],
"long_name": "Thomas Street",
"short_name": "Thomas Street"
}
]
}
],
"pagination": {
"previous_page": 2,
"next_page": 4
}
}
Was this helpful?