Types

Attribution

1
2
3
{
  "attribution": "Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community.\n"
}

The map's attribution information.

Esri and data attribution must be displayed whenever the static map is visible. Attribution should be placed near the map, or embed within the image or provided through a popup or menu if the map is embedded in an application or website.

The data attribution for an ArcGIS Basemap style can be retrieved from the /static-maps/arcgis/{arcgis-style}/attribution endpoint.

To learn more about attribution requirements for static maps, see Esri and data attribution.

Properties

BasemapOptions

1
2
3
{
  "referenceDetails": "all"
}

A collection of options to change how the basemap is displayed

Properties

Enumerated values

referenceDetails

Coordinates

1
2
3
4
[
  -117.1957,
  34.0561
]

The x (longitude) and y (latitude) coordinate pair in the WGS84 spatial reference.

• x coordinate in the range -179.99 to 179.99, representing longitude (east-west position).
• y coordinate in the range -85.05 to 85.05, representing latitude (north-south position).

CustomMarkerSymbol

1
2
3
4
5
6
{
  "customSymbolId": "campground",
  "scale": 1,
  "offsetX": 0,
  "offsetY": 0
}

The custom point symbol can display an SVG image that is stored in the CustomSymbols dictionary.

To use a custom SVG symbol, store the base64‑encoded data URL string representing the SVG image in the customSymbols property. This property is a dictionary, where the key is a unique string and the value is a base64‑encoded data URL string representing the SVG image. To symbolize a specific geometry with a custom symbol, pass the key to the customSymbolId.

Properties

Error

1
2
3
4
5
6
7
8
9
10
{
  "error": {
    "code": 400,
    "message": "string",
    "details": [
      "string"
    ],
    "restInfoUrl": "https://static-maps-api.arcgis.com/arcgis/rest/info"
  }
}

Properties

error properties

Enumerated values

code

FillStyle

1
"solid"

The style of the fill.

The default fill style is solid.

Type

string

Required

false

Restrictions

none

Default value

solid

Enumerated values

anonymous

HexColor

1
"007AC2"

Point symbol color in hexadecimal format.

It has the format RRGGBB or RRGGBBAA.

• RR is the red value
• GG is the green value
• BB is the blue value
• AA is the alpha value. 00 is fully transparent and FF is a solid fill.

For example, a semi-transparent red color is represented as FF000080. The default color is a medium-dark shade of blue (007AC2).

Type

string

Required

false

Restrictions

none

Default value

007AC2

Minimum length

6

Maximum length

8

Image

1
2
3
4
5
6
7
8
9
10
11
12
{
  "width": 500,
  "height": 500,
  "format": "png",
  "padding": [
    10,
    0,
    10,
    20
  ],
  "attribution": "auto"
}

The image object defines the image width, height, format, padding and attribution of the static map.

Height and width controls the image size between 128px to 1024px inclusive. Format controls the requested image format which can be either webp, png or jpeg.

Padding applied to the static map adds extra map content between the static map's extent and the edge of the image. Padding value is a % of the static map image's width and/or height.

Attribution defines the theme of the embed attribution within the map. This can be one either auto, dark, light or none.

Properties

ImageAttribution

1
"auto"

Attribution footer style. Values can be auto, light, dark or none. Learn more about attribution requirements in Esri and data attribution > Static maps.

• auto: Matches the attribution style to the map.
• light: Light background with dark text.
• dark: Dark background with light text.
• none: Displays only “Powered by Esri” without a background.

Type

string

Required

false

Restrictions

none

Default value

auto

Enumerated values

anonymous

ImageDimensionHeight

1
500

A dimension height of the requested map image in pixels at 96 DPI between 128 and 1024 pixels.

Type

integer

Required

false

Restrictions

none

Default value

400

Minimum

128

Maximum

1024

ImageDimensionWidth

1
500

A dimension width of the requested map image in pixels at 96 DPI between 128 and 1024 pixels.

Type

integer

Required

false

Restrictions

none

Default value

400

Minimum

128

Maximum

1024

ImageFormat

1
"png"

The format in which the map image is returned. Supported formats include png, jpeg, and webp.

Type

string

Required

false

Restrictions

none

Default value

webp

Enumerated values

anonymous

ImagePadding

1
2
3
4
5
6
[
  10,
  0,
  10,
  20
]

The padding applied to the static map adds extra map content between the static map's extent and the edge of the image.

Padding value is a % of the static map image's width and/or height. It is applied to the static map image, according to the table below:

If padding is not specified, a value of 10% is applied to all sides. The maximum allowed padding value is 25%

LineStyle

1
"solid"

The style, or stroke, to apply to the line symbol.

The default line style is solid.

Type

string

Required

false

Restrictions

none

Default value

solid

Enumerated values

anonymous

LineSymbol

1
2
3
4
5
{
  "style": "solid",
  "color": "007AC2",
  "width": 2
}

The properties that define the width, style, and color of a line.

Properties

LineWidth

1
2

Line width in device-independent pixels.

The minimum width is 1 and the maximum width is 16.

Type

integer

Required

false

Restrictions

none

Default value

2

Minimum

1

Maximum

16

ManyPointsGet

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  [
    -117.247325,
    34.100934
  ],
  [
    -117.247506,
    34.104433
  ],
  [
    -117.247962,
    34.105095
  ]
]

An array of x,y coordinate pairs defining a path in the WGS84 spatial reference. Accepts to 10 coordinate pairs.

Map

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "radius": 1000,
  "zoom": 12,
  "center": {
    "x": -117.1957,
    "y": 34.0561,
    "spatialReference": {
      "wkid": 4326
    }
  },
  "basemapOptions": {
    "referenceDetails": "all"
  }
}

A map view that specifies the center location and visible geographic area of the map.

This object specifies:

radius: The distance from the center point that determines the coverage area. zoom: The map zoom level controlling the scale and detail of the map. center: The geographic coordinates (latitude and longitude) of the focal point for the map.

zoom and radius are mutually exclusive.

Properties

Overlay

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "type": "string",
    "geometry": {
      "x": -117.1957,
      "y": 34.0561,
      "spatialReference": {
        "wkid": 4326
      }
    },
    "symbol": {
      "customSymbolId": "campground",
      "scale": 1,
      "offsetX": 0,
      "offsetY": 0
    }
  }
]

An array of geometries to display on the static map, including point, polyline, and/or polygon. Supports up to 64 geometries.

Each geometry can define its own symbol and label. Point geometries support either default marker symbols or custom SVG marker symbols referenced from symbolDictionary, while polyline and polygon geometries define their own line and fill styles.

The display order of geometries is determined first by geometry type: points are drawn above polylines, and polylines are drawn above polygons. Within each geometry type, geometries are drawn in the order they are added to the array, with the last geometry of that type drawn on top of the previous ones.

PathGeometry

1
2
3
4
5
6
7
8
9
10
[
  [
    -117.1957,
    34.0561
  ],
  [
    -117.1957,
    34.0561
  ]
]

An array of x,y coordinate pairs defining a polyline in the WGS84 spatial reference.

PathGeometryGet

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  [
    -117.247325,
    34.100934
  ],
  [
    -117.247506,
    34.104433
  ],
  [
    -117.247962,
    34.105095
  ]
]

An array of x,y coordinate pairs defining a path in the WGS84 spatial reference. Accepts 2 to 10 coordinate pairs.

Paths

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
[
  [
    [
      -117.247325,
      34.100934
    ],
    [
      -117.247506,
      34.104433
    ],
    [
      -117.247962,
      34.105095
    ]
  ],
  [
    [
      -117.247962,
      34.105095
    ],
    [
      -117.244321,
      34.106745
    ],
    [
      -117.209646,
      34.106204
    ],
    [
      -117.208757,
      34.105251
    ]
  ]
]

An array of polyline paths.

When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array.

The polyline can contain between 2 and 5000 coordinate pairs across all paths.

Point

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "type": "string",
  "geometry": {
    "x": -117.1957,
    "y": 34.0561,
    "spatialReference": {
      "wkid": 4326
    }
  },
  "symbol": {
    "customSymbolId": "campground",
    "scale": 1,
    "offsetX": 0,
    "offsetY": 0
  }
}

The point geometry and its associated symbol. The symbol can be a simple symbol or a custom symbol.

To use a custom SVG symbol, store the base64‑encoded data URL string representing the SVG image in the customSymbols property. This property is a dictionary, where the key is a unique string and the value is a base64‑encoded data URL string representing the SVG image. To symbolize a specific geometry with a custom symbol, pass the key to the customSymbolId.

Properties

PointGeometry

1
2
3
4
5
6
7
{
  "x": -117.1957,
  "y": 34.0561,
  "spatialReference": {
    "wkid": 4326
  }
}

An x,y coordinate pair in the WGS84 spatial reference.

Properties

Polygon

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "type": "string",
  "geometry": {
    "rings": [
      [
        [
          -117.247325,
          34.100934
        ],
        [
          -117.247506,
          34.104433
        ],
        [
          -117.247962,
          34.105095
        ],
        [
          -117.244321,
          34.106745
        ],
        [
          -117.209646,
          34.106204
        ],
        [
          -117.208757,
          34.105251
        ]
      ]
    ],
    "spatialReference": {
      "wkid": 4326
    }
  },
  "symbol": {
    "style": "solid",
    "color": "007AC2",
    "outline": {
      "style": "solid",
      "color": "007AC2",
      "width": 2
    }
  }
}

The polygon is represented as filled areas that is displayed on a static map.

Each polygon can consist of one or more rings, where each ring is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

The polygon can contain from 3 to 5000 coordinate pairs that can be defined in one or more paths.

Properties

PolygonGeometry

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
  "rings": [
    [
      [
        -117.247325,
        34.100934
      ],
      [
        -117.247506,
        34.104433
      ],
      [
        -117.247962,
        34.105095
      ],
      [
        -117.244321,
        34.106745
      ],
      [
        -117.209646,
        34.106204
      ],
      [
        -117.208757,
        34.105251
      ]
    ]
  ],
  "spatialReference": {
    "wkid": 4326
  }
}

An array of x,y coordinate pairs in the WGS84 spatial reference.

The first coordinate pair in a ring array represents the start of the area. Subsequent coordinates represent the vertices, in a clockwise manner, that define area boundary. The last x,y coordinate pair will be connected to the first coordinate pair to close the area.

A ring can contain between 3 and 5000 coordinate pairs.

Properties

Polyline

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
  "type": "string",
  "geometry": {
    "paths": [
      [
        [
          -117.247325,
          34.100934
        ],
        [
          -117.247506,
          34.104433
        ],
        [
          -117.247962,
          34.105095
        ]
      ],
      [
        [
          -117.247962,
          34.105095
        ],
        [
          -117.244321,
          34.106745
        ],
        [
          -117.209646,
          34.106204
        ],
        [
          -117.208757,
          34.105251
        ]
      ]
    ],
    "spatialReference": {
      "wkid": 4326
    }
  },
  "symbol": {
    "style": "solid",
    "color": "007AC2",
    "width": 2
  }
}

The polyline is represented as a line that is displayed on a static map.

Each polyline can consist of one or more paths, where each path is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array. The polyline starts at the first coordinate pair in the polyline's first path, and ends at the last coordinate pair in the polyline's last path. The polyline is displayed using the lineSymbol. The polyline can contain from 2 to 5000 coordinate pairs that can be defined in one or more paths.

Properties

PolylineGeometry

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "paths": [
    [
      [
        -117.247325,
        34.100934
      ],
      [
        -117.247506,
        34.104433
      ],
      [
        -117.247962,
        34.105095
      ]
    ],
    [
      [
        -117.247962,
        34.105095
      ],
      [
        -117.244321,
        34.106745
      ],
      [
        -117.209646,
        34.106204
      ],
      [
        -117.208757,
        34.105251
      ]
    ]
  ],
  "spatialReference": {
    "wkid": 4326
  }
}

The polyline is represented as a line that is displayed on a static map.

Each polyline can consist of one or more paths, where each path is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. When a polyline consists of more than one path, the polyline is contiguous only if the last point of each path matches the first point of the next path in the array. The polyline starts at the first coordinate pair in the polyline's first path, and ends at the last coordinate pair in the polyline's last path. The polyline is displayed using the lineSymbol. The polyline can contain from 2 to 5000 coordinate pairs that can be defined in one or more paths.

Properties

RadiusDistance

1
1000

The radius, in meters, that defines the minimum geographic area shown around the specified point on the static map.

zoom and radius are mutually exclusive. Use only one or the other.

The radius value is used to define the real world radius of the area displayed in the map image. The area covered by the radius will always be displayed on the static map image.

If the image width and height are equal, the static map image will be square and the geographic extent displayed by the static map image will match that defined by the radius. However, if the image width is greater than the height, the geographic extent displayed by the static map image will be wider than that defined by the radius.

As a guide, the following radius values can be used for the following types of static maps.

The radius has a minimum value of 10 meters and a maximum value of 20,000,000 meters.

Type

number(float)

Required

false

Restrictions

none

Minimum

10

Maximum

20000000

Ring

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
  [
    [
      -117.247962,
      34.105095
    ],
    [
      -117.244321,
      34.106745
    ],
    [
      -117.209646,
      34.106204
    ],
    [
      -117.208757,
      34.105251
    ]
  ]
]

An array of x,y coordinate pairs defining a polygon boundary in the WGS84 spatial reference.

Rings

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
[
  [
    [
      -117.247325,
      34.100934
    ],
    [
      -117.247506,
      34.104433
    ],
    [
      -117.247962,
      34.105095
    ],
    [
      -117.244321,
      34.106745
    ],
    [
      -117.209646,
      34.106204
    ],
    [
      -117.208757,
      34.105251
    ]
  ]
]

An array of rings that contain x,y (lon, lat) coordinate pairs in the WGS84 spatial reference.

Interior holes is not supported. The ring can contain between 3 and 5000 coordinate pairs.

RingSymbol

1
2
3
4
5
6
7
8
9
{
  "style": "solid",
  "color": "007AC2",
  "outline": {
    "style": "solid",
    "color": "007AC2",
    "width": 2
  }
}

The properties that define the style, color, and outline of the polygon.

Properties

SimpleMarkerSymbol

1
2
3
4
5
6
7
8
{
  "style": "circle",
  "scale": 1,
  "color": "007AC2",
  "label": "A",
  "offsetX": 0,
  "offsetY": 0
}

The simple symbol can have a colored pin, circle or square style. It can be labeled and scaled, as required.

Properties

SpatialReference

1
2
3
{
  "wkid": 4326
}

The spatial reference of the geometry.

The spatial reference must always be WGS84 (wkid = 4326).

Properties

SymbolDictionary

1
2
3
4
{
  "parkEntrance": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+",
  "campground": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+"
}

Dictionary of custom SVG marker symbols keyed by a unique ID. Values must be base64 data URLs referenced via customSymbolId.

The key is a unique string, such as campground or parkEntrance, and the value is a base64‑encoded data URL string representing the SVG image. To symbolize a specific geometry with a custom symbol, pass the key to the customSymbolId.

The general format of a base64‑encoded data URL string is data:[<mediatype>][;base64],<data>, as specified here.

To construct the data URL for an SVG image follow these steps:

1. Obtain the XML string from the SVG file.
2. Encode the XML string into base64 format.
3. Append the base64-formatted string to data:image/svg+xml;base64,.

There is a range of SVG symbols from ESRI available from the Calcite point symbols repository or the Esri developer Place icons site.

The maximum length of the base64‑encoded data URL string is 8000 characters.

Unsupported SVG Features

• SVG images must not reference external resources using URLs.
• Embedded raster images, such as png, jpeg, and webp formats, are not supported.
• SVG images that contain font-based text elements are not supported.
• It is recommended that text is converted into vector paths so that it can be rendered in custom symbols.

SymbolLabel

1
"A"

Label displayed on the point symbol.

The label can be a maximum of two letters or numbers from a-z, A-Z, and 0-9.

Type

string

Required

false

Restrictions

none

Minimum length

1

Maximum length

2

SymbolOffsetX

1
0

The offset rightward in pixels along the X-axis.

If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.

Type

integer

Required

false

Restrictions

none

Default value

0

Minimum

-512

Maximum

512

SymbolOffsetY

1
0

The offset downward in pixels along the Y-axis.

If the offset exceeds the bounds of the map, the symbol may be located outside of the resultant image.

Type

integer

Required

false

Restrictions

none

Default value

0

Minimum

-512

Maximum

512

SymbolScale

1
1

The scale of the point symbol as a multiplier of the symbol's dimensions.

A scale value less than 1.0 indicates that the symbol is scaled down, while a value greater than 1.0 indicates that the symbol is scaled up. For example, a scale of 0.5 will reduce the symbol's dimensions to half its original size. A scale of 2.0 will double the symbol's dimensions.

The minimum scale is 0.1 and the maximum scale is 4.0.

Type

number(float)

Required

false

Restrictions

none

Default value

1

Minimum

0.1

Maximum

4

SymbolStyle

1
"circle"

Point symbol style can be pin, circle, square or none.

If none is specified, the returned image will not display the requested points but the map extent will be automatically derived from the supplied point locations.

Type

string

Required

false

Restrictions

none

Default value

pin

Enumerated values

anonymous

Wkid

1
4326

The WKID (Well-Known ID) is a unique integer identifier used to define a specific spatial reference.

The wkid value of 4326, for WGS84, is currently the only supported WKID.

Type

integer

Required

false

Restrictions

none

Default value

4326

Enumerated values

anonymous

ZoomLevel

1
12

A number that defines the level of detail of the map. Valid values range from 0 to 22. Higher zoom values show more detailed features at a smaller geographic extent, while lower zoom values display broader areas with less detail. This parameter is typically used to control map rendering scale, tile selection, and feature visibility.

Type

integer

Required

false

Restrictions

none

Minimum

0

Maximum

22