Search API suggests matching places based on free-form or incomplete queries with additional geographic and POI category filters
Locate POIs and addresses based on a text match and geographical filter:
| Authorization required | string User API token |
Locate parameters
| text | string Free text input | ||||||
| at | Array of numbers <float> = 2 items [ items <float > ] Reference coordinate as lon, lat array | ||||||
Polygon Area (object) or Circle Area (object) or Bounding Box Area (object) (in) | |||||||
One of
| |||||||
Along with Polyline (object) or Along with Coordinates (object) (along) | |||||||
One of
| |||||||
| categories | Array of strings Items Enum: "gas_stations" "parking" "food&drink" "accommodation" "medical_services" "shopping" "car_services" "public_transport" "wiki" "education" "entertainment" "public_services" "geographic_area" "business" "sightseeing" "religious_places" "roadside" "sports" "uncategorized" "hydrants" "emergency_services_support" "civil_emergency_infrastructure" "charging_stations" "bike_charging_stations" "bike_parking" "advertising" "agriculture" "air_raid_siren" "airport" "alpine_hut" "ambulance_station" "amusement_park" "animal_park" "animal_waste_bags_dispenser" "archaeological_site" "atm" "attorney" "auto_dealership_-_used_cars" "auto_parts" "auto_service" "automobile_club" "automobile_dealership" "bakery" "bank" "banquet_hall" "bar" "bicycle_charging_station" "bicycle_parking" "bicycle_rental" "bicycle_service" "bicycle_shop" "bicycle_traffic_light" "bicycle_tube_vending_machine" "block" "boats" "bollard" "booking.com_hotel" "bookstore" "border_crossing" "bowling_centre" "bus_station" "bus_trap" "business_facility" "business_services" "butcher" "camping" "car_sharing" "car_wash" "casino" "cave" "cemetery" "chain" "chalet" "charging_station" "cheque_cashing_service" "child_care_centre" "church" "cigarettes_vending_machine" "cinema" "city_hall" "civic_centre" "civil_defense_siren" "clothing_store" "cocktail_lounge" "coffee_shop" "coffee_vending_machine" "communication" "commuter_train_station" "computers_and_software" "convenience_store" "convention_centre" "county_council" "court_house" "currency_exchange" "defibrillator" "dentist" "department_store" "discount_store" "do_it_yourself" "drinking_water" "drinks_vending_machine" "dry_cleaning_and_laundry" "electronics_store" "embassy" "emergency_access_point" "emergency_assembly_point" "emergency_assembly_point_-_earthquake" "emergency_assembly_point_-_fire" "emergency_assembly_point_-_flood" "emergency_assembly_point_-_landslide" "emergency_assembly_point_-_tornado" "emergency_assembly_point_-_tsunami" "emergency_landing_site" "emergency_phone" "emergency_service" "emergency_ward_entrance" "emergency_ward_entrance_-_rescue_service" "emergency_ward_entrance_-_walk_in" "entertainment_electronics" "fast_food" "ferry_terminal" "fire_hydrant" "fire_siren" "fire_station" "first_aid_kit" "floor_coverings_and_carpets" "flowers" "food_vending_machine" "forest" "funeral_director" "furniture" "garden_centre" "gate" "gift_shop" "give_way_sign" "glass_and_windows" "golf_course" "golf_practice_range" "government_office" "grocery" "hairdresser" "hamlet" "hardware_store" "health_care_service" "health_club" "helipad" "higher_education" "highway_exit" "historical_monument" "home_improvement" "home_improvement_centre" "home_specialty_store" "hospital" "hotel" "ice_skating" "industrial" "island" "jewellery" "library" "lift_gate" "lighthouse" "loading_dock" "local_transit" "lottery_shop" "major_appliance" "marina" "medical_service" "men's_apparel" "military_base" "money_transferring_service" "mosque" "motorcycle_dealership" "mover" "museum" "music" "named_place" "national_park" "neighborhood" "newspaper_vending_machine" "night_club" "nightlife" "office_supply_store" "optician" "other_general_merchandise" "paint_shop" "parcel_locker" "park_and_ride" "parking_garage" "parking_lot" "parking_meter" "peak" "pedestrian_crossing" "pedestrian_traffic_light" "performing_arts" "petrol_station" "pharmacy" "photography" "physician" "pillar_hydrant" "pipe_hydrant" "place_of_worship" "playground" "police_service" "police_station" "pond_hydrant" "post_office" "power_tower" "public_sport_airport" "public_toilets" "public_transit_stop" "public_transit_tickets_kiosk" "race_track" "real_estate_agency" "recreation" "recreation_area" "recycling" "rental_car_agency" "repair_service" "residential_area" "rest_area" "restaurant" "retirement_home" "road_assistance" "rope" "route_66" "rv_park" "school" "science_and_research_institute" "shelter" "shoe_store" "siren" "ski_lift" "ski_resort" "slipway" "social_service" "specialty_clothing_store" "specialty_food_store" "specialty_store" "sporting_and_instructional_camp" "sporting_goods_store" "sports_activities" "sports_centre" "sports_complex" "stop_sign" "storage" "subway_entrance" "subway_station" "sump_buster" "swimming_pool" "synagogue" "tailor_shop" "tax_services" "taxi_stand" "tea_house" "telecom" "temple" "timber" "toll_station" "tornado_siren" "tourist_attraction" "tourist_information" "traffic_calming" "traffic_light" "train_station" "tram_station" "transportation_service" "travel_agent" "tree" "truck_parking" "truck_stop" "tsunami_siren" "underground_hydrant" "utilities" "variety_store" "vending_machine" "veterinarian" "video_rental" "viewpoint" "wall_hydrant" "waste_and_sanitary" "water" "water_tank_hydrant" "water_tower" "weigh_station" "wikipedia" "windmill" "wine_and_spirits" "winery" "women's_apparel" POI categories where the search should be performed | ||||||
| target | Array of strings Items Enum: "pois" "addresses" "cities" Search operation targets:
| ||||||
| limit | integer Default: 15 Results count limit | ||||||
| exact | boolean Default: false Exact match on text tokens | ||||||
| locale | string Default: "en" ISO 639-2 / ISO 639-3 language code for the result | ||||||
| fuzzy | boolean Default: true Enable text token autocorrection if they don't generate results | ||||||
| debug | boolean Default: false If true the result is beautified for easy human read | ||||||
object | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
Array of objects | |||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||
{- "text": "aral",
- "categories": [
- "gas_stations"
], - "along": {
- "polyline": "uvxmHe{yp@UmBcAuIUsCGk@IaAK}@YwDKkAMoAUwDG{AGgBGeD@m@Ba@n@}FH}@Bs@@y@@{@KmDGmBMyBI}@??GeAO}AKgAEm@UkEAKaDXs@Fe@DkAB??w@A{@IkAW_B]o@QaFqAyBo@mCoAmA_As@u@qA_B_BgCmCeEcA_BwIeNkAiBS_@kDqFsBcDkCcE}BcDoBsCcCmDgCsDw@iAS[gBcC_@c@a@c@aD{CsBsBm@o@QOgAaAcCwBsAoAo@s@e@s@]cAYuAAI_@qBSo@KWKa@GMOUY_@CE?IAIAGCGCGEECAEAC?E?EBEBCDQGUO[KQMq@_@a@SSAmBCy@C}AKYGu@SmBi@_@Km@Sg@Gc@A[Bo@LMFKDIDED{@p@sAfAKHSJSJeA\\o@Ni@Dk@?qASOEw@YsAw@GEu@g@uCoBmD_Cs@e@_BkAwAcAaC_BqBuAi@Ym@WYOe@Mi@My@Ec@?m@By@Jy@PoBn@qDbAeAXa@MSOIOK_@AE_@mBESIc@WsAMo@CQG]Km@]eBe@iC_@sBKk@Ec@?CG]MsBc@mDcBeLAKIe@w@wFSyASaBW}BAMCSQiCGiBAoBByABeAHyB@Kd@wJX_GHwAb@kIj@gLN{CtAgXLyAJy@N_A^}AvA{FnA}E^uA?A`A{Dl@cC@EHDF?HAFGDIBM@OAOEMGIGCIAGBGDEHECkByB{AoB_EmFaDoEsFwHmEcG{GgJ}@oAg@_Ae@gA]gA[{AWsBi@_HScCAQGwBAKHIDO@OAMCKEIGEGCG_@Ga@QgA_@oFgAoOk@wGSaBe@eDQ{@a@kBYiAm@wBm@oB}BoF{@sBsBkEg@y@}AuCgGaLoBqDq@oA{AuCeA}BkDgIaAmCeAyCiAmDu@kCOg@AG_BcGcBgHw@wDaA{FY{AkA_IkAkIeDoU}BePaBqLkBiMAICMqA_JIq@OcA_AyGg@kDw@iGs@yGiAmKQeBa@iFO_CIgAKoBMkBSeEE{@Cm@gBu`@oAsX}@sRUmFMeDYuHIsBQwFMeF?MAKEyBAUMuG?m@MkIEeCE_DC}@G_DQmISuHCg@Ai@c@}Lc@kKCgBIoBAaAFIBM@MAKAKGKGGIe@GWKmBMmAWqEY_F?aB[yHCUCWGUa@F]Du@HgBJW@s@@qB?iBEoAAs@AMAW?S?g@AM?U?uBAsA?sH@iBBG?]?WAW?Y?}ACyCC}@?iCAaCDqAFmBJ[@]B}CJo@DkAFqCNU@S@C?o@B[@uNh@G@oETY@mAJ}@Fg@DsAJUBkAH}CNsBNuEZeEVeAHs@F_AHw@HiAP_Dn@{A\\kAZUDYF[DYFSDYFq@Lg@JcIzA{NtC_ANUD_AJ}APaBLaEJiEAmBEwAK_AIaD]{BWkPeBkI{@qDa@sHw@cBMWCyEYqEQoACkBEeAAuOMsEEiCEc@?mEGoAAcAAuC?kAAqBCS?W?iBES?i@Ag@?aBEqAGg@AaAGkAGu@KiASc@Mq@OcDcAiBi@s@SyA_@_AOGAe@Gg@Ek@CyBGyNG}@AoEAgAAqHEaMGW?a@?a]QyDCeNIuB?U?M?cXKkA?qB?uAAyCAqPAi@AoA?oNIsBAO?Q?gDAqDAE?cBA{B?wGC}@Ec@C_AQ]GeBw@qAw@uBoAsBqA_B_Ac@QeAYy@Mu@GcAB_@Bk@JoGzASFODmJ~BiBf@sD|@c@LuBd@]DU@W?SAQC_AWaAc@aBq@aAUkAMiA@s@@g@@C?a@FQFe@Ng@Vu@h@o@b@[NYHSFQB[BO@SA]Ck@Eg@OM@KDkBKyAA{@AaA?qA@q@D_BFwBNkAFS?W@U?iBAiBC{BKkAG{@?kBAm@?S?mGAcA?aEAkHAoF?_CAmJIiUC}@?sC@oED_CBKAyCKmBOuASu@I{Em@mIaAIAYE{BW{YmDuOkB{W_D[EoC]iAM{BYkAMq@Iu@AG_@Qi@o@kAEKISSQGGaAaBWYeAqBe@eAk@u@k@o@k@m@w@o@w@o@w@k@k@aBwCWY{@gBg@q@u@q@OS{@uAEG[g@QQYKg@Ko@RsAbAk@Pm@H]Bm@FqA@cDEc@EkBGcAIeCWyDe@kESaAO{@Ky@HgA",
- "radius": 300
}, - "limit": 2
}[- {
- "info": {
- "copyrights": "MagicLane"
}, - "results": [
- {
- "coordinates": [
- 8.360695,
- 49.845291
], - "name": "Aral",
- "description": "Gas Station",
- "address": {
- "street number": "2",
- "postal code": "55276",
- "city": "Oppenheim",
- "county": "Landkreis Mainz-Bingen",
- "state": "Rhineland-Palatinate",
- "country": "Germany",
- "country code": "DEU"
}, - "contact": {
- "Email": [
- "info@aral.de"
], - "Phone": [
- "+49 61333 869197"
],
}, - "native_name": "Aral",
- "distance": 36573
}, - {
- "coordinates": [
- 8.269084,
- 50.066388
], - "name": "Aral",
- "description": "Gas Station",
- "address": {
- "street name": "Berliner Straße",
- "street number": "68",
- "postal code": "65189",
- "settlement": "Südost",
- "city": "Wiesbaden",
- "state": "Hesse",
- "country": "Germany",
- "country code": "DEU"
}, - "contact": {
- "Email": [
- "info@aral.de"
], - "Phone": [
- "04961 1701141",
- "+49 61333 869197"
],
}, - "native_name": "Aral",
- "distance": 65183
}
]
}
]