openapi: 3.0.3 info: title: Static Maps Service description: | The ArcGIS Static Maps service enables developers to generate high-quality map images for websites, applications, reports, notifications, and other workflows where an interactive map is not required. Developers can choose from a range of ArcGIS basemaps, including vector and satellite imagery styles, and create static map images with custom dimensions, padding, overlays, and symbols. **Endpoints:** | Method | Endpoint | Description | | ------ | --------------- | ----------- | | GET | `/with-point` | Display a single point location using a simple marker symbol.| | GET | `/with-many-points` | Display multiple point locations on a single map using simple marker symbols. Max 10 coordinate pair. | | GET | `/with-polyline` | Display a single polyline geometry with optional start and end markers. Max 10 coordinate pair. | | GET | `/with-polygon` | Display a single polygon geometry representing an area of interest. Max 10 coordinate pair. | | POST | `/with-overlay` | Displays array of point, polyline and polygon geometry representing complex maps. Max 64 geometry type | Simple Maps (GET) is targeted for common mapping scenarios such as store locators, delivery receipts, property boundaries, and route previews. Complex Maps (POST) is targeted for advanced visualizations involving multiple geometries, service areas, GPS tracks, custom symbols, and branded maps. ![with-overlay](https://arcgis.com/sharing/rest/content/items/056cf1a43b904f16bed2126dad7d1021/data) version: 0.6.1-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-rc 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/TokenParam' - $ref: '#/components/parameters/XParam' - $ref: '#/components/parameters/YParam' - $ref: '#/components/parameters/ImageFormatParam' - $ref: '#/components/parameters/ImageHeightParam' - $ref: '#/components/parameters/ImageWidthParam' - $ref: '#/components/parameters/PaddingParam' - $ref: '#/components/parameters/SymbolHexColorParam' - $ref: '#/components/parameters/SymbolScaleParam' - $ref: '#/components/parameters/SymbolStyleParam' - $ref: '#/components/parameters/LabelParam' - $ref: '#/components/parameters/CenterXParam' - $ref: '#/components/parameters/CenterYParam' - $ref: '#/components/parameters/ZoomParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/ImageAttributionParam' - $ref: '#/components/parameters/ReferenceDetailsParam' 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: | ![with-point](https://text1.maps.arcgis.com/sharing/rest/content/items/26d77c751b2348a39311f7305d9cda8f/data) Returns a static map that displays an ArcGIS Basemap style and a single WGS84 point defined by the `x` and `y` parameters. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the point. You can control the geographical extent of the static map with padding values or by defining the `zoom` or `radius` parameter. The point can be represented with a `pin`, `circle`, `square` symbol or `none`, 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 simple symbol of a point. - Place a label (A-Z, a-z, 1-9) on the symbol. - Change the color and scale of the symbol. 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). /static-maps/arcgis/{arcgis-style}/with-many-points: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/ManyPointParam' - $ref: '#/components/parameters/LabelsParam' - $ref: '#/components/parameters/ImageFormatParam' - $ref: '#/components/parameters/ImageHeightParam' - $ref: '#/components/parameters/ImageWidthParam' - $ref: '#/components/parameters/PaddingParam' - $ref: '#/components/parameters/SymbolHexColorParam' - $ref: '#/components/parameters/SymbolScaleParam' - $ref: '#/components/parameters/SymbolStyleParam' - $ref: '#/components/parameters/CenterXParam' - $ref: '#/components/parameters/CenterYParam' - $ref: '#/components/parameters/ZoomParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/ImageAttributionParam' - $ref: '#/components/parameters/ReferenceDetailsParam' 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/da6f7db5b29c4a3cac25ab5179228dcf/data) Returns a static map that displays an ArcGIS Basemap style for multiple WGS84 points defined by the `points` parameter. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the points. You can control the geographical extent of the static map with padding values or by defining the `zoom` or `radius` parameter. The multiple locations can be highlighted with either `pin`, `circle`, `square` symbols or `none` 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`, `circle` or `square` symbol, or `none` - Label simple symbols with sequential numbers or letters. 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). /static-maps/arcgis/{arcgis-style}/with-polyline: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/PolylineParam' - $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/StartLabelParam' - $ref: '#/components/parameters/StartSymbolHexColorParam' - $ref: '#/components/parameters/StartSymbolParam' - $ref: '#/components/parameters/SymbolScaleParam' - $ref: '#/components/parameters/CenterXParam' - $ref: '#/components/parameters/CenterYParam' - $ref: '#/components/parameters/ZoomParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/ImageAttributionParam' - $ref: '#/components/parameters/ReferenceDetailsParam' 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: | ![with-polyline](https://arcgis.com/sharing/rest/content/items/17486b05ba7345d8a28895026a69c35f/data) Returns a static map that displays an ArcGIS Basemap style and a polyline as defined by the `polyline` parameter. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the polyline. You can control the geographical extent of the static map with padding values or by defining the zoom or radius parameter. 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. 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). /static-maps/arcgis/{arcgis-style}/with-polygon: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' - $ref: '#/components/parameters/TokenParam' - $ref: '#/components/parameters/PolygonParam' - $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/CenterXParam' - $ref: '#/components/parameters/CenterYParam' - $ref: '#/components/parameters/ZoomParam' - $ref: '#/components/parameters/RadiusParam' - $ref: '#/components/parameters/ImageAttributionParam' - $ref: '#/components/parameters/ReferenceDetailsParam' 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: | ![with-polygon](https://arcgis.com/sharing/rest/content/items/56870b8397a74aeab7909b145003dcc4/data) Returns a static map that displays an ArcGIS Basemap style with a polygon as defined by the `polygon` parameter. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the polygon. You can control the geographical extent of the static map with padding values or by defining the `zoom` or `radius` parameter. 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. 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). /static-maps/arcgis/{arcgis-style}/with-overlay: post: security: - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/BasemapStyleParam' requestBody: required: true content: application/json: schema: type: object additionalProperties: false description: | Defines the schema to request a static map that displays an ArcGIS Basemap style and an overlay with a mixture of points, polylines and polygons. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the supplied overlay geometry. If neither the center is defined or geometry is supplied then the service will return a `400` error code. You can control the geographical extent of the static map with padding values or by defining the zoom or radius parameter. properties: overlay: $ref: '#/components/schemas/Overlay' symbolDictionary: $ref: '#/components/schemas/SymbolDictionary' image: $ref: '#/components/schemas/Image' map: $ref: '#/components/schemas/Map' examples: singlePOI: $ref: '#/components/examples/SinglePOI' multiPOI: $ref: '#/components/examples/MultiPOI' polylineAndPoint: $ref: '#/components/examples/PolylineAndPoints' polygonAndPoint: $ref: '#/components/examples/PolygonAndPoints' application/x-www-form-urlencoded: schema: type: object additionalProperties: false description: | Defines the form to request a static map that displays an ArcGIS Basemap style and an overlay with a mixture of points, polylines and polygons. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the supplied overlay geometry. If neither the center is defined or geometry is supplied then the service will return a `400` error code. You can control the geographical extent of the static map with padding values or by defining the zoom or radius parameter. properties: overlay: $ref: '#/components/schemas/Overlay' symbolDictionary: $ref: '#/components/schemas/SymbolDictionary' 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: BasemapStyleWithOverlayPost x-arcgis-frontmatter: keywords: - static maps - with overlay summary: Returns a static map in an ArcGIS Basemap style with points, polylines and/or polygons overlays. description: | ![with-overlay](https://arcgis.com/sharing/rest/content/items/ffc006d3119a4255a09291e60217c20f/data) Returns a static map that displays an ArcGIS Basemap style and an overlay with a mixture of points, polygons and polylines. The center of the map is specified by `centerX` and `centerY`. If the map center is not supplied, it is defined by the extent of the supplied overlay geometry. If neither the extent is defined or geometry is supplied then the service will return a `400` error. You can control the geographical extent of the static map with padding values or by defining the `zoom` or `radius` parameter. 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 mixture of points, polygons and polylines 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). /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: | 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). 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 ArcGIS basemap style used to render the map. | 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 | TokenParam: name: token in: query required: false description: | An access token with the static maps service privilege. To pass the token as an authorization header, see [HTTP authorization headers](https://developers.arcgis.com/documentation/security-and-authentication/reference/http-authorization-headers/). 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. schema: type: string XParam: name: x in: query schema: type: number format: double minimum: -179.9 maximum: 179.9 example: -117.1957 required: true description: | X‑coordinate of a point in WGS84 decimal degrees. Values range from `-179.99` to `179.99`. YParam: name: y in: query schema: type: number format: double minimum: -85.05 maximum: 85.05 example: 34.0561 required: true description: | Y‑coordinate of a point in WGS84 decimal degrees. Values range from `-85.05` to `85.05`. ImageFormatParam: name: format in: query schema: $ref: '#/components/schemas/ImageFormat' required: false description: Output image format of the map. Supported formats include `png`, `jpeg`, and `webp`. example: png ImageHeightParam: name: height in: query schema: $ref: '#/components/schemas/ImageDimensionHeight' required: false description: Height of the map image in pixels. Values must be between `128` and `1024`. example: 400 ImageWidthParam: name: width in: query schema: $ref: '#/components/schemas/ImageDimensionWidth' description: Width of the map image in pixels. Values must be between `128` and `1024`. required: false example: 400 PaddingParam: name: padding explode: false in: query schema: $ref: '#/components/schemas/ImagePadding' required: false description: | Padding percentages around the map extent. Accepts an array of 1–4 values; default is `10` on all sides, maximum is `25`. 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 SymbolHexColorParam: name: symbolColor in: query description: | Point symbol color in hexadecimal format with an optional alpha value. 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: | Scale factor applied to the point symbol size. Values range from `0.1` to `4.0`. 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: | Style applied to the point symbol. Supported values include `pin`, `circle`, `square`, and `none`. schema: type: string enum: - pin - circle - square - none default: pin LabelParam: name: symbolLabel in: query schema: $ref: '#/components/schemas/SymbolLabel' required: false description: | Label displayed on the point symbol. Accepts 1–2 alphanumeric characters (`A-Z`, `a-z`, `0-9`). example: A CenterXParam: name: centerX in: query schema: type: number format: double minimum: -179.9 maximum: 179.9 example: -117.1957 description: | X-coordinate of the map center in WGS84 decimal degrees. Values range from `-179.99` to `179.99`. Setting this value will override the map extent which may result in you graphics not being visible in the map. CenterYParam: name: centerY in: query schema: type: number format: double minimum: -85.05 maximum: 85.05 example: 34.0561 description: | Y-coordinate of the map center in WGS84 decimal degrees. Values range from `-85.05` to `85.05`. Setting this value will override the extent of the map, which may result in your graphics not being displayed. ZoomParam: name: zoom in: query schema: $ref: '#/components/schemas/ZoomLevel' example: 12 description: | A number that defines the level of detail of the map. Values range from `0` to `22`. 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. `zoom` and `radius` are mutually exclusive. Use only one or the other. RadiusParam: name: radius in: query schema: $ref: '#/components/schemas/RadiusDistance' example: 1000 description: | A number (in meters) that defines the minimum geographic area around a center point of the map. If no center point is supplied, the radius is applied to the geometry. Values range from `10` to `20,000,000`. `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. | 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 `radius` has a minimum value of 10 meters and a maximum value of 20,000,000 meters. ImageAttributionParam: name: attribution in: query required: false description: | Attribution footer style. To learn more about attribution requirements for static maps, see [Esri and data attribution](https://developers.arcgis.com/documentation/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. You must ensure that your map is accompanied by the full attribution statement (see terms of use): if you choose the `none` option you must include the full attribution string yourself. schema: type: string enum: - auto - light - dark - none default: auto ReferenceDetailsParam: name: referenceDetails in: query required: false description: | A basemap option that controls the visibility of labels and feature symbology. This parameter is currently supported only for the `arcgis/imagery` style. Supported values include `all` and `none`. schema: type: string enum: - all - none default: all example: all ManyPointParam: name: points in: query schema: $ref: '#/components/schemas/ManyPointsGet' required: true description: | An array of x,y coordinate pairs in the WGS84 spatial reference. X values range from -179.99 to 179.99 and Y values range from -85.05 to 85.05. Accepts up to 10 coordinate pairs. The points are displayed using the same `symbolStyle`. This property is an array of individual points and does not use the [multipoint geometry type](https://developers.arcgis.com/web-map-specification/objects/multipoint_geometry/). example: - - -117.1957 - 34.0561 - - -117.1942 - 34.0569 - - -117.1964 - 34.05685 - - -117.1945 - 34.0573 LabelsParam: name: labelOption in: query required: false description: | Type of label displayed on point symbols, such as letters or numbers. Supported values include `none`, `letter`, and `number`. If the value is set to `letter`, a label of `A` is set on the point symbol of the first point in the list of points. A label of `B` is set on the point symbol of second point, up to the letter `I`. If the value is set to `number`, a label of `1` is set on the point symbol of the first point in the list of points. A label of `2` is set on the point symbol of second point, and so on up to the number `9`. If the value is set to `none`, no point symbols will have labels. schema: type: string enum: - none - letter - number default: none PolylineParam: name: polyline in: query required: true schema: $ref: '#/components/schemas/PathGeometryGet' description: | An array of x,y coordinate pairs defining a polyline in WGS84 spatial reference. Accepts 2 to 10 coordinate pairs. The first coordinate pair in the array represents the start of the polyline, while the last coordinate pair represents the end. example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 EndLabelParam: name: endSymbolLabel in: query schema: $ref: '#/components/schemas/SymbolLabel' required: false description: | Label displayed on the point symbol at the end of a polyline. Accepts 1–2 alphanumeric characters (`A-Z`, `a-z`, `0-9`). example: A EndSymbolHexColorParam: name: endSymbolColor in: query description: | Point symbol color at the end of a polyline 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: | Point symbol style at the end of the polyline. Supported values include `pin`, `circle`, `square`, `none`. It highlights the end of the polyline or path. schema: $ref: '#/components/schemas/SymbolStyle' LineHexColorParam: name: lineColor in: query description: | Line symbol color 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: | Line symbol stroke applied to the polyline. Supported values include `solid`, `dash`, `dot`. The default line style is `solid`. schema: $ref: '#/components/schemas/LineStyle' LineWidthParam: name: lineWidth in: query schema: type: integer minimum: 1 maximum: 16 default: 4 required: false description: | Line symbol width in device-independent pixels. Values range from `1` to `16`. example: 2 StartLabelParam: name: startSymbolLabel in: query schema: $ref: '#/components/schemas/SymbolLabel' required: false description: | Label displayed on the point symbol at the start of a polyline. Accepts 1–2 alphanumeric characters (`A-Z`, `a-z`, `0-9`). example: A StartSymbolHexColorParam: name: startSymbolColor in: query description: | Point symbol color at the start of a polyline 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: | Point symbol style at the start of the polyline. Supported values include `pin`, `circle`, `square`, and `none`. It highlights the beginning of the polyline or path. schema: $ref: '#/components/schemas/SymbolStyle' PolygonParam: name: polygon in: query required: true schema: $ref: '#/components/schemas/Ring' description: | An array of x,y coordinate pairs in the WGS84 spatial reference defining a polygon boundary. Accepts 3 to 10 coordinate pairs. 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. example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 FillHexColorParam: name: fillColor in: query description: | Polygon fill color 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: | Polygon fill style. Supported values include `solid` and `none`. schema: type: string enum: - solid - none default: solid OutlineHexColorParam: name: outlineColor in: query description: | Polygon outline color 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: | Polygon outline stroke. Supported values include `solid` and `none`. The default line style is `solid`. schema: $ref: '#/components/schemas/LineStyle' OutlineWidthParam: name: outlineWidth in: query schema: type: integer minimum: 1 maximum: 16 default: 4 required: false description: | Polygon outline width in device-independent pixels. Values range from `1` to `16`. The minimum width is 1 and the maximum width is 16. example: 2 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: 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 ImageDimensionHeight: type: integer minimum: 128 maximum: 1024 default: 400 description: A dimension height of the requested map image in pixels at 96 DPI between 128 and 1024 pixels. example: 500 ImageDimensionWidth: type: integer minimum: 128 maximum: 1024 default: 400 description: A dimension width of the requested map image in pixels at 96 DPI between 128 and 1024 pixels. example: 500 ImagePadding: 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 HexColor: type: string pattern: ^[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$ minLength: 6 maxLength: 8 default: 007AC2 description: | 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`). SymbolScale: type: number format: float minimum: 0.1 maximum: 4 default: 1 description: | 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. example: 1 SymbolLabel: type: string pattern: ^[A-Za-z0-9]{1,2}$ minLength: 1 maxLength: 2 description: | 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. example: A ZoomLevel: type: integer minimum: 0 maximum: 22 description: 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. example: 12 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. `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. | 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 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 - 405 - 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 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 coordinate pair in the WGS84 spatial reference. required: - x - y properties: x: type: number description: X-coordinate in WGS84 decimal degrees. y: type: number description: Y-coordinate 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 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`. 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-zA-Z0-9_-]+$ maxLength: 30 minLength: 1 scale: $ref: '#/components/schemas/SymbolScale' offsetX: $ref: '#/components/schemas/SymbolOffsetX' offsetY: $ref: '#/components/schemas/SymbolOffsetY' SymbolStyle: description: | 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 enum: - pin - circle - square - none example: circle default: pin SimpleMarkerSymbol: type: object description: | The simple symbol can have a colored `pin`, `circle` or `square` 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' ManyPointsGet: type: array description: | An array of x,y coordinate pairs defining a path in the WGS84 spatial reference. Accepts to 10 coordinate pairs. minItems: 1 maxItems: 10 items: $ref: '#/components/schemas/Coordinates' example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 Coordinates: type: array items: type: number format: double description: | 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). minItems: 2 maxItems: 2 example: - -117.1957 - 34.0561 PathGeometryGet: type: array description: | An array of x,y coordinate pairs defining a path in the WGS84 spatial reference. Accepts 2 to 10 coordinate pairs. minItems: 2 maxItems: 10 items: $ref: '#/components/schemas/Coordinates' example: - - -117.247325 - 34.100934 - - -117.247506 - 34.104433 - - -117.247962 - 34.105095 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 Ring: type: array description: | An array of x,y coordinate pairs defining a polygon boundary in the WGS84 spatial reference. minItems: 3 items: $ref: '#/components/schemas/Coordinates' example: - - - -117.247962 - 34.105095 - - -117.244321 - 34.106745 - - -117.209646 - 34.106204 - - -117.208757 - 34.105251 Attribution: type: object description: | 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](https://developers.arcgis.com/documentation/esri-and-data-attribution/static-maps/). required: - attribution properties: attribution: type: string example: | Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors, and the GIS User Community. Point: type: object description: | 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`. required: - geometry properties: type: type: string pattern: ^point$ geometry: $ref: '#/components/schemas/PointGeometry' symbol: description: The symbol can be a simple symbol or a custom symbol. oneOf: - $ref: '#/components/schemas/CustomMarkerSymbol' - $ref: '#/components/schemas/SimpleMarkerSymbol' PathGeometry: type: array items: $ref: '#/components/schemas/Coordinates' description: | An array of x,y coordinate pairs defining a polyline in the WGS84 spatial reference. minItems: 2 Paths: type: array description: | 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. 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 PolylineGeometry: 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`. The polyline can contain from 2 to 5000 coordinate pairs that can be defined in one or more paths. required: - paths properties: paths: $ref: '#/components/schemas/Paths' spatialReference: $ref: '#/components/schemas/SpatialReference' LineWidth: type: integer minimum: 1 maximum: 16 default: 2 description: | Line width 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' 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`. The polyline can contain from 2 to 5000 coordinate pairs that can be defined in one or more paths. required: - geometry properties: type: type: string pattern: ^polyline$ geometry: $ref: '#/components/schemas/PolylineGeometry' symbol: $ref: '#/components/schemas/LineSymbol' 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 5000 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 PolygonGeometry: type: object description: | 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. required: - rings properties: rings: $ref: '#/components/schemas/Rings' spatialReference: $ref: '#/components/schemas/SpatialReference' FillStyle: type: string enum: - solid - none description: | The style of the fill. The default fill style is `solid`. example: solid default: solid RingSymbol: 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' Polygon: type: object description: | 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. required: - geometry properties: type: type: string pattern: ^polygon$ geometry: $ref: '#/components/schemas/PolygonGeometry' symbol: $ref: '#/components/schemas/RingSymbol' Overlay: type: array description: | An array of geometries to display on the static map, including [point](https://developers.arcgis.com/rest/static-maps/types/#point), [polyline](https://developers.arcgis.com/rest/static-maps/types/#polyline), and/or [polygon](https://developers.arcgis.com/rest/static-maps/types/#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. items: anyOf: - $ref: '#/components/schemas/Point' - $ref: '#/components/schemas/Polyline' - $ref: '#/components/schemas/Polygon' maxItems: 64 SymbolDictionary: description: | 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:[][;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 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. type: object additionalProperties: type: string minLength: 27 maxLength: 8000 example: parkEntrance: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTE4IDkuOTk4di0xbC03LjUtNi03LjUgNnYxaDF2NkgzdjFoMTV2LTFoLTF2LTZoMXptLTEyIDBoM3YzSDZ2LTN6bTYgNnYtNmgzdjZoLTN6Ii8+PC9zdmc+ campground: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI+PHBhdGggZD0iTTEyLjQwMiAxNi45NzZIMTlMMTAuNTAzIDIuOTk4IDIgMTYuOTc2aDYuNjI2bDEuODg4LTguOTR6Ii8+PC9zdmc+ ImageAttribution: type: string enum: - auto - light - dark - none default: auto description: | Attribution footer style. Values can be `auto`, `light`, `dark` or `none`. Learn more about attribution requirements in [Esri and data attribution > Static maps](https://developers.arcgis.com/documentation/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. example: auto Image: type: object description: | 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: width: $ref: '#/components/schemas/ImageDimensionWidth' height: $ref: '#/components/schemas/ImageDimensionHeight' format: $ref: '#/components/schemas/ImageFormat' padding: $ref: '#/components/schemas/ImagePadding' attribution: $ref: '#/components/schemas/ImageAttribution' BasemapOptions: type: object description: A collection of options to change how the basemap is displayed properties: referenceDetails: type: string description: A basemap option that controls the visibility of labels and feature symbology. This parameter is currently supported only for the `arcgis/imagery` style. enum: - all - none example: referenceDetails: all Map: type: object description: | 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: radius: $ref: '#/components/schemas/RadiusDistance' zoom: $ref: '#/components/schemas/ZoomLevel' center: $ref: '#/components/schemas/PointGeometry' basemapOptions: $ref: '#/components/schemas/BasemapOptions' 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: SinglePOI: summary: Single point location value: overlay: - type: point geometry: x: -1.81 y: 51.17 symbol: style: pin scale: 2 color: 0dabff image: width: 400 height: 400 MultiPOI: summary: Multiple point locations value: overlay: - type: point geometry: x: -1.81 y: 51.17 symbol: style: pin scale: 2 color: 0dabff label: B1 - type: point geometry: x: -1.88 y: 51.18 symbol: style: pin scale: 2 color: 0dffabff label: A image: width: 400 height: 400 padding: - 20 PolylineAndPoints: summary: Polyline and points value: overlay: - type: point geometry: x: -1.81 y: 51.17 symbol: style: pin scale: 2 color: 0dabff label: B1 - type: point geometry: x: -1.88 y: 51.18 symbol: style: pin scale: 2 color: 0dffabff label: A - type: polyline geometry: paths: - - - -1.88 - 51.18 - - -1.859 - 51.172 - - -1.81 - 51.17 symbol: style: dot color: ff00ab width: 6 image: width: 400 height: 400 PolygonAndPoints: summary: Polygon and point value: overlay: - type: point geometry: x: -117.19511 y: 34.05668 symbol: customSymbolId: entrance scale: 2 - type: polygon geometry: rings: - - - -117.1955 - 34.05658 - - -117.19524 - 34.05658 - - -117.19524 - 34.05661 - - -117.19511 - 34.05661 - - -117.19511 - 34.05675 - - -117.19517 - 34.05675 - - -117.19517 - 34.05688 - - -117.1955 - 34.05688 - - -117.1955 - 34.05658 symbol: style: solid color: 0F00FF7d outline: style: solid color: 0F00FF7d width: 8 image: padding: - 15 width: 400 height: 400 symbolDictionary: entrance: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzMiAzMiI+PHBhdGggZD0iTTI1IDJ2MjhIN1YxOWgxdjkuMjkzbDQtNFYxOWgxdjUuNzA3TDguNzA3IDI5SDI0VjNIMTN2MTFoLTFWM0g4djExSDdWMnptLTUuNzA3IDE1bC0yLjY0NiAyLjY0Ni43MDcuNzA3IDMuODUzLTMuODUzLTMuODU0LTMuODU0LS43MDcuNzA3TDE5LjI5MyAxNkgzLjAxM3YxeiIvPjxwYXRoIGZpbGw9Im5vbmUiIGQ9Ik0wIDBoMzJ2MzJIMHoiLz48L3N2Zz4=