API Specification for Google Maps Platform
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19970217","collectionId":"2c3afa03-4d9b-41ce-b234-27624b8d7053","publishedId":"UVsLQ5vP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-03-22T23:58:27.000Z"},"item":[{"name":"Places API","item":[{"name":"Find Place From Text","id":"58749ae8-7a87-41a2-8b39-536ac067e452","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apis.blobr.app/errlq9hab6lpcvsy/maps/api/place/findplacefromtext/json?fields=business_status,formatted_address,geometry,icon,icon_mask_base_uri,icon_background_color,name,permanently_closed,photo,place_id,plus_code,type,opening_hours,price_level,rating,user_ratings_total&input=White House&inputtype=textquery&language=en","description":"A Find Place request takes a text input and returns a place. The input can be any kind of Places text data, such as a name, address, or phone number. The request must be a string. A Find Place request using non-string data such as a lat/lng coordinate or plus code generates an error.
\nCaution: Place Search requests and Place Details requests do not return the same fields. Place Search requests return a subset of the fields that are returned by Place Details requests. If the field you want is not returned by Place Search, you can use Place Search to get a place_id, then use that Place ID to make a Place Details request. For more information on the fields that are unavailable in a Place Search request, see Places API fields support.
\nUse the fields parameter to specify a comma-separated list of place data types to return. For example: fields=formatted_address,name,geometry. Use a forward slash when specifying compound values. For example: opening_hours/open_now.
Fields are divided into three billing categories: Basic, Contact, and Atmosphere. Basic fields are billed at base rate, and incur no additional charges. Contact and Atmosphere fields are billed at a higher rate. See the pricing sheet for more information. Attributions, html_attributions, are always returned with every call, regardless of whether the field has been requested.
Basic
\nThe Basic category includes the following fields: address_component, adr_address, business_status, formatted_address, geometry, icon, icon_mask_base_uri, icon_background_color, name, permanently_closed (deprecated), photo, place_id, plus_code, type, url, utc_offset, vicinity.
Contact
\nThe Contact category includes the following fields: formatted_phone_number, international_phone_number, opening_hours, website
Atmosphere
\nThe Atmosphere category includes the following fields: price_level, rating, review, user_ratings_total.
(Required) Text input that identifies the search target, such as a name, address, or phone number. The input must be a string. Non-string input such as a lat/lng coordinate or plus code generates an error.
\n","type":"text/plain"},"key":"input","value":"White House"},{"description":{"content":"(Required) The type of input. This can be one of either textquery or phonenumber. Phone numbers must be in international format (prefixed by a plus sign (\"+\"), followed by the country code, then the phone number itself). See E.164 ITU recommendation for more information.
The language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.Prefer results in a specified area, by specifying either a radius plus lat/lng, or two lat/lng pairs representing the points of a rectangle. If this parameter is not specified, the API uses IP address biasing by default.
\nipbias (this option has no additional parameters).point:lat,lng.circle:radius@lat,lng.rectangle:south,west|north,east. Note that east/west values are wrapped to the range -180, 180, and north/south values are clamped to the range -90, 90.The Places API is a service that returns information about places using HTTP requests. Places are defined within this API as establishments, geographic locations, or prominent points of interest.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Example place_id for the white house
\n","type":"text/plain"},"key":"place_id","value":"ChIJ37HL3ry3t4kRv3YLbdhpWXE"},{"description":{"content":"All permitted fields
\n","type":"text/plain"},"key":"fields","value":"address_component,adr_address,business_status,formatted_address,geometry,icon,icon_mask_base_uri,icon_background_color,name,permanently_closed,photo,place_id,plus_code,type,url,utc_offset,vicinity,formatted_phone_number,international_phone_number,opening_hours,website,price_level,rating,review,user_ratings_total"},{"key":"sessiontoken","value":"A Nearby Search lets you search for places within a specified area. You can refine your search request by supplying keywords or specifying the type of place you are searching for.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"(Required) The point around which to retrieve place information. This must be specified as latitude,longitude.
Defines the distance (in meters) within which to return place results. You may bias results to a specified circle by passing a location and a radius parameter. Doing so instructs the Places service to prefer showing results within that circle; results outside of the defined area may still be displayed.
The radius will automatically be clamped to a maximum value depending on the type of search and other parameters.
\nkeyword or name: 50,000 meterskeyword or namerankby parameter.rankby=distance, the radius parameter will not be accepted, and will result in an INVALID_REQUEST.The language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.A term to be matched against all content that Google has indexed for this place, including but not limited to name and type, as well as customer reviews and other third-party content.
\nExplicitly including location information using this parameter may conflict with the location, radius, and rankby parameters, causing unexpected results.
\nIf this parameter is omitted, places with a business_status of CLOSED_TEMPORARILY or CLOSED_PERMANENTLY will not be returned.
\n","type":"text/plain"},"key":"keyword","value":"Restricts results to only those places within the specified range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.
\n","type":"text/plain"},"key":"maxprice","value":"Restricts results to only those places within the specified range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.
\n","type":"text/plain"},"key":"minprice","value":"Not Recommended A term to be matched against all content that Google has indexed for this place. Equivalent to keyword. The name field is no longer restricted to place names. Values in this field are combined with values in the keyword field and passed as part of the same search string. We recommend using only the keyword parameter for all search terms.
Returns only those places that are open for business at the time the query is sent. Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.
\n","type":"text/plain"},"key":"opennow","value":"Returns up to 20 results from a previously run search. Setting a pagetoken parameter will execute a search with the same parameters used previously — all parameters other than pagetoken will be ignored.
Specifies the order in which results are listed. Possible values are:
\nprominence (default). This option sorts results based on their importance. Ranking will favor prominent places within the set radius over nearby places that match but that are less prominent. Prominence can be affected by a place's ranking in Google's index, global popularity, and other factors. When prominence is specified, the radius parameter is required.distance. This option biases search results in ascending order by their distance from the specified location. When distance is specified, one or more of keyword, name, or type is required and radius is disallowed.Restricts the results to places matching the specified type. Only one type may be specified. If more than one type is provided, all types following the first entry are ignored.
\ntype=hospital|pharmacy|doctor becomes type=hospitaltype=hospital,pharmacy,doctor is ignored entirelySee the list of supported types.
\nThe Google Places API Text Search Service is a web service that returns information about a set of places based on a string — for example \"pizza in New York\" or \"shoe stores near Ottawa\" or \"123 Main Street\". The service responds with a list of places matching the text string and any location bias that has been set.
\nThe service is especially useful for making ambiguous address queries in an automated system, and non-address components of the string may match businesses as well as addresses. Examples of ambiguous address queries are incomplete addresses, poorly formatted addresses, or a request that includes non-address components such as business names.
\nThe search response will include a list of places. You can send a Place Details request for more information about any of the places in the response.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"(Required) The text string on which to search, for example: \"restaurant\" or \"123 Main Street\". The Google Places service will return candidate matches based on this string and order the results based on their perceived relevance.
\n","type":"text/plain"},"key":"query","value":"White House"},{"disabled":true,"description":{"content":"The point around which to retrieve place information. This must be specified as latitude,longitude.
location parameter may be overriden if the query contains an explicit location such as Market in Barcelona. Using quotes around the query may also influence the weight given to the location and radius.Restricts results to only those places within the specified range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.
\n","type":"text/plain"},"key":"maxprice","value":"Restricts results to only those places within the specified range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.
\n","type":"text/plain"},"key":"minprice","value":"Returns only those places that are open for business at the time the query is sent. Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.
\n","type":"text/plain"},"key":"opennow","value":"Returns up to 20 results from a previously run search. Setting a pagetoken parameter will execute a search with the same parameters used previously — all parameters other than pagetoken will be ignored.
Defines the distance (in meters) within which to return place results. You may bias results to a specified circle by passing a location and a radius parameter. Doing so instructs the Places service to prefer showing results within that circle; results outside of the defined area may still be displayed.
The radius will automatically be clamped to a maximum value depending on the type of search and other parameters.
\nkeyword or name: 50,000 meterskeyword or namerankby parameter.rankby=distance, the radius parameter will not be accepted, and will result in an INVALID_REQUEST.Restricts the results to places matching the specified type. Only one type may be specified. If more than one type is provided, all types following the first entry are ignored.
\ntype=hospital|pharmacy|doctor becomes type=hospitaltype=hospital,pharmacy,doctor is ignored entirelySee the list of supported types.
\nThe language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.The region code, specified as a ccTLD (\"top-level domain\") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is \"uk\" (.co.uk) while its ISO 3166-1 code is \"gb\" (technically for the entity of \"The United Kingdom of Great Britain and Northern Ireland\").
\n","type":"text/plain"},"key":"region","value":"en"}],"variable":[]}},"response":[{"id":"2ad95e1d-cb9e-4b11-b217-51763ccbe367","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.blobr.app/errlq9hab6lpcvsy/maps/api/place/textsearch/json?query=White House","host":["https://apis.blobr.app/errlq9hab6lpcvsy"],"path":["maps","api","place","textsearch","json"],"query":[{"key":"query","value":"White House","description":"(Required) The text string on which to search, for example: \"restaurant\" or \"123 Main Street\". The Google Places service will return candidate matches based on this string and order the results based on their perceived relevance."},{"key":"location","value":"location parameter may be overriden if the query contains an explicit location such as Market in Barcelona. Using quotes around the query may also influence the weight given to the location and radius.The Place Photo service, part of the Places API, is a read- only API that allows you to add high quality photographic content to your application. The Place Photo service gives you access to the millions of photos stored in the Places database. When you get place information using a Place Details request, photo references will be returned for relevant photographic content. Find Place, Nearby Search, and Text Search requests also return a single photo reference per place, when relevant. Using the Photo service you can then access the referenced photos and resize the image to the optimal size for your application.
\nPhotos returned by the Photo service are sourced from a variety of locations, including business owners and user contributed photos. In most cases, these photos can be used without attribution, or will have the required attribution included as a part of the image. However, if the returned photo element includes a value in the html_attributions field, you will have to include the additional attribution in your application wherever you display the image.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"(Required) A string identifier that uniquely identifies a photo. Photo references are returned from either a Place Search or Place Details request.
\n","type":"text/plain"},"key":"photo_reference","value":"Aap_uEC7IbboaQKJZSB2DAZxtBI9K1d1tqSGfra8_C3ki8wga0qk2ttpvDjKD2PA4XlBFV_wXiSW10Nhi-V-1KzT78r0cxDLxMM4in71tluj9U1xTPYQfaAXq0wMVzcyQ6dj0PK2bBZD54_lRx_UAhXpMdq6vAxkD9aFcwZkmCzTKkK9jduu"},{"description":{"content":"Specifies the maximum desired height, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the maxheight and maxwidth properties accept an integer between 1 and 1600.
Specifies the maximum desired width, in pixels, of the image. If the image is smaller than the values specified, the original image will be returned. If the image is larger in either dimension, it will be scaled to match the smaller of the two dimensions, restricted to its original aspect ratio. Both the maxheight and maxwidth properties accept an integer between 1 and 1600.
The Query Autocomplete service can be used to provide a query prediction for text-based geographic searches, by returning suggested queries as you type.
\nThe Query Autocomplete service allows you to add on-the-fly geographic query predictions to your application. Instead of searching for a specific location, a user can type in a categorical search, such as \"pizza near New York\" and the service responds with a list of suggested queries matching the string. As the Query Autocomplete service can match on both full words and substrings, applications can send queries as the user types to provide on-the-fly predictions.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"(Required) The text string on which to search. The Place Autocomplete service will return candidate matches based on this string and order results based on their perceived relevance.
\n","type":"text/plain"},"key":"input","value":"p"},{"disabled":true,"description":{"content":"The position, in the input term, of the last character that the service uses to match predictions. For example, if the input is Google and the offset is 3, the service will match on Goo. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is Google abc and the offset is 3, the service will attempt to match against Goo abc. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret.
The point around which to retrieve place information. This must be specified as latitude,longitude.
location parameter may be overriden if the query contains an explicit location such as Market in Barcelona. Using quotes around the query may also influence the weight given to the location and radius.Defines the distance (in meters) within which to return place results. You may bias results to a specified circle by passing a location and a radius parameter. Doing so instructs the Places service to prefer showing results within that circle; results outside of the defined area may still be displayed.
The radius will automatically be clamped to a maximum value depending on the type of search and other parameters.
\nkeyword or name: 50,000 meterskeyword or namerankby parameter.rankby=distance, the radius parameter will not be accepted, and will result in an INVALID_REQUEST.The language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.location parameter may be overriden if the query contains an explicit location such as Market in Barcelona. Using quotes around the query may also influence the weight given to the location and radius.The Place Autocomplete service is a web service that returns place predictions in response to an HTTP request. The request specifies a textual search string and optional geographic bounds. The service can be used to provide autocomplete functionality for text-based geographic searches, by returning places such as businesses, addresses and points of interest as a user types.
\nThe Place Autocomplete service can match on full words and substrings, resolving place names, addresses, and plus codes. Applications can therefore send queries as the user types, to provide on-the-fly place predictions.
\nThe returned predictions are designed to be presented to the user to aid them in selecting the desired place. You can send a Place Details request for more information about any of the places which are returned.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"(Required) The text string on which to search. The Place Autocomplete service will return candidate matches based on this string and order results based on their perceived relevance.
\n","type":"text/plain"},"key":"input","value":"pa"},{"disabled":true,"description":{"content":"A random string which identifies an autocomplete session for billing purposes.
\nThe session begins when the user starts typing a query, and concludes when they select a place and a call to Place Details is made. Each session can have multiple queries, followed by one place selection. The API key(s) used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the sessiontoken parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).
We recommend the following guidelines:
\nA grouping of places to which you would like to restrict your results. Currently, you can use components to filter by up to 5 countries. Countries must be passed as a two character, ISO 3166-1 Alpha-2 compatible country code. For example: components=country:fr would restrict your results to places within France. Multiple countries must be passed as multiple country:XX filters, with the pipe character | as a separator. For example: components=country:us|country:pr|country:vi|country:gu|country:mp would restrict your results to places within the United States and its unincorporated organized territories.
Returns only those places that are strictly within the region defined by location and radius. This is a restriction, rather than a bias, meaning that results outside this region will not be returned even if they match the user input.
The position, in the input term, of the last character that the service uses to match predictions. For example, if the input is Google and the offset is 3, the service will match on Goo. The string determined by the offset is matched against the first word in the input term only. For example, if the input term is Google abc and the offset is 3, the service will attempt to match against Goo abc. If no offset is supplied, the service will use the whole term. The offset should generally be set to the position of the text caret.
The origin point from which to calculate straight-line distance to the destination (returned as distance_meters). If this value is omitted, straight-line distance will not be returned. Must be specified as latitude,longitude.
The point around which to retrieve place information. This must be specified as latitude,longitude.
Defines the distance (in meters) within which to return place results. You may bias results to a specified circle by passing a location and a radius parameter. Doing so instructs the Places service to prefer showing results within that circle; results outside of the defined area may still be displayed.
The radius will automatically be clamped to a maximum value depending on the type of search and other parameters.
\nkeyword or name: 50,000 meterskeyword or namerankby parameter.rankby=distance, the radius parameter will not be accepted, and will result in an INVALID_REQUEST.You may restrict results from a Place Autocomplete request to be of a certain type by passing a types parameter. The parameter specifies a type or a type collection, as listed in the supported types below. If nothing is specified, all types are returned. In general only a single type is allowed. The exception is that you can safely mix the geocode and establishment types, but note that this will have the same effect as specifying no types. The supported types are:
\ngeocode instructs the Place Autocomplete service to return only geocoding results, rather than business results. Generally, you use this request to disambiguate results where the location specified may be indeterminate.address instructs the Place Autocomplete service to return only geocoding results with a precise address. Generally, you use this request when you know the user will be looking for a fully specified address.establishment instructs the Place Autocomplete service to return only business results.(regions) type collection instructs the Places service to return any result matching the following types:localitysublocalitypostal_codecountryadministrative_area_level_1administrative_area_level_2(cities) type collection instructs the Places service to return results that match locality or administrative_area_level_3.The language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.The Directions API is a web service that uses an HTTP request to return JSON or XML-formatted directions between locations. You can receive directions for several modes of transportation, such as transit, driving, walking, or cycling.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"(Required) The place ID, address, or textual latitude/longitude value to which you wish to calculate directions. The options for the destination parameter are the same as for the origin parameter.
\n","type":"text/plain"},"key":"destination","value":"Victoria, BC"},{"description":{"content":"(Required) The place ID, address, or textual latitude/longitude value from which you wish to calculate directions.
\nPlace IDs must be prefixed with place_id:. You can retrieve place IDs from the Geocoding API and the Places API (including Place Autocomplete). For an example using place IDs from Place Autocomplete, see Place Autocomplete and Directions. For more about place IDs, see the Place ID overview.
origin=place_id:ChIJ3S-JXmauEmsRUcIaWtf4MzE\nIf you pass an address, the Directions service geocodes the string and converts it to a latitude/longitude coordinate to calculate directions. This coordinate may be different from that returned by the Geocoding API, for example a building entrance rather than its center.
\norigin=24+Sussex+Drive+Ottawa+ON\nUsing place IDs is preferred over using addresses or latitude/longitude coordinates. Using coordinates will always result in the point being snapped to the road nearest to those coordinates - which may not be an access point to the property, or even a road that will quickly or safely lead to the destination.
\nIf you pass coordinates, the point will snap to the nearest road. Passing a place ID is preferred. If you do pass coordinates, ensure that no space exists between the latitude and longitude values.
\norigin=41.43206,-81.38992\nPlus codes must be formatted as a global code or a compound code. Format plus codes as shown here (plus signs are url-escaped to %2B and spaces are url-escaped to %20).
849VCWC8%2BR9). CWC8%2BR9%20Mountain%20View%20CA%20USA).Specifies the desired time of arrival for transit directions, in seconds since midnight, January 1, 1970 UTC. You can specify either departure_time or arrival_time, but not both. Note that arrival_time must be specified as an integer.
Specifies the desired time of departure. You can specify the time as an integer in seconds since midnight, January 1, 1970 UTC. If a departure_time later than 9999-12-31T23:59:59.999999999Z is specified, the API will fall back the departure_time to 9999-12-31T23:59:59.999999999Z. Alternatively, you can specify a value of now, which sets the departure time to the current time (correct to the nearest second). The departure time may be specified in two cases:
departure_time or arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time).departure_time to receive a route and trip duration (response field: duration_in_traffic) that take traffic conditions into account. The departure_time must be set to the current time or some time in the future. It cannot be in the past.If set to true, specifies that the Directions service may provide more than one route alternative in the response. Note that providing route alternatives may increase the response time from the server. This is only available for requests without intermediate waypoints. For more information, see the guide to waypoints.
Indicates that the calculated route(s) should avoid the indicated features. This parameter supports the following arguments:
\ntolls indicates that the calculated route should avoid toll roads/bridges.highways indicates that the calculated route should avoid highways.ferries indicates that the calculated route should avoid ferries.indoor indicates that the calculated route should avoid indoor steps for walking and transit directions.It's possible to request a route that avoids any combination of tolls, highways and ferries by passing multiple restrictions to the avoid parameter. For example:
\navoid=tolls|highways|ferries.\nSpecifies the unit system to use when displaying results.
\nDirections results contain text within distance fields that may be displayed to the user to indicate the distance of a particular \"step\" of the route. By default, this text uses the unit system of the origin's country or region.
\nFor example, a route from \"Chicago, IL\" to \"Toronto, ONT\" will display results in miles, while the reverse route will display results in kilometers. You may override this unit system by setting one explicitly within the request's units parameter, passing one of the following values:
\nmetric specifies usage of the metric system. Textual distances are returned using kilometers and meters.imperial specifies usage of the Imperial (English) system. Textual distances are returned using miles and feet.Specifies an array of intermediate locations to include along the route between the origin and destination points as pass through or stopover locations. Waypoints alter a route by directing it through the specified location(s). The API supports waypoints for these travel modes: driving, walking and bicycling; not transit. You can supply one or more locations separated by the pipe character (| or %7C), in the form of a place ID, an address, or latitude/longitude coordinates. By default, the Directions service calculates a route using the waypoints in the order they are given. The precedence for parsing the value of the waypoint is place ID, latitude/longitude coordinates, then address.
place_id:. You can retrieve place IDs from the Geocoding API and the Places API (including Place Autocomplete). For an example using place IDs from Place Autocomplete, see Place Autocomplete and Directions. For more about place IDs, see the Place ID overview.%2C) and not a space (%20) separates the latitude and longitude values.enc: and followed by a colon (:). For example: waypoints=enc:gfo}EtohhU:.|). For example, waypoints=via:enc:wc~oAwquwMdlTxiKtqLyiK:|enc:c~vnAamswMvlTor@tjGi}L:| via:enc:udymA{~bxM:For each waypoint in the request, the directions response appends an entry to the legs array to provide the details for stopovers on that leg of the journey.
If you'd like to influence the route using waypoints without adding a stopover, add the prefix via: to the waypoint. Waypoints prefixed with via: will not add an entry to the legs array, but will route the journey through the waypoint.
The following URL modifies the previous request such that the journey is routed through Lexington without stopping:
\nhttps://maps.googleapis.com/maps/api/directions/json?\norigin=Boston,MA&destination=Concord,MA\n&waypoints=Charlestown,MA|via:Lexington,MA \nThe via: prefix is most effective when creating routes in response to the user dragging the waypoints on the map. Doing so allows the user to see how the final route may look in real-time and helps ensure that waypoints are placed in locations that are accessible to the Directions API.
By default, the Directions service calculates a route through the provided waypoints in their given order. Optionally, you may pass optimize:true as the first argument within the waypoints parameter to allow the Directions service to optimize the provided route by rearranging the waypoints in a more efficient order. (This optimization is an application of the traveling salesperson problem.) Travel time is the primary factor which is optimized, but other factors such as distance, number of turns and many more may be taken into account when deciding which route is the most efficient. All waypoints must be stopovers for the Directions service to optimize their route.
If you instruct the Directions service to optimize the order of its waypoints, their order will be returned in the waypoint_order field within the routes object. The waypoint_order field returns values which are zero-based.
The following example calculates a road journey from Adelaide, South Australia to each of South Australia's main wine regions using route optimization.
\nhttps://maps.googleapis.com/maps/api/directions/json?\norigin=Adelaide,SA&destination=Adelaide,SA\n&waypoints=optimize:true|Barossa+Valley,SA|Clare,SA|Connawarra,SA|McLaren+Vale,SA\nInspection of the calculated route will indicate that calculation uses waypoints in the following waypoint order:
\n\"waypoint_order\": [ 3, 2, 0, 1 ]\nThe language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.For the calculation of distances and directions, you may specify the transportation mode to use. By default, DRIVING mode is used. By default, directions are calculated as driving directions. The following travel modes are supported:
driving (default) indicates standard driving directions or distance using the road network.walking requests walking directions or distance via pedestrian paths & sidewalks (where available).bicycling requests bicycling directions or distance via bicycle paths & preferred streets (where available).transit requests directions or distance via public transit routes (where available). If you set the mode to transit, you can optionally specify either a departure_time or an arrival_time. If neither time is specified, the departure_time defaults to now (that is, the departure time defaults to the current time). You can also optionally include a transit_mode and/or a transit_routing_preference.The region code, specified as a ccTLD (\"top-level domain\") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is \"uk\" (.co.uk) while its ISO 3166-1 code is \"gb\" (technically for the entity of \"The United Kingdom of Great Britain and Northern Ireland\").
\n","type":"text/plain"},"key":"region","value":"en"},{"disabled":true,"description":{"content":"Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration_in_traffic field in the response, which contains the predicted time in traffic based on historical averages. The traffic_model parameter may only be specified for driving directions where the request includes a departure_time. The available values for this parameter are:
best_guess (default) indicates that the returned duration_in_traffic should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.pessimistic indicates that the returned duration_in_traffic should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.optimistic indicates that the returned duration_in_traffic should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.\nThe default value of best_guess will give the most useful predictions for the vast majority of use cases. It is possible the best_guess travel time prediction may be shorter than optimistic, or alternatively, longer than pessimistic, due to the way the best_guess prediction model integrates live traffic information.Specifies one or more preferred modes of transit. This parameter may only be specified for transit directions. The parameter supports the following arguments:
\nbus indicates that the calculated route should prefer travel by bus.subway indicates that the calculated route should prefer travel by subway.train indicates that the calculated route should prefer travel by train.tram indicates that the calculated route should prefer travel by tram and light rail.rail indicates that the calculated route should prefer travel by train, tram, light rail, and subway. This is equivalent to transit_mode=train|tram|subway.Specifies preferences for transit routes. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API. This parameter may only be specified for transit directions. The parameter supports the following arguments:
\nless_walking indicates that the calculated route should prefer limited amounts of walking.fewer_transfers indicates that the calculated route should prefer a limited number of transfers.The Elevation API provides a simple interface to query locations on the earth for elevation data. Additionally, you may request sampled elevation data along paths, allowing you to calculate elevation changes along routes. With the Elevation API, you can develop hiking and biking applications, positioning applications, or low resolution surveying applications.
\nElevation data is available for all locations on the surface of the earth, including depth locations on the ocean floor (which return negative values). In those cases where Google does not possess exact elevation measurements at the precise location you request, the service interpolates and returns an averaged value using the four nearest locations. Elevation values are expressed relative to local mean sea level (LMSL).
\nRequests to the Elevation API utilize different parameters based on whether the request is for discrete locations or for an ordered path. For discrete locations, requests for elevation return data on the specific locations passed in the request; for paths, elevation requests are instead sampled along the given path.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Positional requests are indicated through use of the locations parameter, indicating elevation requests for the specific locations passed as latitude/longitude values.
\nThe locations parameter may take the following arguments:
\nlocations=40.714728,-73.998672locations=40.714728,-73.998672|-34.397,150.644\nlocations=enc:gfo}EtohhU\nLatitude and longitude coordinate strings are defined using numerals within a comma-separated text string. For example, \"40.714728,-73.998672\" is a valid locations value. Latitude and longitude values must correspond to a valid location on the face of the earth. Latitudes can take any value between -90 and 90 while longitude values can take any value between -180 and 180. If you specify an invalid latitude or longitude value, your request will be rejected as a bad request.
\nYou may pass any number of multiple coordinates within an array or encoded polyline, while still constructing a valid URL. Note that when passing multiple coordinates, the accuracy of any returned data may be of lower resolution than when requesting data for a single coordinate.
\n","type":"text/plain"},"key":"locations","value":"35,-100|40,-110"},{"disabled":true,"description":{"content":"An array of comma separated latitude,longitude strings.
Required if path parameter is set.
\n","type":"text/plain"},"key":"samples","value":"The Geocoding API is a service that provides geocoding and reverse geocoding of addresses.
\nGeocoding is the process of converting addresses (like a street address) into geographic coordinates (like latitude and longitude), which you can use to place markers on a map, or position the map.
\nReverse geocoding is the process of converting geographic coordinates into a human-readable address.
\nYou can also use the Geocoding API to find the address for a given place ID.
\nTo see countries currently supported by the Google Maps Platform Geocoding API, please consult the Google Maps coverage data. The accuracy of geocoded locations may vary per country, so you should consider using the returned location_type field to determine if a good enough match has been found for the purposes of your application. Please note that the availability of geocoding data depends on our contracts with data providers, so it is subject to change.
The street address or plus code that you want to geocode. Specify addresses in accordance with the format used by the national postal service of the country concerned. Additional address elements such as business names and unit, suite or floor numbers should be avoided. Street address elements should be delimited by spaces (shown here as url-escaped to %20):
address=24%20Sussex%20Drive%20Ottawa%20ON\nFormat plus codes as shown here (plus signs are url-escaped to %2B and spaces are url-escaped to %20):
849VCWC8+R9 is 849VCWC8%2BR9).CWC8+R9 Mountain View, CA, USA is CWC8%2BR9%20Mountain%20View%20CA%20USA).The bounding box of the viewport within which to bias geocode results more prominently. This parameter will only influence, not fully restrict, results from the geocoder.
\n","type":"text/plain"},"key":"bounds","value":"The bounding box of the viewport within which to bias geocode results more prominently. This parameter will only influence, not fully restrict, results from the geocoder.
\n","type":"text/plain"},"key":"bounds","value":"A components filter with elements separated by a pipe (|). The components filter is also accepted as an optional parameter if an address is provided. Each element in the components filter consists of a component:value pair, and fully restricts the results from the geocoder.
The components that can be filtered include:
\npostal_code matches postal_code and postal_code_prefix.country matches a country name or a two letter ISO 3166-1 country code. The API follows the ISO standard for defining countries, and the filtering works best when using the corresponding ISO code of the country.The following components may be used to influence results, but will not be enforced:
\nroute matches the long or short name of a route.locality matches against locality and sublocality types.administrative_area matches all the administrative_area levels.Notes about component filtering:
\nINVALID_REQUEST: countrypostal_coderouteZERO_RESULTS responses. Using Place Autocomplete may provide better results in some use cases. To learn more, see this FAQ.ZERO_RESULTS.The street address that you want to geocode, in the format used by the national postal service of the country concerned. Additional address elements such as business names and unit, suite or floor numbers should be avoided.
\n","type":"text/plain"},"key":"latlng","value":"A filter of one or more location types, separated by a pipe (|). If the parameter contains multiple location types, the API returns all addresses that match any of the types. A note about processing: The location_type parameter does not restrict the search to the specified location type(s). Rather, the location_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified location type(s). The following values are supported:
APPROXIMATE returns only the addresses that are characterized as approximate.GEOMETRIC_CENTER returns only geometric centers of a location such as a polyline (for example, a street) or polygon (region).RANGE_INTERPOLATED returns only the addresses that reflect an approximation (usually on a road) interpolated between two precise points (such as intersections). An interpolated range generally indicates that rooftop geocodes are unavailable for a street address.ROOFTOP returns only the addresses for which Google has location information accurate down to street address precision.A textual identifier that uniquely identifies a place, returned from a Place Search.\nFor more information about place IDs, see the place ID overview.
\n","type":"text/plain"},"key":"place_id","value":"A filter of one or more address types, separated by a pipe (|). If the parameter contains multiple address types, the API returns all addresses that match any of the types. A note about processing: The result_type parameter does not restrict the search to the specified address type(s). Rather, the result_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified address type(s).The following values are supported:
administrative_area_level_1 indicates a first-order civil entity below the country level. Within the United States, these administrative levels are states. Not all nations exhibit these administrative levels. In most cases, administrative_area_level_1 * short names will closely match ISO 3166-2 subdivisions and other widely circulated lists; however this is not guaranteed as our geocoding results are based on a variety of signals and location data.administrative_area_level_2 indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all nations exhibit these administrative levels.administrative_area_level_3 indicates a third-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.administrative_area_level_4 indicates a fourth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.administrative_area_level_5 indicates a fifth-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.airport indicates an airport.colloquial_area indicates a commonly-used alternative name for the entity.country indicates the national political entity, and is typically the highest order type returned by the Geocoder.intersection indicates a major intersection, usually of two major roads.locality indicates an incorporated city or town political entity.natural_feature indicates a prominent natural feature.neighborhood indicates a named neighborhoodpark indicates a named park.plus_code indicates an encoded location reference, derived from latitude and longitude. Plus codes can be used as a replacement for street addresses in places where they do not exist (where buildings are not numbered or streets are not named). See https://plus.codes/ for details.point_of_interest indicates a named point of interest. Typically, these \"POI\"s are prominent local entities that don't easily fit in another category, such as \"Empire State Building\" or \"Eiffel Tower\".political indicates a political entity. Usually, this type indicates a polygon of some civil administration.postal_code indicates a postal code as used to address postal mail within the country.premise indicates a named location, usually a building or collection of buildings with a common nameroute indicates a named route (such as \"US 101\").street_address indicates a precise street address.sublocality indicates a first-order civil entity below a locality. For some locations may receive one of the additional types: sublocality_level_1 to sublocality_level_5. Each sublocality level is a civil entity. Larger numbers indicate a smaller geographic area.subpremise indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a common nameThe language in which to return results.
\nlanguage is not supplied, the API attempts to use the preferred language as specified in the Accept-Language header.The region code, specified as a ccTLD (\"top-level domain\") two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some notable exceptions. For example, the United Kingdom's ccTLD is \"uk\" (.co.uk) while its ISO 3166-1 code is \"gb\" (technically for the entity of \"The United Kingdom of Great Britain and Northern Ireland\").
\n","type":"text/plain"},"key":"region","value":"en"}],"variable":[]}},"response":[{"id":"e8663058-0139-47e2-b3a3-8f30b7b968ea","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://apis.blobr.app/errlq9hab6lpcvsy/maps/api/geocode/json?address=1600 Amphitheatre Parkway, Mountain View, CA","host":["https://apis.blobr.app/errlq9hab6lpcvsy"],"path":["maps","api","geocode","json"],"query":[{"key":"address","value":"1600 Amphitheatre Parkway, Mountain View, CA","description":"The street address or plus code that you want to geocode. Specify addresses in accordance with the format used by the national postal service of the country concerned. Additional address elements such as business names and unit, suite or floor numbers should be avoided. Street address elements should be delimited by spaces (shown here as url-escaped to `%20`):\n\n```\naddress=24%20Sussex%20Drive%20Ottawa%20ON\n```\n\nFormat plus codes as shown here (plus signs are url-escaped to `%2B` and spaces are url-escaped to `%20`):\n- global code is a 4 character area code and 6 character or longer local code (`849VCWC8+R9` is `849VCWC8%2BR9`).\n- compound code is a 6 character or longer local code with an explicit location (`CWC8+R9 Mountain View, CA, USA` is `CWC8%2BR9%20Mountain%20View%20CA%20USA`).\n\nThe Street View Static API lets you embed a static (non-interactive) Street View panorama or thumbnail into your web page, without the use of JavaScript. The viewport is defined with URL parameters sent through a standard HTTP request, and is returned as a static image.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Determines the horizontal field of view of the image. The field of view is expressed in degrees, with a maximum allowed value of 120. When dealing with a fixed-size viewport, as with a Street View image of a set size, field of view in essence represents zoom, with smaller numbers indicating a higher level of zoom. Default is 90.
\n","type":"text/plain"},"key":"fov","value":"Indicates the compass heading of the camera. Accepted values are from 0 to 360 (both values indicating North, with 90 indicating East, and 180 South). If no heading is specified, a value will be calculated that directs the camera towards the specified location, from the point at which the closest photograph was taken.
\n","type":"text/plain"},"key":"heading","value":"The point around which to retrieve place information. The Street View Static API will snap to the panorama photographed closest to this location. When an address text string is provided, the API may use a different camera location to better display the specified location. When a lat/lng is provided, the API searches a 50 meter radius for a photograph closest to this location. Because Street View imagery is periodically refreshed, and photographs may be taken from slightly different positions each time, it's possible that your location may snap to a different panorama when imagery is updated.
A specific panorama ID. These are generally stable, though panoramas may change ID over time as imagery is refreshed.
\n","type":"text/plain"},"key":"pano","value":"Specifies the up or down angle of the camera relative to the Street View vehicle. This is often, but not always, flat horizontal. Positive values angle the camera up (with 90 degrees indicating straight up); negative values angle the camera down (with -90 indicating straight down). Default is 0.
\n","type":"text/plain"},"key":"pitch","value":"Sets a radius, specified in meters, in which to search for a panorama, centered on the given latitude and longitude. Valid values are non-negative integers. Default is 50 meters.
\n","type":"text/plain"},"key":"radius","value":"Indicates whether the API should return a non 200 Ok HTTP status when no image is found (404 NOT FOUND), or in response to an invalid request (400 BAD REQUEST). Valid values are true and false. If set to true, an error message is returned in place of the generic gray image. This eliminates the need to make a separate call to check for image availability.
A digital signature used to verify that any site generating requests using your API key is authorized to do so. Requests that do not include a digital signature might fail. For more information, see Get a Key and Signature.
\n","type":"text/plain"},"key":"signature","value":"(Required) Specifies the output size of the image in pixels. Size is specified as {width}x{height} - for example, size=600x400 returns an image 600 pixels wide, and 400 high.
Limits Street View searches to selected sources. Valid values are:
\ndefault uses the default sources for Street View; searches are not limited to specific sources.outdoor limits searches to outdoor collections. Indoor collections are not included in search results. Note that outdoor panoramas may not exist for the specified location. Also note that the search only returns panoramas where it's possible to determine whether they're indoors or outdoors. For example, PhotoSpheres are not returned because it's unknown whether they are indoors or outdoors.The Street View Static API metadata requests provide data about Street View panoramas. Using the metadata, you can find out if a Street View image is available at a given location, as well as getting programmatic access to the latitude and longitude, the panorama ID, the date the photo was taken, and the copyright information for the image. Accessing this metadata allows you to customize error behavior in your application.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"key"},{"key":"value","value":"Indicates the compass heading of the camera. Accepted values are from 0 to 360 (both values indicating North, with 90 indicating East, and 180 South). If no heading is specified, a value will be calculated that directs the camera towards the specified location, from the point at which the closest photograph was taken.
\n","type":"text/plain"},"key":"heading","value":"The point around which to retrieve place information. The Street View Static API will snap to the panorama photographed closest to this location. When an address text string is provided, the API may use a different camera location to better display the specified location. When a lat/lng is provided, the API searches a 50 meter radius for a photograph closest to this location. Because Street View imagery is periodically refreshed, and photographs may be taken from slightly different positions each time, it's possible that your location may snap to a different panorama when imagery is updated.
A specific panorama ID. These are generally stable, though panoramas may change ID over time as imagery is refreshed.
\n","type":"text/plain"},"key":"pano","value":"Specifies the up or down angle of the camera relative to the Street View vehicle. This is often, but not always, flat horizontal. Positive values angle the camera up (with 90 degrees indicating straight up); negative values angle the camera down (with -90 indicating straight down). Default is 0.
\n","type":"text/plain"},"key":"pitch","value":"Sets a radius, specified in meters, in which to search for a panorama, centered on the given latitude and longitude. Valid values are non-negative integers. Default is 50 meters.
\n","type":"text/plain"},"key":"radius","value":"Indicates whether the API should return a non 200 Ok HTTP status when no image is found (404 NOT FOUND), or in response to an invalid request (400 BAD REQUEST). Valid values are true and false. If set to true, an error message is returned in place of the generic gray image. This eliminates the need to make a separate call to check for image availability.
A digital signature used to verify that any site generating requests using your API key is authorized to do so. Requests that do not include a digital signature might fail. For more information, see Get a Key and Signature.
\n","type":"text/plain"},"key":"signature","value":"Specifies the output size of the image in pixels. Size is specified as {width}x{height} - for example, size=600x400 returns an image 600 pixels wide, and 400 high.
Limits Street View searches to selected sources. Valid values are:
\ndefault uses the default sources for Street View; searches are not limited to specific sources.outdoor limits searches to outdoor collections. Indoor collections are not included in search results. Note that outdoor panoramas may not exist for the specified location. Also note that the search only returns panoramas where it's possible to determine whether they're indoors or outdoors. For example, PhotoSpheres are not returned because it's unknown whether they are indoors or outdoors.