Map with a polygon | Documentation

Build a URL to create a static map with polygon.

To display a polygon on a static mapA static map is a non-interactive map image generated by the ArcGIS Static Maps service that includes a basemap style and optional geometries such as points, polylines, and polygons.Learn more, use the /with-polygon endpoint from the ArcGIS Static Maps serviceThe ArcGIS Static Maps service, also known as Static Maps service, is a location service hosted by Esri that generates non-interactive map images called static maps. The service supports displaying a variety of basemap styles and optional geometries such as points, polylines, and polygons. No client-side mapping API is required.Learn more. Provide an array of rings in the polygon parameter, where each ring is defined by 3 to 10 x,y coordinate pairs that form the polygon boundary. You can also specify the polygon fill and outline colors. Additionally, specify the image width and height in pixels, along with the output format (png, jpeg, or webp).

How to display a static map with a polygon

The typical workflow to display a static map with a polygon is:

Map: Define the basemapStyle and map area with centerX andcenterY, and zoom or radius.
Geometry: Define the polygon array containing the rings with x,y coordinate pairs that define the polygon.
Image: Specify the image height and width in pixels, format, and attribution style.
Request: Send a GET request to the /with-polygon endpoint to generate the static map.

Service URL

Use dark colors for code blocksCopy
https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/v1/static-maps

Path parameters

These are required parameters to specify the style to access.

Use dark colors for code blocksCopy
https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/v1/static-maps/{basemapStyle}/with-polygon

Name	Description	Example
`{version}`	Required: The API version.	`v1`
`{basemapStyle}`	Required: The basemap style for the static map.	`arcgis/navigation`, `arcgis/navigation-night`, `arcgis/imagery`, `arcgis/streets-night`, or `arcgis/streets`

Query parameters

Name	Type	Default value	Description
`token`	`string`		An access token with the static maps service privilege. To pass the token as an authorization header, see HTTP authorization headers.
`polygon`	`Ring`		An array of x,y coordinate pairs in the WGS84 spatial reference defining a polygon boundary. Accepts 3 to 10 coordinate pairs.
`fillColor`	`HexColor`	`007AC2`	Polygon fill color in hexadecimal format.
`fillStyle`	`string`	`solid`	Polygon fill style. Supported values include `solid` and `none`.
`format`	`ImageFormat`	`webp`	Output image format of the map. Supported formats include `png`, `jpeg`, and `webp`.
`height`	`ImageDimensionHeight`	`400`	Height of the map image in pixels. Values must be between `128` and `1024`.
`width`	`ImageDimensionWidth`	`400`	Width of the map image in pixels. Values must be between `128` and `1024`.
`outlineColor`	`HexColor`	`007AC2`	Polygon outline color in hexadecimal format.
`outlineStyle`	`LineStyle`	`solid`	Polygon outline stroke. Supported values include `solid`, `dash` and `dot`.
`outlineWidth`	`integer`	`4`	Polygon outline width in device-independent pixels. Values range from `1` to `16`.
`padding`	`ImagePadding`	`10`	Padding percentages around the map extent. Accepts an array of 1–4 values; default is `10` on all sides, maximum is `25`.
`centerX`	`number(double)`		X-coordinate of the map center in WGS84 decimal degrees. Values range from `-179.99` to `179.99`.
`centerY`	`number(double)`		Y-coordinate of the map center in WGS84 decimal degrees. Values range from `-85.05` to `85.05`.
`zoom`	`ZoomLevel`		A number that defines the level of detail of the map. Values range from `0` to `22`.
`radius`	`RadiusDistance`		A number (in meters) that defines the minimum geographic area around a center point of the map. If no center point is supplied, the radius is applied to the geometry. Values range from `10` to `20,000,000`.
`attribution`	`string`	`auto`	Attribution footer style. To learn more about attribution requirements for static maps, see Esri and data attribution.
`referenceDetails`	`string`	`all`	A basemap option that controls the visibility of labels and feature symbology. This parameter is currently supported only for the `arcgis/imagery` style. Supported values include `all` and `none`.

Code examples

Display a polygon for a building footprint

Use the Static Maps service to display a static map with polygons highlighting the building footprints of Denver Health Hospital. This allows you to identify specific buildings and understand their layout. The map uses the ArcGIS Navigation basemap style.

Steps

Reference the service.
Set the API key in the Authorization request header using the Bearer authentication scheme.
Define the polygon array, fill and outline colors, and other parameters for the request.
Send the request to the Static Maps service to generate the static map.

JavaScript
Expand
Use dark colors for code blocksCopy
        const res = await fetch(
          `https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/v1/static-maps/${basemapStyle}/with-polygon?fillStyle=solid&format=png&height=250&width=500&outlineStyle=solid&outlineWidth=2&polygon=${polygon}&centerX=-104.99188&centerY=39.726894&zoom=15&fillColor=00509f1A&outlineColor=003366c2`,
          {
            method: "GET",
            headers: {
              Authorization: `Bearer ${accessToken}`,
            },
          }
        );

        const blob = await res.blob();
        const mapEl = document.getElementById("parkMap");
        mapEl.src = URL.createObjectURL(blob);
        mapEl.style.display = "block";
Expand

REST API

cURL

HTTP

Use dark colors for code blocksCopy
curl -X GET \
'https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/v1/static-maps/arcgis/navigation/with-polygon?fillStyle=solid&format=png&height=250&width=500&outlineStyle=solid&outlineWidth=2&polygon=[[-104.9920565,39.7287284],[-104.9920565,39.7281439],[-104.9916087,39.7281439],[-104.9916087,39.7285822],[-104.9918903,39.7287962],[-104.9920565,39.7287284]]&centerX=-104.991326&centerY=39.7280192&zoom=15&fillColor=00509f87&outlineColor=003366c2&token=<ACCESS_TOKEN>'
Run in Postman

Tutorials

Display a simple static map

Display a static map with a point, polyline, or polygon.

REST API Python JavaScript (Node)HTML