tomtom-poi-search
Search for Points of Interest (POIs) like restaurants, gas stations, or hotels with location context, language, and country filters using TomTom's location services. Configure results by radius, categories, brands, and more for precise local insights.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
addressRanges | No | Include address ranges in the response | |
brandSet | No | Filter by brand names. Examples: 'Starbucks,Peet\'s', 'Marriott,Hilton'. Use quotes for brands with commas. | |
btmRight | No | Bottom-right coordinates of bounding box (format: 'lat,lon'). Must be used with topLeft | |
categorySet | No | Filter by POI categories. Common IDs: '7315' (restaurants), '7309' (gas), '7311' (hotels), '9663' (EV charging). | |
chargingAvailability | No | Include charging availability information for EV stations | |
connectorSet | No | EV connector types: 'IEC62196Type2CableAttached', 'Chademo', 'TeslaConnector' | |
countrySet | No | Limit results to specific countries using ISO codes. Examples: 'US', 'FR,GB', 'CA,US' | |
entityTypeSet | No | Filter results by entity types | |
ext | No | Extended parameters for the search | |
extendedPostalCodesFor | No | Include extended postal codes for specific index types. Examples: 'PAD', 'PAD,Addr', 'POI' | |
fuelAvailability | No | Include fuel availability information for gas stations | |
fuelSet | No | Fuel types: 'Petrol', 'Diesel', 'LPG', 'Hydrogen', 'E85' | |
geometries | No | Include geometries information in the response | |
language | No | Preferred language for results using IETF language tags. Examples: 'en-US', 'fr-FR', 'de-DE', 'es-ES' | |
lat | No | Latitude for location context. STRONGLY recommended for relevant local results. | |
limit | No | Maximum number of results to return (1-100). Default: 5 | |
lon | No | Longitude for location context. Must be used with lat parameter. | |
mapcodes | No | Include mapcode information in the response. Mapcodes represent specific locations within a few meters and are designed to be short, easy to recognize and communicate. Options: Local, International, Alternative. Examples: 'Local' (local mapcode only), 'Local,Alternative' (multiple types). Accepts array of string(s). | |
maxFuzzyLevel | No | Maximum fuzzy matching level (1-4) | |
maxPowerKW | No | Maximum charging power in kW for EV stations | |
minFuzzyLevel | No | Minimum fuzzy matching level (1-4) | |
minPowerKW | No | Minimum charging power in kW for EV stations | |
ofs | No | Offset for pagination of results | |
openingHours | No | List of opening hours for a POI (Points of Interest).Value: `nextSevenDays` Mode shows the opening hours for next week, starting with the current day in the local time of the POI. Usage example: openingHours=nextSevenDays | |
parkingAvailability | No | Include parking availability information | |
query | Yes | Specific POI category search. Best for finding types of businesses: 'restaurants', 'gas stations', 'hotels', 'parking', 'ATMs', 'hospitals' | |
radius | No | Search radius in meters. Essential for focused local results. Examples: 1000 (walking), 5000 (driving), 20000 (wide area). | |
relatedPois | No | Include related points of interest | |
roadUse | No | Include road usage information | |
sort | No | Sort options for results | |
timeZone | No | Used to indicate the mode in which the timeZone object should be returned. Values: iana Mode shows the IANA ID which allows the user to determine the current time zone for the POI. Usage examples: timeZone=iana | |
topLeft | No | Top-left coordinates of bounding box (format: 'lat,lon'). Must be used with btmRight | |
typeahead | No | Autocomplete mode for partial queries. Use for search interfaces. | |
vehicleTypeSet | No | A comma-separated list of vehicle types that could be used to restrict the result to the Points Of Interest of specific vehicles. If vehicleTypeSet is specified, the query can remain empty. Only POIs with a proper vehicle type will be returned. Value: A comma-separated list of vehicle type identifiers (in any order). When multiple vehicles types are provided, only POIs that belong to (at least) one of the vehicle types from the provided list will be returned. Available vehicle types: Car , Truck | |
view | No | Geopolitical view for disputed territories. Options: 'Unified', 'AR', 'IL', 'IN', 'MA', 'PK', 'RU', 'TR', 'CN' |