Source: https://developers.woosmap.com/api-reference/localities-api/get-localities-nearby/ > For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://developers.woosmap.com/llms.txt # Nearby points of interest # Nearby points of interest GET https://api.woosmap.com/localities/nearby Retrieve worldwide points of interest surrounding a given location. They can be filtered by categories. ### Authorization [`key`](#authorization-woosmap-platform-api-reference-publicapikeyauth) apiKeyquery A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-public-api-key). [`Referer`](#authorization-woosmap-platform-api-reference-refererheader) apiKeyheader The Referer HTTP request header is mandatory when using PublicApiKeyAuth. In browser environment, the Referer is set by the browser itself and cannot be overridden. [`private_key`](#authorization-woosmap-platform-api-reference-privateapikeyauth) apiKeyquery A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key). [`X-Api-Key`](#authorization-woosmap-platform-api-reference-privateapikeyheaderauth) apiKeyheader A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key). ### Query Parameters [`types`](#query-types) stringrequired The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`. # Show 72 enum values Hide 72 enum values `point_of_interest` `transit.station` `transit.station.airport` `transit.station.rail` `beach` `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.attraction` `tourism.attraction.amusement_park` `tourism.attraction.zoo` `tourism.attraction.aquarium` `tourism.monument` `tourism.monument.castle` `tourism.museum` `government` `park` `park.national` `place_of_worship` `police` `post_office` `sports` `sports.golf` `sports.winter` [`location`](#query-location) stringrequired Center of the search circle. Example:`40.71399,-74.00499` [`radius`](#query-radius) integerDefaults to `1000` radius of the search circle, in meter. Example:`3000` [`page`](#query-page) integerDefaults to `1` use `page` to navigate through paginated results. Example:`7` [`limit`](#query-limit) integerDefaults to `10` Defines how many results should be included in a page Example:`15` [`excluded_types`](#query-excluded-types) string The types of points of interest to exclude from results. results will match the specified `types`, if any, but will not match the specified `excluded_types` Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`. # Show 72 enum values Hide 72 enum values `point_of_interest` `transit.station` `transit.station.airport` `transit.station.rail` `beach` `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.attraction` `tourism.attraction.amusement_park` `tourism.attraction.zoo` `tourism.attraction.aquarium` `tourism.monument` `tourism.monument.castle` `tourism.museum` `government` `park` `park.national` `place_of_worship` `police` `post_office` `sports` `sports.golf` `sports.winter` ### Response 200application/json Points of interests surrounding `location` and matching provided `types`, sorted by distance to `location`. [`results`](#resp-200-results) object[] The array of nearby points of interest. #Show 7 propertiesHide 7 properties results.[`types`](#resp-200-results-types) string[] An array containing the types of the result. Example: ```json [ "point_of_interest", "transit.station.rail.train", "train_station" ] ``` results.[`name`](#resp-200-results-name) string The name of the result. results.[`public_id`](#resp-200-results-public-id) string Contains a unique ID for each result. Please use this ID to give feedbacks on results. Example:`NOAeiQADqqisOuN3NM7oXlhkROI=` results.[`geometry`](#resp-200-results-geometry) object The location of the result, in latitude and longitude, eventually associated with a Viewport. Example: ```json { "location": { "lat": 51.4998415, "lng": -0.1246375 } } ``` Show 2 propertiesHide 2 properties results.geometry.[`location`](#resp-200-results-geometry-location) object An object describing a specific location with Latitude and Longitude in decimal degrees. Example: ```json { "lat": 43.3, "lng": 3.46 } ``` Show 2 propertiesHide 2 properties results.geometry.location.[`lat`](#resp-200-results-geometry-location-lat) numberrequired Latitude in decimal degrees Example:`42.3` results.geometry.location.[`lng`](#resp-200-results-geometry-location-lng) numberrequired Longitude in decimal degrees Example:`3.46` results.geometry.[`viewport`](#resp-200-results-geometry-viewport) object A rectangle in geographical coordinates from points at the southwest and northeast corners. Example: ```json { "northeast": { "lat": 49.315678, "lng": 4.15292 }, "southwest": { "lat": 49.31073, "lng": 4.145162 } } ``` Show 2 propertiesHide 2 properties results.geometry.viewport.[`northeast`](#resp-200-results-geometry-viewport-northeast) object An object describing a specific location with Latitude and Longitude in decimal degrees. Example: ```json { "lat": 43.3, "lng": 3.46 } ``` Show 2 propertiesHide 2 properties results.geometry.viewport.northeast.[`lat`](#resp-200-results-geometry-viewport-northeast-lat) numberrequired Latitude in decimal degrees Example:`42.3` results.geometry.viewport.northeast.[`lng`](#resp-200-results-geometry-viewport-northeast-lng) numberrequired Longitude in decimal degrees Example:`3.46` results.geometry.viewport.[`southwest`](#resp-200-results-geometry-viewport-southwest) object An object describing a specific location with Latitude and Longitude in decimal degrees. Example: ```json { "lat": 43.3, "lng": 3.46 } ``` Show 2 propertiesHide 2 properties results.geometry.viewport.southwest.[`lat`](#resp-200-results-geometry-viewport-southwest-lat) numberrequired Latitude in decimal degrees Example:`42.3` results.geometry.viewport.southwest.[`lng`](#resp-200-results-geometry-viewport-southwest-lng) numberrequired Longitude in decimal degrees Example:`3.46` results.[`address_components`](#resp-200-results-address-components) object[] An array containing Address Components with additional information Example: ```json [ { "types": [ "country" ], "long_name": "United Kingdom", "short_name": "GBR" }, { "long_name": "London", "short_name": "London", "types": [ "locality" ] } ] ``` Show 3 propertiesHide 3 properties results.address\_components.[`long_name`](#resp-200-results-address-components-long-name) string | array The full text description or name of the address component, or a list of names (ie. list of postal codes). Example:`United Kingdom` results.address\_components.[`short_name`](#resp-200-results-address-components-short-name) string | array An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation. Example:`UK` results.address\_components.[`types`](#resp-200-results-address-components-types) string[] An array indicating the type of the address component. Example: ```json [ "country", "administrative_area_level_0" ] ``` results.[`categories`](#resp-200-results-categories) string[]deprecated An array containing the categories of the result. This information is now available in the `types` field and will be removed. results.[`formatted_address`](#resp-200-results-formatted-address) string Contains the readable text description of the result. Example:`London, England, United Kingdom` [`pagination`](#resp-200-pagination) object Helps to navigate through paginated results. #Show 2 propertiesHide 2 properties pagination.[`next_page`](#resp-200-pagination-next-page) integer | null If more results are available, this will contain the value to pass to the `page` parameter to get the next page pagination.[`previous_page`](#resp-200-pagination-previous-page) integer | null If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page ### Errors #401 Unauthorized. Incorrect authentication credentials. `application/json` [`detail`](#err-401-detail) string Details for the credentials error Example:`Incorrect authentication credentials. Please check or use a valid API Key` #403 Forbidden. This Woosmap API is not enabled for this project. `application/json` [`detail`](#err-403-detail) string Details for the forbidden error message Example:`This Woosmap API is not enabled for this project.` #429 Too Many Requests. The rate limit for this endpoint has been exceeded. `application/json` [`detail`](#err-429-detail) string Details for the Over Query Limit error message Example:`The rate limit for this endpoint has been exceeded` ```shell 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' ``` ```javascript 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)); ``` ```python 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) ``` ```json { "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 } } ``` ```json { "detail": "Incorrect authentication credentials. Please check or use a valid API Key" } ``` ```json { "detail": "This Woosmap API is not enabled for this project." } ``` ```json { "detail": "The rate limit for this endpoint has been exceeded" } ```