openapi: 3.0.3 info: title: Static Maps Service description: | The ArcGIS Static Maps service enables developers to easily create and embed map images into websites or applications where an interactive map is not required. Developers can choose from a range of high-quality ArcGIS Basemaps that offer vector and satellite imagery formats, from the street level up to a worldwide scale. There are four types of map a developer can create: 1. A map highlighting a specific location such as a delivery address. See the `/with-point` endpoints. 2. A map displaying a set of locations. See the `/with-many-points` endpoints. 3. A map showing a polyline with start and end points. See the `/with-polyline` endpoints. 4. A map showing an area of interest. See the `/with-polygon` endpoints. Developers can control the color, size, and label of simple symbols, add padding around the map, and define the static map image size using any of the GET requests. Equivalent POST requests offer more customization options, such as: - adding customized SVG symbols - having more control over symbol labeling Each map image looks like an embedded map, but without user interaction or controls. Static Maps service capabilities enable easy visualization of simple location data. This is useful for cases where a clear image is needed, such as emergency response notifications, ride hailing, delivery receipts, and news articles. ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/a0c01490ec474cc4bd6268fd6abdda4d/data) version: 0.5.0-beta termsOfService: https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/ servers: - url: https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/{apiVersion} description: Production service endpoint. variables: apiVersion: description: Beta version of the static maps service. default: beta security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - name: Static Maps description: Endpoints which provide generated map images - name: Map attribution description: Endpoints which provide map attribution paths: /static-maps/arcgis/{arcgis-style}/with-point: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/LabelParam' - $ref: '#/components/parameters/ImageFormatParam' - $ref: '#/components/parameters/ImageHeightParam' - $ref: '#/components/parameters/ImageWidthParam' - $ref: '#/components/parameters/PaddingParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/SymbolHexColorParam' - $ref: '#/components/parameters/SymbolScaleParam' - $ref: '#/components/parameters/SymbolStyleParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/MapCenterXParam' - $ref: '#/components/parameters/MapCenterYParam' - $ref: '#/components/parameters/PointXParam' - $ref: '#/components/parameters/PointYParam' - $ref: '#/components/parameters/ZoomParam' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithPointGet x-arcgis-frontmatter: keywords: - static maps - with point summary: Returns a static map that displays an ArcGIS Basemap style and a single point. description: | ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/6805d76afa85469bba75f0aeab3dbb9e/data) Returns a static map that displays an ArcGIS Basemap style and a single WGS 84 point defined by the `pointX` and `pointY` parameters. The geographical extent of the map is defined by a `mapZoom` or `mapRadius` parameter. The point can be represented with a `pin`, `circle`, or `circle` marker symbol, that can be customized with a color and label. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. Choose this option if you want to: - display a symbol (pin or circle) in the centre of your static map. - place a label (A-Z, a-z, 1-9) on the symbol. - change the color and scale of the symbol. Choose the POST option if you want to: - display a custom symbol in the centre of your static map. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). post: security: - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' requestBody: required: true content: application/json: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using a simple or custom symbol. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPoint' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' examples: customSymbolMarkerById: $ref: '#/components/examples/withpoint-customSymbolMarkerById' simpleMarkerSymbol: $ref: '#/components/examples/withpoint-simpleMarkerSymbol' application/x-www-form-urlencoded: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using a simple or custom symbol. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPoint' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithPointPost x-arcgis-frontmatter: keywords: - static maps - with point summary: Returns a static map that displays an ArcGIS Basemap style and a single point. description: | ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/6805d76afa85469bba75f0aeab3dbb9e/data) Returns a static map that displays an ArcGIS Basemap style, with a point specified `WGS84` position, as defined by the `x` and `y` parameters. The geographical extent of the map is defined by a `radius` parameter. The center of the map can be highlighted using a `pin`, `circle`, or custom SVG 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, such as `campground`, 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 static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. The Post Body content type must be either: - JSON with content type of `application/json`, or - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`. You must supply an access token in the header for POST endpoints. Choose this option if you want to: - display a custom SVG symbol in the centre of your static map. Choose the GET option if you want to: - display a simple symbol in the centre of your static map. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). /static-maps/arcgis/{arcgis-style}/with-many-points: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/LabelsParam' - $ref: '#/components/parameters/ImageFormatParam' - $ref: '#/components/parameters/ImageHeightParam' - $ref: '#/components/parameters/ImageWidthParam' - $ref: '#/components/parameters/ManyPointParam' - $ref: '#/components/parameters/PaddingParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/SymbolHexColorParam' - $ref: '#/components/parameters/SymbolScaleParam' - $ref: '#/components/parameters/SymbolStyleParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/MapCenterXParam' - $ref: '#/components/parameters/MapCenterYParam' - $ref: '#/components/parameters/ZoomParam' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithManyPointsGet x-arcgis-frontmatter: keywords: - static maps - with many points summary: Returns a static map that displays an ArcGIS Basemap style and multiple points. description: | ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/2babdb30e9004a27a586fcb776066326/data) Returns a static map that displays an ArcGIS Basemap style for multiple `WGS84` points, as defined by the `PointFeature` type. The geographical extent of the static map is defined by the extent of the `points` along with `padding` values. The multiple locations can be highlighted by `pin` or `circle` symbols that can be customized by color, scale, and with a label. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. Choose this option if you want to: - display up to 10 points on your static map using the same simple `pin` or `circle` symbol, or no symbols at all. - label simple symbols with sequential numbers or letters. Choose the POST option if you want to: - display up to 1024 points using specific `pin`, `circle`, or custom symbols. - display only some points with a symbol. - provide custom labels for each `pin` or `circle` symbol. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). post: security: - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' requestBody: required: true content: application/json: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using multiple points. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicManyPoints' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' examples: customSymbolMarkerById: $ref: '#/components/examples/withmanypoints-customSymbolMarkerById' simpleMarkerSymbol: $ref: '#/components/examples/withmanypoints-simpleMarkerSymbol' application/x-www-form-urlencoded: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using multiple points. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPolyline' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithManyPointsPost x-arcgis-frontmatter: keywords: - static maps - with many points summary: Returns a static map that displays an ArcGIS Basemap style and multiple points. description: | ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/a0c01490ec474cc4bd6268fd6abdda4d/data) Returns a static map that displays an ArcGIS Basemap style for multiple `WGS84` points, as defined by the `Points` type. The geographical extent of the map is defined by the location of the points and a padding width. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. 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, such as `campground`, 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`. You must supply an access token in the header for POST endpoints. Choose this option if you want to: - display up to 1024 points using specific `pin`, `circle`, or custom symbols. - display only some points with a symbol. - provide custom labels for each `pin` or `circle` symbol. Choose the GET option if you want to: - display up to 10 points on your static map using the same simple `pin` or `circle` symbol, or no symbols at all. - label simple symbols with sequential numbers or letters. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). /static-maps/arcgis/{arcgis-style}/with-polyline: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/EndLabelParam' - $ref: '#/components/parameters/EndSymbolHexColorParam' - $ref: '#/components/parameters/EndSymbolParam' - $ref: '#/components/parameters/LineHexColorParam' - $ref: '#/components/parameters/LineStyleParam' - $ref: '#/components/parameters/LineWidthParam' - $ref: '#/components/parameters/ImageFormatParam' - $ref: '#/components/parameters/ImageHeightParam' - $ref: '#/components/parameters/ImageWidthParam' - $ref: '#/components/parameters/PaddingParam' - $ref: '#/components/parameters/PolylineParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/StartLabelParam' - $ref: '#/components/parameters/StartSymbolHexColorParam' - $ref: '#/components/parameters/StartSymbolParam' - $ref: '#/components/parameters/SymbolScaleParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/MapCenterXParam' - $ref: '#/components/parameters/MapCenterYParam' - $ref: '#/components/parameters/ZoomParam' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithPolylineGet x-arcgis-frontmatter: keywords: - static maps - with polyline summary: Returns a static map that displays an ArcGIS Basemap style and a polyline. description: | ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/ded259b343614ac89e5d0664f9d017e9/data) Returns a static map that displays an ArcGIS Basemap style and a polyline as defined by the `polyline` parameter. The geographical extent of the static map is defined by the extent of the polyline and a padding width. The start and end of the polyline can be highlighted using `startSymbolStyle` and `endSymbolStyle` parameters, respectively. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. Choose this option if you want to: - display a polyline with up to 10 vertices. - symbolize the start and end of the line using a simple symbol. Choose the POST option if you want to: - display a polyline with up to 1024 vertices. - display a polyline that has multiple paths. - symbolize the start and end points with simple or custom symbols. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). post: security: - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' requestBody: required: true content: application/json: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using polyline. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPolyline' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' examples: customSymbolMarkerById: $ref: '#/components/examples/withpolyline-customSymbolMarkerById' simpleMarkerSymbol: $ref: '#/components/examples/withpolyline-simpleMarkerSymbol' application/x-www-form-urlencoded: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using a polyline. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPolyline' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithPolylinePost x-arcgis-frontmatter: keywords: - static maps - with polyline summary: Returns a static map in an ArcGIS Basemap style displaying a polyline or path. description: | ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/ded259b343614ac89e5d0664f9d017e9/data) Returns a static map that displays an ArcGIS Basemap style and displays a polyline, as defined by the `paths` type. The geographical extent of the static map is defined by the extent of the polyline and a padding width. The start and end of the polyline can be highlighted using `startSymbol` and `endSymbol` parameters, respectively. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. 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, such as `campground`, 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 Post Body content type must be either: - JSON with content type of `application/json`, or - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`. You must supply an access token in the header for POST endpoints. Choose this option if you want to: - display a polyline with up to 1024 vertices. - display a polyline that has multiple paths. - symbolize the start and end points with simple or custom symbols. Choose the GET option if you want to: - display a polyline with up to 10 vertices. - symbolize the start and end of the line using a simple symbol. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). /static-maps/arcgis/{arcgis-style}/with-polygon: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/FillHexColorParam' - $ref: '#/components/parameters/FillStyleParam' - $ref: '#/components/parameters/ImageFormatParam' - $ref: '#/components/parameters/ImageHeightParam' - $ref: '#/components/parameters/ImageWidthParam' - $ref: '#/components/parameters/OutlineHexColorParam' - $ref: '#/components/parameters/OutlineStyleParam' - $ref: '#/components/parameters/OutlineWidthParam' - $ref: '#/components/parameters/PaddingParam' - $ref: '#/components/parameters/PolygonParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/MapCenterXParam' - $ref: '#/components/parameters/MapCenterYParam' - $ref: '#/components/parameters/ZoomParam' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithPolygonGet x-arcgis-frontmatter: keywords: - static maps - with polygon summary: Returns a static map in an ArcGIS Basemap style displaying a polygon or area of interest. description: | ![arcgis/streets](https://www.arcgis.com/sharing/rest/content/items/7b0b60c6c81e42ce82f61e33de2a5cbb/data) Returns a static map that displays an ArcGIS Basemap style with a polygon as defined by the `polygon` parameter. The geographical extent of the static map is defined by the extent of the polygon and a padding width. You can define the style and color of the polygon fill including its outline. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. Choose this option if you want to display a single-part polygon with up to 10 vertices. To display a polygon with up to 1024 vertices, choose the POST endpoint. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). post: security: - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' requestBody: required: true content: application/json: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using polygon. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPolygon' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' examples: WithPolygon: $ref: '#/components/examples/WithPolygon' application/x-www-form-urlencoded: schema: type: object additionalProperties: false description: | The input parameters for returning a static map using a polygon. required: - graphics properties: graphics: $ref: '#/components/schemas/GraphicPolygon' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' responses: '200': $ref: '#/components/responses/StaticMapResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleWithPolygonPost x-arcgis-frontmatter: keywords: - static maps - with polygon summary: Returns a static map in an ArcGIS Basemap style displaying a polygon or area of interest. description: | ![arcgis/streets](https://www.arcgis.com/sharing/rest/content/items/6af172c6dc1d40a88989be1aa17d2389/data) Returns a static map that displays an ArcGIS Basemap style with a polygon or area of interest, as defined by the `polygon` parameter. The geographical extent of the static map is defined by the extent of the polygon and a padding width. You can define the style and color of the polygon fill including its outline. The static map image width and height can be defined, along with the image format, which can be `png`, `jpeg`, or `webp`. The Post Body content type must be either: - JSON with content type of `application/json`, or - form URL encoded key-value pairs with content type `application/x-www-form-urlencoded`. You must supply an access token in the header for POST endpoints. Choose this option if you want to display a single-part polygon with up to 1024 vertices. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). /static-maps/arcgis/{arcgis-style}/attribution: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Map attribution parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/FormatParam' - $ref: '#/components/parameters/TokenParam' responses: '200': $ref: '#/components/responses/AttributionResponse' '400': $ref: '#/components/responses/InvalidQueryErrorResponse' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ResourcePermissionErrorResponse' 5XX: $ref: '#/components/responses/ServerErrorResponse' operationId: BasemapStyleAttributionGet x-arcgis-frontmatter: keywords: - attribution summary: Returns the attribution for an ArcGIS Basemap style. description: | Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). components: securitySchemes: ArcGISTokenParameter: type: apiKey in: query name: token description: | The authentication token, used to access the static maps service. The `token` parameter can be either an API Key or short-lived token. This parameter is required _unless_ you supply an access token in the request header with one of the following keys using the "Bearer" scheme: - `Authorization: Bearer ` - `X-Esri-Authorization: Bearer ` The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `portal:user:allowBetaAccess` privilege to use the static maps service. **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/). ArcGISXEsriAuthorizationHeader: type: http scheme: bearer bearerFormat: 'X-Esri-Authorization: Bearer ' description: | The authentication token, used to access the static maps service. The token can be either an API Key or short-lived token. Supply the token in the request header using the "Bearer" scheme: `X-Esri-Authorization: Bearer ` The token must be created from an ArcGIS Location Platform account and have the necessary `portal:user:allowBetaAccess` privilege to use the static maps service. **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/). ArcGISAuthorizationHeader: type: http scheme: bearer bearerFormat: 'Authorization: Bearer ' description: | The authentication token, used to access the static maps service. The token can be either an API Key or short-lived token. Supply the token in the request header using the "Bearer" scheme: `Authorization: Bearer ` The token must be created from an ArcGIS Location Platform account and have the necessary `portal:user:allowBetaAccess` privilege to use the static maps service. **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/). parameters: BasemapStyleParam: name: arcgis-style in: path schema: type: string enum: - streets - streets-night - navigation - navigation-night - imagery example: streets required: true description: | The name of a style from the ArcGIS Basemap style family. | Group | Style | Example | Description | Data attribution | |--- | --- | ---| --- | ---| | Streets | navigation | ![navigation](https://www.arcgis.com/sharing/rest/content/items/78c096abedb9498380f5db1922f96aa0/info/thumbnail/thumbnail1659480881868.png) | A custom navigation style designed for use during daylight hours | Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community | | Streets | navigation-night | ![navigation-night](https://www.arcgis.com/sharing/rest/content/items/77073a29526046b89bb5622b6276e933/info/thumbnail/thumbnail1659480999259.png) | A custom navigation style designed for use in hours of darkness | Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community | | Streets | streets | ![streets](https://www.arcgis.com/sharing/rest/content/items/e3e6df1d2f6a485d8a70f28fdd3ce19e/info/thumbnail/thumbnail1626360997976.jpeg) | A classic Esri street map style designed for use during daylight hours | Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community | | Streets | streets-night | ![streets-night](https://www.arcgis.com/sharing/rest/content/items/b22e146f927e413c92f75b5e4614354a/info/thumbnail/thumbnail1659481791228.png) | A classic Esri street map style designed for use in hours of darkness | Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community | | Satellite | imagery | ![imagery](https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png) | Low-resolution satellite imagery for the world and high-resolution satellite and aerial imagery, typically within 3-5 years of currency, for most of the world. | Esri, Vantor, GeoEye, Earthstar Geographics, CNES/Airbus DS, USDA, USGS, AeroGRID, IGN, © OpenStreetMap contributors, TomTom, Garmin, FAO, NOAA, and the GIS User Community | LabelParam: name: symbolLabel in: query schema: $ref: '#/components/schemas/SymbolLabel' required: false description: | The label to be displayed on the marker symbol. The label can be a maximum of two letters or numbers from a-z, A-Z, or 0-9. example: A ImageFormatParam: name: imageFormat in: query schema: $ref: '#/components/schemas/ImageFormat' required: false description: The format in which the map image is returned. Supported formats include png, jpeg, and webp. example: png ImageHeightParam: name: imageHeight in: query schema: $ref: '#/components/schemas/ImageDimension' required: false description: The height of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. example: 400 ImageWidthParam: name: imageWidth in: query schema: $ref: '#/components/schemas/ImageDimension' description: The width of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. required: false example: 400 PaddingParam: name: imagePadding in: query schema: $ref: '#/components/schemas/Padding' required: false description: | 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: | Number of values in the array | Description | Example | |--- | --- | ---| | One | The same padding % is applied to all four sides.| [10] | | Two | The first value applies padding to the top and bottom, the second to the left and right sides. | [10, 5 ] | | Three | The first value applies padding to the top, the second to the left and right sides, and the third to the bottom.| [10, 20, 10] | Four | The four values apply padding to the top, right, bottom, and left in a clockwise order.| [10, 5, 5, 20] If padding is not specified, a value of 10% is applied to all sides. The maximum allowed padding value is 25% example: - 10 - 20 - 20 - 10 RadiusParam: name: mapRadius in: query schema: $ref: '#/components/schemas/RadiusDistance' example: 1000 description: | The radius, in meters, that defines the minimum geographic area shown around the specified point on the static map. ***Note:*** `mapZoom` and `mapRadius` are mutually exclusive. Please only choose one or the other. The `mapRadius` 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. | Radius (meters) | Approximate extent (diameter) | Typical map usage | Zoom | |----------------|-------------------------------|-------------------------|------------| | 10 | ~20 m | Building / site | 22–23 | | 100 | ~200 m | Street / block | 18–19 | | 1,000 | ~2 km | Neighborhood / district | 15–16 | | 10,000 | ~20 km | City | 12–13 | | 100,000 | ~200 km | Metro / region | 9–10 | | 1,000,000 | ~2,000 km | State / large region | 6–7 | The `mapRadius` has a minimum value of 10 meters and a maximum value of 20,000,000 meters. SymbolHexColorParam: name: symbolColor in: query description: | The color of the marker symbol in hexadecimal format. It has the form `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. schema: $ref: '#/components/schemas/HexColor' example: 0000FF SymbolScaleParam: name: symbolScale in: query schema: $ref: '#/components/schemas/SymbolScale' required: false description: | The scale of the marker 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. example: 1 SymbolStyleParam: name: symbolStyle in: query required: false description: | The style of the marker symbol. schema: type: string enum: - pin - circle - none default: none TokenParam: name: token in: query required: false description: | The authentication token, used to access the static maps service. The `token` parameter can be either an API Key or short-lived token. This parameter is required _unless_ you supply an access token in the request header with one of the following keys using the "Bearer" scheme: - `Authorization: Bearer ` - `X-Esri-Authorization: Bearer ` The provided `token` must be created from an ArcGIS Location Platform account and have the necessary `portal:user:allowBetaAccess` privilege to use the static maps service. **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/security-and-authentication/). schema: type: string MapCenterXParam: name: mapCenterX in: query schema: type: number format: double minimum: -179.9 maximum: 179.9 example: -117.1957 description: | The x-coordinate, or longitude value, of the point expressed in WGS84 decimal degrees. The value can be in the range of `-179.99` to `179.99`, representing the East/West or X-Axis. Setting this value will override the map extent which may result in you graphics not being visible in the map. MapCenterYParam: name: mapCenterY in: query schema: type: number format: double minimum: -85.05 maximum: 85.05 example: 34.0561 description: | The y-coordinate, or latitude value, of the point expressed in WGS84 decimal degrees. The value can be in the range of `-85.05` to `85.05`, representing the North/South or Y-Axis. Setting this value will override the extent of the map, which may result in your graphics not being displayed. PointXParam: name: pointX in: query schema: type: number format: double minimum: -179.9 maximum: 179.9 example: -117.1957 required: true description: | The x-coordinate, or longitude value, of the point expressed in WGS84 decimal degrees. The value can be in the range of `-179.99` to `179.99`, representing the East/West or X-Axis. PointYParam: name: pointY in: query schema: type: number format: double minimum: -85.05 maximum: 85.05 example: 34.0561 required: true description: | The y-coordinate, or latitude value, of the point expressed in WGS84 decimal degrees. The value can be in the range of `-85.05` to `85.05`, representing the North/South or Y-Axis. ZoomParam: name: mapZoom in: query schema: $ref: '#/components/schemas/ZoomLevel' example: 12 description: | Specifies the map zoom level, which controls the level of detail (LOD) displayed. Higher values show more detail over a smaller geographic extent, while lower values show larger areas with less detail. This parameter is typically used to control map rendering scale, tile selection, and feature visibility. This parameter is typically used to control map rendering scale, tile selection, and feature visibility. ***Note:*** `mapZoom` and `mapRadius` are mutually exclusive. Please only choose one or the other. LabelsParam: name: labelOption in: query required: false description: | The marker symbol can have a label showing a single letter or number. If the value is set to `letter`, a label of `A` is set on the marker symbol of the first point in the list of points. A label of `B` is set on the marker symbol of second point, up to the letter `I`. If the value is set to `number`, a label of `1` is set on the marker symbol of the first point in the list of points. A label of `2` is set on the marker symbol of second point, and so on up to the number `9`. If the value is set to `none`, no marker symbols will have labels. schema: type: string enum: - none - letter - number default: none ManyPointParam: name: points in: query schema: $ref: '#/components/schemas/ManyPointsGet' required: true description: | An array of points to be displayed on the static map. This is not a multipoint geometry type. The points are displayed using the same `symbolStyle`. The maximum number of coordinate pairs is 10. example: - - -117.1957 - 34.0561 - - -117.1942 - 34.0569 - - -117.1964 - 34.05685 - - -117.1945 - 34.0573 EndLabelParam: name: endSymbolLabel in: query schema: $ref: '#/components/schemas/SymbolLabel' required: false description: | The label to be displayed on the simple symbol at the end of a polyline. The label can be a maximum of two letters or numbers from a-z, A-Z, or 0-9. example: A EndSymbolHexColorParam: name: endSymbolColor in: query description: | The color of the end marker symbol 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`). schema: type: string minLength: 6 maxLength: 8 default: 007AC2 example: FF0000 EndSymbolParam: name: endSymbolStyle in: query required: false description: | The marker symbol that will be placed at the end of the last polyline part. It highlights the end of the polyline or path. This value can be `pin`, `circle`, `none` or not set. schema: $ref: '#/components/schemas/SymbolStyle' LineHexColorParam: name: lineColor in: query description: | The color of the line symbol in hexadecimal format. A hexadecimal color code takes the form `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. schema: $ref: '#/components/schemas/HexColor' example: 0000FF LineStyleParam: name: lineStyle in: query description: | The style, or stroke, of the line symbol. The default line style is `solid`. schema: $ref: '#/components/schemas/LineStyle' LineWidthParam: name: lineWidth in: query schema: type: integer minimum: 1 maximum: 16 default: 2 required: false description: | The width of the line in device-independent pixels. The minimum width is 1 and the maximum width is 16. example: 2 PolylineParam: name: polyline in: query required: true schema: $ref: '#/components/schemas/PathGeometryGet' description: | A polyline consists of a paths array, where each path is an array of x,y coordinate pairs (longitude, latitude) in the WGS 84 spatial reference. The first coordinate pair in the array represents the start of the polyline, while the last coordinate pair represents the end. The array can contain from 2 to 10 coordinate pairs. example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 StartLabelParam: name: startSymbolLabel in: query schema: $ref: '#/components/schemas/SymbolLabel' required: false description: | The label to be displayed on the simple symbol at the start of a polyline. The label can be a maximum of two letters or numbers from a-z, A-Z, or 0-9. example: A StartSymbolHexColorParam: name: startSymbolColor in: query description: | The color of the start marker symbol 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`). schema: type: string minLength: 6 maxLength: 8 default: 007AC2 example: 00FF00 StartSymbolParam: name: startSymbolStyle in: query required: false description: | The marker symbol that will be placed at the start of the first polyline part. It highlights the beginning of the polyline or path. This value can be `pin`, `circle`, `none` or not set. schema: $ref: '#/components/schemas/SymbolStyle' FillHexColorParam: name: fillColor in: query description: | The color of the fill in hexadecimal format. It has the form `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. schema: $ref: '#/components/schemas/HexColor' example: 0000FF FillStyleParam: name: fillStyle in: query required: false description: | The style of the fill. schema: type: string enum: - solid - none default: solid OutlineHexColorParam: name: outlineColor in: query description: | The color of the line symbol in hexadecimal format. A hexadecimal color code takes the form `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. schema: $ref: '#/components/schemas/HexColor' example: 0000FF OutlineStyleParam: name: outlineStyle in: query description: | The style, or stroke, of the outline of the polygon. The default line style is `solid`. schema: $ref: '#/components/schemas/LineStyle' OutlineWidthParam: name: outlineWidth in: query schema: type: integer minimum: 1 maximum: 16 default: 2 required: false description: | The width of the line in device-independent pixels. The minimum width is 1 and the maximum width is 16. example: 2 PolygonParam: name: polygon in: query required: true schema: $ref: '#/components/schemas/Ring' description: | An array of rings, where each ring is an array of x,y coordinate pairs (longitude, latitude) in the WGS 84 spatial reference that defines a polygon boundary The first coordinate pair in a ring represents the start of the polygon. Subsequent coordinates define the boundary of the polygon. These are arranged in a clockwise manner around the polygon. The last x,y coordinate pair will be connected to the first coordinate pair to close the polygon. The array can contain from 3 to 10 coordinate pairs. example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 FormatParam: name: f in: query description: Optional, case-sensitive parameter to specify the format in which responses are given. Can either be json or pjson. schema: type: string enum: - json - pjson default: json schemas: SymbolLabel: type: string pattern: ^[A-Za-z0-9]{1,2}$ minLength: 1 maxLength: 2 description: | A label to be displayed on the marker symbol. The label can be a maximum of two letters or numbers from a-z, A-Z, and 0-9. example: A ImageFormat: type: string enum: - png - jpeg - webp default: webp description: The format in which the map image is returned. Supported formats include png, jpeg, and webp. example: png ImageDimension: type: integer minimum: 64 maximum: 1024 default: 200 description: A dimension of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. example: 500 Padding: type: array items: minimum: 0 maximum: 25 type: integer minItems: 1 maxItems: 4 description: | 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: | Number of values in the array | Description | Example | |------------------------------ | ----------- | ---------| | One | The same padding % is applied to all four sides.| [10] | | Two | The first value applies padding to the top and bottom, the second to the left and right sides. | [10, 5 ] | | Three | The first value applies padding to the top, the second to the left and right sides, and the third to the bottom.| [10, 20, 10] | Four | The four values apply padding to the top, right, bottom, and left in a clockwise order.| [10, 5, 5, 20] If padding is not specified, a value of 10% is applied to all sides. The maximum allowed padding value is 25% default: - 10 example: - 10 - 0 - 10 - 20 RadiusDistance: type: number format: float description: | The radius, in meters, that defines the minimum geographic area shown around the specified point on the static map. ***Note:*** `mapZoom` and `mapRadius` are mutually exclusive. Please only choose one or the other. The `mapRadius` 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. | Radius (meters) | Approximate extent (diameter) | Typical map usage | Zoom | |----------------|-------------------------------|-------------------------|------------| | 10 | ~20 m | Building / site | 22 | | 100 | ~200 m | Street / block | 18–19 | | 1,000 | ~2 km | Neighborhood / district | 15–16 | | 10,000 | ~20 km | City | 12–13 | | 100,000 | ~200 km | Metro / region | 9–10 | | 1,000,000 | ~2,000 km | State / large region | 6–7 | The `radius` has a minimum value of 10 meters and a maximum value of 20,000,000 meters. minimum: 10 maximum: 20000000 example: 1000 HexColor: type: string pattern: ^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$ minLength: 6 maxLength: 8 default: 007AC2 description: | The color of the marker symbol 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`). SymbolScale: type: number format: float minimum: 0.1 maximum: 4 default: 1 description: | The scale of the marker 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. example: 1 ZoomLevel: type: integer minimum: 0 maximum: 22 description: Specifies the map zoom level, which determines the level of detail (LOD) displayed. 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. example: 12 Error: type: object required: - error properties: error: description: Error information type: object required: - code - message properties: code: description: A code identifying the type of error, either an HTTP error code, `498` (signifying invalid or expired token), or `499` (signifying missing token). type: integer example: 400 enum: - 400 - 401 - 403 - 404 - 498 - 499 - 500 message: description: A message describing the error. type: string minLength: 1 details: description: List of details about the error. type: array items: type: string restInfoUrl: description: URL that provides the static maps service information. type: string example: https://static-maps-api.arcgis.com/arcgis/rest/info CustomSymbols: description: | `customSymbols` is a dictionary of key-value pairs, where each pair defines a custom symbol to be added to the map. 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:[][;base64],`, as specified [here](https://developer.mozilla.org/en-US/docs/Web/URI/Reference/Schemes/data). 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](https://github.com/Esri/calcite-point-symbols) repository or the Esri developer [Place icons](https://developers.arcgis.com/documentation/mapping-and-location-services/place-finding/place-icons/#place-icons) site. The maximum length of the base64‑encoded data URL string is 4000 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. type: object additionalProperties: type: string minLength: 27 maxLength: 4000 example: parkEntrance: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+ campground: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+ Wkid: type: integer description: | 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. enum: - 4326 example: 4326 default: 4326 SpatialReference: type: object properties: wkid: $ref: '#/components/schemas/Wkid' description: | The spatial reference of the geometry. The spatial reference must always be WGS84 (wkid = 4326). example: wkid: 4326 PointGeometry: type: object description: An x,y (lon, lat) coordinate pair in the WGS84 spatial reference. required: - x - y properties: x: type: number description: An x-coordinate, or longitude, in WGS84 decimal degrees. y: type: number description: A y-coordinate, or latitude, in WGS84 decimal degrees. spatialReference: $ref: '#/components/schemas/SpatialReference' example: x: -117.1957 y: 34.0561 spatialReference: wkid: 4326 SymbolOffsetX: type: integer description: | 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. minimum: -512 maximum: 512 default: 0 SymbolOffsetY: type: integer description: | 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. minimum: -512 maximum: 512 default: 0 CustomMarkerSymbol: description: | The custom marker 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, such as `campground`, 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`. type: object properties: customSymbolId: type: string description: The key to a base64-encoded data url string for an SVG image in the `CustomSymbols` dictionary. example: campground pattern: ^[a-z0-9_-]+$ maxLength: 30 minLength: 1 scale: $ref: '#/components/schemas/SymbolScale' offsetX: $ref: '#/components/schemas/SymbolOffsetX' offsetY: $ref: '#/components/schemas/SymbolOffsetY' SymbolStyle: description: | The style of the marker symbol can be `pin` or `circle`. type: string enum: - pin - circle - none example: pin default: none SimpleMarkerSymbol: type: object description: | The simple marker symbol can have a colored `pin` or `circle` style. It can be labeled and scaled, as required. properties: style: $ref: '#/components/schemas/SymbolStyle' scale: $ref: '#/components/schemas/SymbolScale' color: $ref: '#/components/schemas/HexColor' label: $ref: '#/components/schemas/SymbolLabel' offsetX: $ref: '#/components/schemas/SymbolOffsetX' offsetY: $ref: '#/components/schemas/SymbolOffsetY' PointAndSymbol: type: object description: | The point geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker 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, such as `campground`, 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`. required: - geometry properties: geometry: $ref: '#/components/schemas/PointGeometry' symbol: description: The symbol can be a simple marker symbol or a custom marker symbol. oneOf: - $ref: '#/components/schemas/CustomMarkerSymbol' - $ref: '#/components/schemas/SimpleMarkerSymbol' GraphicPoint: type: object description: | The point geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol. required: - point properties: customSymbols: $ref: '#/components/schemas/CustomSymbols' point: $ref: '#/components/schemas/PointAndSymbol' Image: type: object description: | Define the width, height and format of the requested static map image. properties: width: $ref: '#/components/schemas/ImageDimension' height: $ref: '#/components/schemas/ImageDimension' format: $ref: '#/components/schemas/ImageFormat' padding: $ref: '#/components/schemas/Padding' Map: type: object description: | Represents the visible extent 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. ***Note:*** `mapZoom` and `mapRadius` are mutually exclusive. properties: radius: $ref: '#/components/schemas/RadiusDistance' zoom: $ref: '#/components/schemas/ZoomLevel' center: $ref: '#/components/schemas/PointGeometry' ManyPointsGet: type: array description: | An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with their associated symbol definitions. The symbol can be a simple marker symbol or a custom marker 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, such as `campground`, 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`. required: - manyPoints properties: manyPoints: type: array description: | An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with a symbol for the point. The array can contain from 1 to 10 coordinate pairs and symbols. items: $ref: '#/components/schemas/PointAndSymbol' minItems: 1 maxItems: 10 GraphicManyPoints: type: object description: | The manyPoints geometry and its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol. required: - manyPoints properties: customSymbols: $ref: '#/components/schemas/CustomSymbols' manyPoints: type: array description: | An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference along with a symbol for the point. items: $ref: '#/components/schemas/PointAndSymbol' minItems: 1 maxItems: 10 CoordGeometry: type: array items: type: number format: double description: | The x (longitude) and y (latitude) coordinate pair in the WGS84 spatial reference. - longitude in the range `-179.99` to `179.99` representing the east/west or x-axis - latitude in the range `-85.05` to `85.05` representing the north/south or y-axis minItems: 2 maxItems: 2 example: - -117.1957 - 34.0561 PathGeometry: type: array items: $ref: '#/components/schemas/CoordGeometry' description: | A path is an array of x,y (lon, lat) coordinate pairs in the WGS84 spatial reference. minItems: 2 Paths: type: array description: | An array 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 paths can contain between 2 and 1024 coordinate pairs across all paths. minItems: 2 items: $ref: '#/components/schemas/PathGeometry' example: - - - -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 Polyline: type: object description: | 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`, while the start and end points are represented by the `startSymbol` and `endSymbol`, respectively. The polyline can contain from 2 to 1024 coordinate pairs that can be defined in one or more paths. required: - paths properties: paths: $ref: '#/components/schemas/Paths' spatialReference: $ref: '#/components/schemas/SpatialReference' LineStyle: type: string enum: - solid - dash - dot description: | The style, or stroke, to apply to the line symbol. The default line style is `solid`. example: solid default: solid LineWidth: type: integer minimum: 1 maximum: 16 default: 2 description: | The width of the line in device-independent pixels. The minimum width is 1 and the maximum width is 16. example: 2 LineSymbol: type: object description: The properties that define the width, style, and color of a line. properties: style: $ref: '#/components/schemas/LineStyle' color: $ref: '#/components/schemas/HexColor' width: $ref: '#/components/schemas/LineWidth' PolylineStyle: type: object description: | The symbols associated with the polyline's line, start, and end points. The start and end symbols can either be simple marker symbols or custom marker symbols. 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, such as `campground`, 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: startSymbol: description: The symbol displayed at the start of the polyline. It can be a simple marker symbol or a custom marker symbol. oneOf: - $ref: '#/components/schemas/CustomMarkerSymbol' - $ref: '#/components/schemas/SimpleMarkerSymbol' endSymbol: description: The symbol displayed at the start of the polyline. It can be a simple marker symbol or a custom marker symbol. oneOf: - $ref: '#/components/schemas/CustomMarkerSymbol' - $ref: '#/components/schemas/SimpleMarkerSymbol' lineSymbol: $ref: '#/components/schemas/LineSymbol' GraphicPolyline: type: object description: | The polyline geometry and polyline style with its associated symbol. The symbol can be a simple marker symbol or a custom marker symbol. required: - polyline properties: customSymbols: $ref: '#/components/schemas/CustomSymbols' polyline: $ref: '#/components/schemas/Polyline' polylineStyle: $ref: '#/components/schemas/PolylineStyle' PathGeometryGet: type: array description: | An array x,y (lon, lat) coordinate pairs in the WGS84 spatial reference that define a path. The array can contain from 2 to 10 coordinate pairs. minItems: 2 maxItems: 10 items: $ref: '#/components/schemas/CoordGeometry' example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 Ring: type: array description: | An array of x,y (lon, lat) 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. At this release, only one ring is supported. A ring can contain between 3 and 1024 coordinate pairs. minItems: 3 items: $ref: '#/components/schemas/CoordGeometry' example: - - - -117.247962 - 34.105095 - - -117.244321 - 34.106745 - - -117.209646 - 34.106204 - - -117.208757 - 34.105251 Rings: type: array description: | 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 1024 coordinate pairs. minItems: 1 items: $ref: '#/components/schemas/Ring' example: - - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 - - -117.244321 - 34.106745 - - -117.209646 - 34.106204 - - -117.208757 - 34.105251 FillStyle: type: string enum: - solid - none description: | The style of the fill. The default line style is `solid`. example: solid default: solid PolygonSymbol: type: object description: | The properties that define the style, color, and outline of the polygon. properties: style: $ref: '#/components/schemas/FillStyle' color: $ref: '#/components/schemas/HexColor' outline: $ref: '#/components/schemas/LineSymbol' RingStyle: type: object description: | The properties that define the style, color, and outline of the polygon. properties: polygonSymbol: $ref: '#/components/schemas/PolygonSymbol' GraphicPolygon: type: object description: | The ring geometry and its associated ring style. required: - polygon properties: polygon: $ref: '#/components/schemas/Rings' ringStyle: $ref: '#/components/schemas/RingStyle' Attribution: type: object description: | The map's attribution information. Please note that the ArcGIS Basemap style attribution statement must be displayed every time the static map is visible. It must be positioned very close to the static map, or it can be provided via a popup or menu if the static map is embedded in an application or website. The relevant attribution statement for an ArcGIS Basemap style is available from the `/static-maps/arcgis/{arcgis-style}/attribution` endpoint. For more information see the `ArcGIS Location Platform Agreement` on the [Terms of use](https://developers.arcgis.com/documentation/mapping-and-location-services/terms-of-use/). required: - attribution properties: attribution: type: string example: Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community. responses: StaticMapResponse: description: Static map in a desired image format. content: image/webp: schema: type: string format: binary image/jpeg: schema: type: string format: binary image/png: schema: type: string format: binary InvalidQueryErrorResponse: description: Invalid query parameters / Incorrect portal item type / Data URL parse failure. content: application/json: schema: $ref: '#/components/schemas/Error' UnauthorizedErrorResponse: description: Authentication Error. The API key or token is missing, invalid or expired. content: application/json: schema: $ref: '#/components/schemas/Error' ResourcePermissionErrorResponse: description: The requested resource cannot be accessed because of incorrect sharing permissions. content: application/json: schema: $ref: '#/components/schemas/Error' ResourceNotFoundErrorResponse: description: The requested resource cannot be found - this could be due to missing map data at the requested location and zoom level. content: application/json: schema: $ref: '#/components/schemas/Error' ServerErrorResponse: description: An error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/Error' AttributionResponse: description: Attribution for a map style. content: application/json: schema: $ref: '#/components/schemas/Attribution' examples: withpoint-customSymbolMarkerById: summary: Custom Marker Symbol value: graphics: point: geometry: x: -117.199 y: 34.0573 spatialReference: wkid: 4326 symbol: customSymbolId: parkEntrance scale: 1.5 customSymbols: parkEntrance: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+ image: width: 200 height: 200 format: webp padding: - 10 map: radius: 2000 withpoint-simpleMarkerSymbol: summary: Simple Marker Symbol value: graphics: point: geometry: x: -117.194769 y: 34.057289 spatialReference: wkid: 4326 symbol: style: pin scale: 1 color: 0000FF label: '3' map: radius: 2000 image: width: 200 height: 200 format: webp padding: - 10 - 20 - 20 - 10 withmanypoints-customSymbolMarkerById: summary: Custom Marker Symbol value: graphics: manyPoints: - geometry: x: -117.194769 y: 34.057289 spatialReference: wkid: 4326 symbol: customSymbolId: parkEntrance scale: 1 - geometry: x: -117.21 y: 34.06 spatialReference: wkid: 4326 symbol: customSymbolId: campground scale: 1 customSymbols: parkEntrance: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+ campground: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+ image: width: 200 height: 200 format: webp padding: - 10 - 20 - 20 - 10 withmanypoints-simpleMarkerSymbol: summary: Simple Marker Symbol value: graphics: manyPoints: - geometry: x: -117.194769 y: 34.057289 spatialReference: wkid: 4326 symbol: style: pin scale: 1 color: 0000FF label: '1' - geometry: x: -117.21 y: 34.06 spatialReference: wkid: 4326 symbol: style: circle scale: 1 color: FF0000 label: '2' image: width: 200 height: 200 format: webp padding: - 10 - 20 - 20 - 10 withpolyline-customSymbolMarkerById: summary: Custom Marker Symbol value: graphics: polyline: 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 polylineStyle: startSymbol: customSymbolId: parkEntrance scale: 2 endSymbol: customSymbolId: campground scale: 2 lineSymbol: style: solid color: 0000FF width: 2 customSymbols: parkEntrance: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+ campground: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+ image: width: 200 height: 200 format: webp padding: - 10 - 20 - 20 - 10 withpolyline-simpleMarkerSymbol: summary: Simple Marker Symbol value: graphics: polyline: 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 polylineStyle: startSymbol: style: pin scale: 1 color: 00FF00 label: A endSymbol: style: pin scale: 1 color: FF0000 label: B lineSymbol: style: solid color: 0000FF width: 2 image: width: 200 height: 200 format: webp padding: - 25 - 10 - 10 - 10 WithPolygon: summary: With Polygon value: graphics: polygon: 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 ringStyle: polygonSymbol: style: solid color: FF0000 outline: style: solid color: 0000FF width: 2 image: width: 200 height: 200 format: webp padding: - 10 - 20 - 20 - 10