Get staticfilenameheightandwidth — geo-maps

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1455741.5 KB

This operation is not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

GetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots.

For more information, see the following topics in the Amazon Location Service Developer Guide:

get/static/{FileName}#height&width

Path parameters

FileNamestring required

The map scaling parameter to size the image, icons, and labels. It follows the pattern of <code>^map(@2x)?$</code>. Example: <code>map, map@2x</code>

Query parameters

bounding-boxstring password

Takes in two pairs of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image. Example: -123.17075,49.26959,-123.08125,49.31429

bounded-positionsstring password

Takes in two or more pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates. <note> Cannot be used with <code>Zoom</code> and or <code>Radius</code> </note> Example: 97.170451,78.039098,99.045536,27.176178

centerstring password

Takes in a pair of coordinates in World Geodetic System (WGS 84) format: [longitude, latitude], which becomes the center point of the image. This parameter requires that either zoom or radius is set. <note> Cannot be used with <code>Zoom</code> and or <code>Radius</code> </note> Example: 49.295,-123.108

color-scheme'Light' | 'Dark'

Sets the color tone for the map, such as dark and light. Example: <code>Light</code> Default value: <code>Light</code> <note> Valid values for <code>ColorScheme</code> are case sensitive. </note>

compact-overlaystring password

Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: <code>[Lon, Lat]</code> Example: <code>line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B</code> <note> Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon. </note>

crop-labelsboolean

It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

geojson-overlaystring password

Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object. Example: <code>{"type":"FeatureCollection","features": [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}</code>

heightinteger required

Specifies the height of the map image.

keystring password

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

label-size'Small' | 'Large'

Overrides the label size auto-calculated by <code>FileName</code>. Takes in one of the values - <code>Small</code> or <code>Large</code>.

langstring

Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language. Supported codes: <ul> <li> <code>ar</code> </li> <li> <code>as</code> </li> <li> <code>az</code> </li> <li> <code>be</code> </li> <li> <code>bg</code> </li> <li> <code>bn</code> </li> <li> <code>bs</code> </li> <li> <code>ca</code> </li> <li> <code>cs</code> </li> <li> <code>cy</code> </li> <li> <code>da</code> </li> <li> <code>de</code> </li> <li> <code>el</code> </li> <li> <code>en</code> </li> <li> <code>es</code> </li> <li> <code>et</code> </li> <li> <code>eu</code> </li> <li> <code>fi</code> </li> <li> <code>fo</code> </li> <li> <code>fr</code> </li> <li> <code>ga</code> </li> <li> <code>gl</code> </li> <li> <code>gn</code> </li> <li> <code>gu</code> </li> <li> <code>he</code> </li> <li> <code>hi</code> </li> <li> <code>hr</code> </li> <li> <code>hu</code> </li> <li> <code>hy</code> </li> <li> <code>id</code> </li> <li> <code>is</code> </li> <li> <code>it</code> </li> <li> <code>ja</code> </li> <li> <code>ka</code> </li> <li> <code>kk</code> </li> <li> <code>km</code> </li> <li> <code>kn</code> </li> <li> <code>ko</code> </li> <li> <code>ky</code> </li> <li> <code>lt</code> </li> <li> <code>lv</code> </li> <li> <code>mk</code> </li> <li> <code>ml</code> </li> <li> <code>mr</code> </li> <li> <code>ms</code> </li> <li> <code>mt</code> </li> <li> <code>my</code> </li> <li> <code>nl</code> </li> <li> <code>no</code> </li> <li> <code>or</code> </li> <li> <code>pa</code> </li> <li> <code>pl</code> </li> <li> <code>pt</code> </li> <li> <code>ro</code> </li> <li> <code>ru</code> </li> <li> <code>sk</code> </li> <li> <code>sl</code> </li> <li> <code>sq</code> </li> <li> <code>sr</code> </li> <li> <code>sv</code> </li> <li> <code>ta</code> </li> <li> <code>te</code> </li> <li> <code>th</code> </li> <li> <code>tr</code> </li> <li> <code>uk</code> </li> <li> <code>uz</code> </li> <li> <code>vi</code> </li> <li> <code>zh</code> </li> </ul>

paddinginteger

Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured. <note> Value for max and min is determined by: Min: <code>1</code> Max: <code>min(height, width)/4</code> </note> Example: <code>100</code>

political-viewstring password

Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format. The following political views are currently supported: <ul> <li> <code>ARG</code>: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands </li> <li> <code>EGY</code>: Egypt's view on Bir Tawil </li> <li> <code>IND</code>: India's view on Gilgit-Baltistan </li> <li> <code>KEN</code>: Kenya's view on the Ilemi Triangle </li> <li> <code>MAR</code>: Morocco's view on Western Sahara </li> <li> <code>RUS</code>: Russia's view on Crimea </li> <li> <code>SDN</code>: Sudan's view on the Halaib Triangle </li> <li> <code>SRB</code>: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands </li> <li> <code>SUR</code>: Suriname's view on the Courantyne Headwaters and Lawa Headwaters </li> <li> <code>SYR</code>: Syria's view on the Golan Heights </li> <li> <code>TUR</code>: Turkey's view on Cyprus and Northern Cyprus </li> <li> <code>TZA</code>: Tanzania's view on Lake Malawi </li> <li> <code>URY</code>: Uruguay's view on Rincon de Artigas </li> <li> <code>VNM</code>: Vietnam's view on the Paracel Islands and Spratly Islands </li> </ul>

pois'Enabled' | 'Disabled'

Determines if the result image will display icons representing points of interest on the map.

radiusinteger

Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value <code>>= 1</code>. Example: <code>1500</code> <note> Cannot be used with <code>Zoom</code>. </note> Unit: <code>Meters</code>

scale-unit'Kilometers' | 'KilometersMiles' | 'Miles' | 'MilesKilometers'

Displays a scale on the bottom right of the map image with the unit specified in the input. Example: <code>KilometersMiles, Miles, Kilometers, MilesKilometers</code>

style'Satellite' | 'Standard'

<code>Style</code> specifies the desired map style.

widthinteger required

Specifies the width of the map image.

zoomnumber float

Specifies the zoom level of the map image. <note> Cannot be used with <code>Radius</code>. </note>

Response

Success

Blobstring

The blob represents a map image as a <code>jpeg</code> for the <code>GetStaticMap</code> API.