Category Search
Public Preview Notice
Important notes:
- This TomTom Orbis Maps Search API document collection is in Public Preview. Go to the Public Preview - what is it? page to see what this means.
- This API is powered by TomTom Orbis Maps.
- See the TomTom Orbis Maps documentation for more information.
Purpose
If your search use case only requires POI
(Points of Interest) results filtered by category, you may use the Category Search endpoint. This endpoint will only return POI
results which are categorized as specified.
Run this endpoint
You can easily run this and other endpoints. Go to the TomTom API Explorer page and follow the directions.
List of available categories
Note: This category list is subject to change with a new data release.
Available categories
"(sub) urban", "access gateway", "administrative area", "administrative division", "adventure sports venue", "adventure vehicle", "advertising/marketing", "afghan", "african", "agricultural school", "agricultural supplies", "agricultural technology", "agriculture", "airfield", "airline", "airline access", "airport", "algerian", "ambulance unit", "american", "amphitheater", "amusement arcade", "amusement park", "amusement place", "anabranch", "animal services", "animal shelter", "antique/art", "apartment", "aquaculture facility", "aquatic zoo marine park", "arabian", "arboreta botanical gardens", "arch", "argentinean", "armenian", "art school", "ashram", "asian (other)", "asylum", "athletic", "athletic field", "atv/snowmobile", "australian", "austrian", "automatic teller machine", "automobile", "automobile manufacturing", "automotive dealer", "bags leatherwear", "balloonport", "bank", "bank(s)", "banks", "banquet rooms", "bar", "barbecue", "baseball", "basketball", "basque", "battlefield", "bay", "beach", "beach club", "beaches", "beauty salon", "beauty supplies", "bed breakfast guest houses", "belgian", "betting station", "bistro", "blood bank", "boat", "boat launching ramp", "boating equipment accessories", "bodyshops", "bolivian", "book shops", "bosnian", "bowling", "brazilian", "brewery", "bridge", "bridge tunnel operations", "british", "buffet", "building", "building (point)", "bulgarian", "bungalow", "burmese", "bus", "bus charter rentals", "bus lines", "bus station", "bus stop", "cabaret", "cabins lodges", "cable telephone", "cafeterias", "café", "café/pub", "californian", "cambodian", "camping ground", "canadian", "cape", "capital of a political entity", "car", "car glass replacement shops", "car wash", "caravan site", "caribbean", "cash dispenser", "casino", "castle", "catering", "cave", "cd's, dvd videos", "cd/video rental", "cemetery", "center", "chalet", "chemicals", "chicken", "child care facility", "chilean", "chinese", "christmas/holiday store", "church", "cinema", "city center", "cleaning services", "cliff(s)", "clinic", "closed", "clothing accessories: children", "clothing accessories: footwear shoe repairs", "clothing accessories: general", "clothing accessories: men", "clothing accessories: specialty", "clothing accessories: women", "club association", "coach stop", "coal mine(s)", "coast guard station", "cocktail bar", "coffee shop", "college", "college/university", "colombian", "comedy club", "commercial building", "common", "communication center", "community center", "company", "computer data services", "computer software", "concert hall", "condominium complex", "construction", "construction material equipment", "convenience stores", "convent", "coral reef(s)", "corsican", "cottage", "country house", "courthouse", "cove", "cove(s)", "crater lake", "crater lakes", "crater(s)", "creole-cajun", "cricket ground", "crêperie", "cuban", "culinary school", "cultural center", "currency exchange", "customs house", "customs post", "cypriot", "czech", "dairy", "dam", "dance studio school", "danish", "delicatessen", "dentist", "department store", "dependent political entity", "desert", "dinner theater", "diplomatic facility", "discotheque", "dispensary", "diversified finanacials", "dock(s)", "docking basin", "dockyard", "doctor", "dominican", "dongbei", "doughnuts", "drive through bottle shop", "drive-in cinema", "driving school", "drug store", "dry cleaners", "dune", "dutch", "egyptian", "electric vehicle station", "electrical appliance", "electrical, office it: camera's photography", "electrical, office it: computer computer supplies", "electrical, office it: consumer electronics", "electrical, office it: office equipment", "electronics", "embassy", "emergency medical service", "english", "entertainment", "equipment rental", "erotic", "estate(s)", "ethiopian", "exchange", "exhibition convention center", "exotic", "factory", "factory outlet", "fairground", "farm", "farm village", "farmers", "farms", "farmstead", "fast food", "ferry", "ferry terminal", "field(s)", "fifth-order administrative division", "filipino", "finnish", "fire station/brigade", "first-order administrative division", "fishing area", "fishing hunting area", "fitness club center", "flats/apartment complex", "florists", "flying club", "fondue", "food drinks: bakers", "food drinks: butchers", "food drinks: fishmongers", "food drinks: food markets", "food drinks: food shops", "food drinks: green grocers", "food drinks: grocers", "food drinks: wine spirits", "football", "forest area", "forest reserve", "forest station", "forest(s)", "fort", "fossilized forest", "foundry", "fourth-order administrative division", "fracture zone", "free trade zone", "french", "frontier crossing", "fuel depot", "funeral service mortuaries", "furniture/home furnishings", "furrow", "fusion", "gap", "garden(s)", "gas-oil separator plant", "gasfield", "gate", "general", "general car repair servicing", "general practitioner", "geographic feature", "german", "geyser", "ghat", "gifts, cards, novelties souvenirs", "glacier(s)", "glassware/ceramic", "gold exchange", "gold mine(s)", "golf course", "gorge(s)", "government office", "grassland", "grave", "gravel area", "grazing area", "greek", "grill", "guangdong", "guest house", "gulf", "gully", "gurudwara", "hairdressers barbers", "halting place", "hamburgers", "hammock(s)", "hanging valley", "harbor", "harbor(s)", "hardware", "hawaiian", "headland", "headwaters", "health care service", "heath", "helipad/helicopter landing", "heliport", "hermitage", "high school", "hiking", "hill", "hills", "historic site", "historical administrative division", "historical first-order administrative division", "historical fourth-order administrative division", "historical park", "historical political entity", "historical populated place", "historical region", "historical second-order administrative division", "historical site", "historical third-order administrative division", "hobby/free time", "hockey club", "hole", "holiday rental", "home appliance repair", "homestead", "horse racing", "horse riding", "horticulture", "hospital", "hospital for women children", "hospital of chinese medicine", "hospital/polyclinic", "hostel", "hot pot", "hot spring(s)", "hotel", "hotel/motel", "house garden: carpet/floor coverings", "house garden: curtains/textiles", "house garden: do-it-yourself centers", "house garden: furniture fittings", "house garden: garden centers services", "house garden: glass windows", "house garden: kitchens bathrooms", "house garden: lighting", "house garden: painting decorating", "hunan", "hungarian", "hunting reserve", "ice cream parlor", "ice hockey", "ice skating rink", "import/export distribution", "important tourist attraction", "indian", "indonesian", "industrial area", "industrial building", "informal", "insurance", "international", "internet café", "investment advisors", "iranian", "irish", "island", "islands", "islet", "israeli", "israeli settlement", "italian", "jamaican", "japanese", "jazz club", "jetty", "jewelry, clocks watches", "jewish", "junior college/community college", "karaoke club", "korean", "kosher", "lagoon", "lakeshore", "language school", "large_airport", "latin american", "laundry", "lebanese", "legal services", "leisure center", "leprosarium", "library", "lighthouse", "local", "local government office", "local specialities", "locale", "locality", "lottery shop", "luxembourgian", "macrobiotic", "maghrib", "mail/package/freight delivery", "mall", "maltese", "manufacturing", "manufacturing facility", "marina", "marine electronic equipment", "market", "marsh/swamp/vlei", "mauritian", "mausoleum/grave", "mechanical engineering", "media facility", "medical center", "medical supplies equipment", "mediterranean", "medium_airport", "memorial", "metro", "metro station", "mexican", "microbrewery/beer garden", "middle eastern", "middle school", "military authority", "military base", "military installation", "military school", "mineral/hot springs", "mining", "mission", "mobile phone shop", "monastery", "mongolian", "monument", "moroccan", "mosque", "motel", "motor sport", "motorcycle", "motorcycle repair", "motoring organization office", "mountain bike", "mountain pass", "mountain peak", "moving storage", "multi-purpose", "museum", "music center", "musical instruments", "mussels", "nail salon", "national", "native reservation", "natural attraction", "nature reserve", "naval base", "neighbourhood", "nepalese", "netball", "newsagents tobacconists", "nightlife", "non governmental organization", "norwegian", "oasis", "observation point", "observatory", "oem", "office building", "oil natural gas", "open parking area", "opera", "opera house", "opticians", "order 1 area", "order 2 area", "order 3 area", "order 4 area", "order 5 area", "order 6 area", "order 7 area", "order 8 area", "order 9 area", "organic", "oriental", "pagoda", "pakistani", "palace", "pan", "park", "park headquarters", "park recreation area", "parking garage", "parking lot", "parkway", "passenger transport ticket office", "pawn shop", "pedestrian subway", "personal care facility", "personal service", "peruvian", "pet supplies", "petrol station", "pharmaceuticals", "pharmacy", "photo lab/development", "photocopy", "picnic area", "pier", "pizza", "place of worship", "plain/flat", "planetarium", "plateau", "police post", "police station", "polish", "polynesian", "populated locality", "populated place", "populated places", "port", "port/warehouse facility", "portage", "portuguese", "post office", "power station", "pre school", "preserve", "primary producer", "primary resource/utility", "primary school", "prison", "prison/correctional facility", "private authority", "private club", "promenade", "promontory(-ies)", "provençal", "province", "pub", "pub food", "public", "public amenity", "public authority", "public call box", "public health technologies", "public transport stop", "publishing technologies", "pyramid", "pyramids", "quarry", "race track", "racetrack", "railroad station", "railroad stop", "railway siding", "railway station", "rapids", "real estate", "real estate agents", "recreation area", "recreational", "recreational vehicles", "recycling shop", "reef", "religious center", "religious site", "rent-a-car facility", "rent-a-car-parking", "repair facility", "repair shops", "research facility", "reservation", "reservoir", "residential accommodation", "residential estate", "resort", "rest area", "rest camps", "restaurant", "restaurant area", "resthouse", "retail outlet", "retirement community", "retreat", "ridge", "river crossing", "river scenic area", "road rescue", "roadside", "rock climbing", "rocks", "rugby ground", "rumanian", "russian", "salad bar", "sale installation of car accessories", "sanatorium", "sandwich", "sauna, solarium massage", "savings institution", "savoyan", "scandinavian", "scenic/panoramic view", "school", "scottish", "seafood", "seaplane_base", "seashore", "seat of a first-order administrative division", "seat of a fourth-order administrative division", "seat of a second-order administrative division", "seat of a third-order administrative division", "seat of government of a political entity", "second-order administrative division", "security gate", "security products", "senior high school", "service", "services", "shandong", "shanghai", "shop", "shopping center", "sichuan", "sicilian", "ski resort", "slavic", "slovak", "small_airport", "snacks", "snooker, pool billiard", "soccer", "soul food", "soup", "spa", "spanish", "special", "special school", "specialist", "specialty foods", "sport school", "sports center", "sports equipment clothing", "squash court", "stadium", "stamp shop", "station access", "statue", "steak house", "stock exchange", "store", "sudanese", "supermarkets hypermarkets", "supra national", "surinamese", "sushi", "swedish", "swimming pool", "swiss", "synagogue", "syrian", "tailor shop", "taiwanese", "take away", "tapas", "tax services", "taxi stand", "taxi, limousine shuttle service", "tea house", "technical school", "tele communications", "temple", "temple(s)", "tennis court", "teppanyakki", "thai", "theater", "thematic sport", "third-order administrative division", "tibetan", "toilet", "tourist information office", "tower", "townhouse complex", "toys games", "traffic circle", "traffic control department", "traffic light", "traffic service center", "traffic sign", "trail system", "tram stop", "transport", "transport authority/vehicle registration", "travel agents", "truck", "truck repair service", "truck stop", "tunisian", "tunnel", "turkish", "tyre (tire) services", "united states government establishment", "university", "university prep school", "unknown", "uruguayan", "valley", "van", "variety store", "vegetarian", "venezuelan", "veterinarian", "veterinary facility", "vietnamese", "villa", "vocational training", "water hole", "water sport", "wedding services", "weigh scales", "weigh station", "welfare organization", "well", "welsh", "western continental", "wholesale clubs", "wilderness area", "wildlife park", "wildlife reserve", "wine bar", "winery", "winter sport", "yacht basin", "yogurt/juice bar", "zoo", "zoos, arboreta botanical garden"
Request data
HTTPS Method: GET
For ease of viewing and identification:
- Constants and parameters enclosed in curly brackets { } must be replaced with their values.
- Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.
Important note: Either apiVersion
parameter or TomTom-Api-Version
header needs to be present.
https://{baseURL}/maps/orbis/places/categorySearch/{query}.{ext}?key={Your_API_Key}&apiVersion={apiVersion}&typeahead={typeahead}&limit={limit}&countrySet={countrySet}&geobias={geobias}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&categorySet={categorySet}&brandSet={brandSet}&connectorSet={connectorSet}&fuelSet={fuelSet}&vehicleTypeSet={vehicleTypeSet}&view={view}&openingHours={openingHours}&timeZone={timeZone}&mapcodes={mapcodes}&minPowerKW={minPowerKW}&maxPowerKW={maxPowerKW}
https://api.tomtom.com/maps/orbis/places/categorySearch/pizza.json?key={Your_API_Key}&apiVersion=1
curl 'https://api.tomtom.com/maps/orbis/places/categorySearch/pizza.json?key={Your_API_Key}&apiVersion=1'
Request parameters
The following table describes the parameters that can be used in a request.
- Required parameters must be used or the call will fail.
- Optional parameters may be used.
- If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
- The order of request parameters is not important.
Required parameters | Description |
---|---|
| Base URL for calling the API.
|
| A valid response format. |
| An API Key valid for the requested service. |
Optional parameters | Description |
---|---|
| Service version. |
| The query string. It must be properly URL-encoded. |
| If the Default value: |
| Maximum number of responses that will be returned. |
| Starting offset of the returned results within the full result set.
|
| Latitude, e.g.,
|
| Longitude, e.g.,
|
| Comma separated string of country codes in ISO 3166-1 alpha-2 or alpha-3
code formats (e.g., FR,ES or FRA,ESP). This will limit the search to the
specified countries. The choice of view may restrict which countries are
available. |
| If |
| Top-left position of the bounding box. |
| Bottom-right position of the bounding box. Note: The
|
| Location bias for search, which can be specified in different shapes. Location bias is used to communicate a location preference to the search engine - for example, to bias search results to the user's viewport. Currently two types are supported: point and rectangle. Value: Colon-separated key-value pair, composed of type of shape as a key and the encoded shape as a value. Each shape has its own encoding format:
Usage examples:
Notes:
|
| Language in which search results should be returned. Should be one of
the
TomTom supported IETF language tags
, case insensitive. When data in the specified language is not available
for a specific field or the language is not specified, the default
language is used (English). |
| Indexes for which extended postal codes should be included in the
results. Available indexes are:
|
| A comma-separated list of categories which could be used to restrict the
result to the Points Of Interest of specific categories. The list of
categories can be discovered using the
POI Categories
endpoint.
|
| A comma-separated list of brand names which could be used to restrict
the result to Points Of Interest of specific brands.
|
| A comma-separated list of connector types which could be used to
restrict the result to the Points Of Interest of type Electric Vehicle
Station supporting specific connector types. See the list of
Supported Connector Types.
|
| An optional parameter which could be used to restrict the result to the
Points Of Interest of type Electric Vehicle Station supporting at least
one connector with a specific minimal value of power in kilowatts
(closed interval - with that value). |
| An optional parameter which could be used to restrict the result to the
Points Of Interest of type Electric Vehicle Station supporting at least
one connector with a specific maximum value of power in kilowatts
(closed interval - with that value). |
| A comma-separated list of fuel types which could be used to restrict the
result to the Points Of Interest of specific fuels. If
Usage examples:
|
| A comma-separated list of vehicle types that could be used to restrict the
result to the Points Of Interest of specific vehicles. If
Usage examples:
|
| Geopolitical View. The context used to resolve the handling of disputed
territories. Views include only |
| List of opening hours for a POI (Points of Interest). |
| Enables the return of a comma-separated mapcodes list. It can also
filter the response to only show selected mapcode types. See
mapcodes
in the response.
|
| Used to indicate the mode in which the |
| An optional parameter that provides the possibility to return related
Points Of Interest.
|
Request headers
Optional headers | Description |
---|---|
TomTom-Api-Version | Service version. |
Enables response compression. | |
Tracking-ID | Specifies an identifier for the request. It can be used to trace a call.
The value must match the regular expression
Value: An |
Response data
Response body
For illustrative purposes the example below is neatly indented and includes all possible response fields. Actual responses are more compact and the fields present will vary based on the result type and the data available. See the following response field documentation for more information. When requesting JSON output the response has the following structure:
1{2 "summary": {3 "query": "pizza",4 "queryTime": 95,5 "numResults": 10,6 "totalResults": 247458,7 "geoBias": {8 "lat": 36.98844,9 "lon": -121.9748310 }11 },12 "results": []13}
Each element of the results
array is in the following format:
Results array elements format - JSON
1{2 "type": "POI",3 "id": "g6JpZK84NDAwNjEwMDE4NjUxNDKhY6NVU0GhdqdVbmlmaWVk",4 "score": 5,5 "dist": 0,6 "poi": {7 "name": "Upper Crust Pizza & Pasta",8 "phone": "+(1)-(831)-4762333",9 "url": "www.uppercrustsc.com/",10 "brands": [11 {12 "name": "Upper Crust"13 }14 ],15 "categorySet": [16 {17 "id": 731501518 }19 ],20 "openingHours": {21 "mode": "nextSevenDays",22 "timeRanges": [23 {24 "startTime": {25 "date": "2019-02-05",26 "hour": 7,27 "minute": 028 },29 "endTime": {30 "date": "2019-02-05",31 "hour": 21,32 "minute": 033 }34 },35 {36 "startTime": {37 "date": "2019-02-06",38 "hour": 7,39 "minute": 040 },41 "endTime": {42 "date": "2019-02-06",43 "hour": 21,44 "minute": 045 }46 },47 {48 "startTime": {49 "date": "2019-02-07",50 "hour": 7,51 "minute": 052 },53 "endTime": {54 "date": "2019-02-07",55 "hour": 21,56 "minute": 057 }58 },59 {60 "startTime": {61 "date": "2019-02-08",62 "hour": 7,63 "minute": 064 },65 "endTime": {66 "date": "2019-02-08",67 "hour": 21,68 "minute": 069 }70 },71 {72 "startTime": {73 "date": "2019-02-09",74 "hour": 7,75 "minute": 076 },77 "endTime": {78 "date": "2019-02-09",79 "hour": 21,80 "minute": 081 }82 },83 {84 "startTime": {85 "date": "2019-02-10",86 "hour": 7,87 "minute": 088 },89 "endTime": {90 "date": "2019-02-10",91 "hour": 12,92 "minute": 093 }94 },95 {96 "startTime": {97 "date": "2019-02-10",98 "hour": 14,99 "minute": 0100 },101 "endTime": {102 "date": "2019-02-10",103 "hour": 21,104 "minute": 0105 }106 }107 ]108 },109 "timeZone": {110 "ianaId": "Europe/Andorra"111 },112 "features": [113 {114 "order": 0,115 "category": "company_or_office",116 "group": "business"117 },118 {119 "order": 1,120 "category": "theater",121 "group": "cultural"122 }123 ]124 },125 "address": {126 "streetNumber": "2501",127 "streetName": "Soquel Dr",128 "municipalitySubdivision": "Santa Cruz, Live Oak",129 "municipality": "Santa Cruz, Live Oak",130 "countrySecondarySubdivision": "Santa Cruz",131 "countryTertiarySubdivision": "Santa Cruz",132 "countrySubdivision": "CA",133 "postalCode": "95065",134 "extendedPostalCode": "950652023",135 "countryCode": "US",136 "country": "United States Of America",137 "countryCodeISO3": "USA",138 "freeformAddress": "2501 Soquel Dr, Santa Cruz, CA 95065",139 "countrySubdivisionName": "California",140 "localName": "Santa Cruz"141 },142 "position": {143 "lat": 36.98844,144 "lon": -121.97483145 },146 "mapcodes": [147 {148 "type": "Local",149 "fullMapcode": "US-CA FS.WRH3",150 "territory": "US-CA",151 "code": "FS.WRH3"152 },153 {154 "type": "International",155 "fullMapcode": "S4ZW4.990V"156 },157 {158 "type": "Alternative",159 "fullMapcode": "US-CA 4349.S8W",160 "territory": "US-CA",161 "code": "4349.S8W"162 },163 {164 "type": "Alternative",165 "fullMapcode": "US-CA JJCH.H9DF",166 "territory": "US-CA",167 "code": "JJCH.H9DF"168 },169 {170 "type": "Alternative",171 "fullMapcode": "USA JJCH.H9DF",172 "territory": "USA",173 "code": "JJCH.H9DF"174 }175 ],176 "viewport": {177 "topLeftPoint": {178 "lat": 36.98934,179 "lon": -121.97596180 },181 "btmRightPoint": {182 "lat": 36.98754,183 "lon": -121.9737184 }185 },186 "entryPoints": [187 {188 "type": "main",189 "position": {190 "lat": 36.98817,191 "lon": -121.97487192 }193 },194 {195 "type": "minor",196 "functions": ["FrontDoor"],197 "position": {198 "lat": 52.30987,199 "lon": 4.76093200 }201 }202 ],203 "chargingPark": {204 "connectors": [205 {206 "connectorType": "IEC62196Type2CCS",207 "ratedPowerKW": 22.2,208 "currentA": 32,209 "currentType": "AC3",210 "voltageV": 380211 },212 {213 "connectorType": "Tesla",214 "ratedPowerKW": 43.2,215 "currentA": 16,216 "currentType": "AC3",217 "voltageV": 480218 }219 ]220 },221 "dataSources": {222 "chargingAvailability": {223 "id": "442009000132285"224 },225 "parkingAvailability": {226 "id": "00000000-0005-36de-0009-20d4467654e2"227 },228 "fuelPrice": {229 "id": "1:cf81fe50-6218-11ea-a677-d05099d5f839"230 },231 "geometry": {232 "id": "00004e4c-3100-3c00-0000-0000685e23c7"233 }234 }235}
Response fields
The following table describes all of the fields that can appear in a response. Fields are listed by the response section they belong to and in the order that they appear in the response.
Primary fields | Description |
---|---|
| Summary information about the search that was performed. |
| Result list, sorted in descending order by score. |
summary object | |
Field | Description |
| Query as interpreted by the search engine. |
| Time spent on resolving the query. |
| Number of results in the response. |
| Starting offset of the returned results within the full result set.
|
| Total number of results found. |
| Maximum fuzzy level required to provide results.
|
| Position used to bias the results: |
results array | |
Field | Description |
| Type of result. |
| A stable unique id for the |
| Score of the result. A larger score means there is a probability that a result meeting the query criteria is higher. |
| Unit: meters. This is the distance to an object if |
| Information about the original data source of the result.
|
| Information about the Points of Interest in the result. |
| List of related Points Of Interest.
|
| Structured address for the result. |
| Position of the result: |
| List of mapcode objects |
| A viewport which can be used to display the result on a map. |
| List of entry points of the POI. |
| A list of |
| Optional section. Reference ids for use with the
Additional Data
service. |
| Optional section. List of fuel types served by the petrol station. |
| Optional section. List of vehicle types supported by the petrol station. |
poi object | |
Field | Description |
| Name of the POI. |
| Telephone number. |
| The list of |
| Website URL. |
| The list of the most specific |
| List of opening hours for a openingHours object |
| The list of
|
| Time zone information for the POI. |
| The list of the POI features. |
categorySet array | |
Field | Description |
| Category id. A full list of available categories is available under the POI Categories endpoint. |
brands array | |
Field | Description |
| Brand name. |
classifications array | |
Field | Description |
| Fixed top level category code. |
| List of category names with locale code information. Currently only
|
names array | |
Field | Description |
| Locale code of this category name. |
| Category name in given locale. |
relatedPois object | |
Field | Description |
| Relation type: |
| Pass this as |
address object | |
Field | Description |
| The building number on the street. |
| The street name. |
| Sub City |
| Sub Sub City |
| Neighbourhood |
| City / Town |
| County |
| Named Area |
| State or Province |
| Postal Code / Zip Code |
| Extended postal code (availability dependent on region) |
| Country (Note: this is a two-letter code, not a country name.) |
| Country name |
| ISO alpha-3 country code |
| An address line formatted according to the formatting rules of the result's country of origin. In the case of countries, its full country name. |
| The full name of the first level of a country's administrative
hierarchy. This field appears only in case
|
| An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. |
mapcodes object | |
Field | Description |
| Type of mapcode. |
| The full form of a mapcode ( |
| The
|
| The mapcode without the |
viewport object | |
Field | Description |
| Top-left corner of the rectangle. |
| Bottom-right corner of the rectangle. |
entryPoints array | |
Field | Description |
| The main entry point. One of: |
| If present, represents the type of access for the POI. |
| Position of the entry point. |
chargingPark object | |
Field | Description |
| A list of connectors available in the Points Of Interest of an Electric
Vehicle Station type. |
connectors array | |
Field | Description |
| Type of the connector available in Electric Vehicle Station. See the list of Supported Connector Types. |
| Rated power of the connector in kilowatts (kW). |
| Current value of the connector in amperes (A). |
| Current type of the connector. |
| Voltage of the connector in Volts (V). |
dataSources object | |
Field | Description |
| Information about the charging stations availability. |
| Information about the parking site availability. |
| Information about the fuel station prices. |
| Information about the geometric shape of the result. |
chargingAvailability object | |
Field | Description |
| Pass this as |
parkingAvailability object | |
Field | Description |
string | Pass this as |
fuelPrice object | |
Field | Description |
| Pass this as |
geometry object | |
Field | Description |
| Pass this as |
| Name of an additional data provider. |
LatLon | |
Field | Description |
| Latitude. min/max: |
| Longitude. min/max: |
openingHours object | |
Field | Description |
| Mode used in the request. |
| List of time ranges for the next 7 days. |
timeRanges array | |
Field | Description |
| The point in the next 7 days range when a given |
| The point in the next 7 days range when a given |
startTime object, endTime object | |
Field | Description |
| Represents current day in calendar year in POI time zone. |
| Hours are in the 24 hour format in the local time of a POI; possible
values are |
| Minutes are in the local time of a POI; possible values are
|
timeZone object | |
Field | Description |
| ID from the IANA Time Zone Database. |
features array | |
Field | Description |
| The order is a 0-based value indicating relative order. The order defines the importance of the category. |
| The POI feature category. |
| The group of the POI feature category. |
Response codes
The following data table contains response codes signifying successful and failed requests to an API server.
Code | Meaning & possible causes |
---|---|
| OK : The search successfully returned zero or more results. |
| Bad Request : One or more parameters were incorrectly specified. |
| Forbidden : Possible causes include:
|
| Method Not Allowed : The HTTP method ( |
| Not Found : The HTTP request method ( |
| Too Many Requests : The API Key is over QPS (Queries per second). |
| Server Error : The service was unable to process your request. Contact support to resolve the issue. |
Response headers
The following data table contains response headers sent back from an API server.
Header | Description |
---|---|
Ensures that clients implementing the CORS security model are able to
access the response from this service. | |
Indicates the format of the response, as chosen by the client.
| |
If requested by the client, the Search service applies gzip compression
to the responses with the Accept-Encoding header. | |
Tracking-ID | An identifier for the request. If the
Tracking-ID header was specified, it
is replicated in the response. Otherwise, it is generated automatically
by the service. It is only meant to be used for support and does not
involve tracking of you or your users in any form. |
Error response
The error response content type depends on the ext
parameter.
1{2 "errorText": "Error parsing 'language': Language tag 'en-ES' not supported",3 "detailedError": {4 "code": "BadRequest",5 "message": "Error parsing 'language': Language tag 'en-ES' not supported",6 "target": "language"7 },8 "httpStatusCode": "400"9}
1<?xml version="1.0" encoding="UTF-8"?>2<response>3 <errorText>Error parsing 'language': Language tag 'en-ES' not supported</errorText>4 <detailedError>5 <code>BadRequest</code>6 <message>Error parsing 'language': Language tag 'en-ES' not supported</message>7 <target>language</target>8 </detailedError>9 <httpStatusCode>400</httpStatusCode>10</response>
Error response fields
Primary fields | Description |
---|---|
| A human-readable description of the error. |
| Detailed information about the error. |
| HTTP response codes signifying failed requests to an API server. |
detailedError object | |
Field | Description |
| One of a server-defined set of error codes. |
| A human-readable description of the error code. It is intended as an aid to developers and is not suitable for exposure to end users. |
| Optional. Target of the particular error. |