openapi: 3.0.3 info: title: Static Maps Service description: | The ArcGIS Static Maps service enables developers to create and easily embed map images from ArcGIS Basemaps on websites or in a range of applications where an interactive map is not required. The map image returned by this service shows an ArcGIS Basemap, such as streets or navigation, that is centered at a specific location and zoomed to an appropriate country, city or street level. The map can also contain a map symbol, such as a pin, cross, or custom symbol, to highlight a special feature (such as a delivery address). The 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 particularly 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/2fa29a1525804c7fb5455d659be3bbed/data) version: 0.2.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 tags: - name: Static Maps description: Endpoints which provide generated map images - name: Map attribution description: Endpoints which provide map attribution security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] paths: /generate-map/arcgis/imagery/centered-at: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/LongitudeParam' - $ref: '#/components/parameters/LatitudeParam' - $ref: '#/components/parameters/RasterStyleZoomLevelParam' - $ref: '#/components/parameters/MarkerSymbolParam' - $ref: '#/components/parameters/MapImageFormatParam' - $ref: '#/components/parameters/MapImageWidthParam' - $ref: '#/components/parameters/MapImageHeightParam' - $ref: '#/components/parameters/MarkerSymbolScaleParam' - $ref: '#/components/parameters/MarkerSymbolXOffsetParam' - $ref: '#/components/parameters/MarkerSymbolYOffsetParam' - $ref: '#/components/parameters/TokenParam' 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: ArcgisImageryMapCenteredAtGet x-arcgis-frontmatter: keywords: - static - basemap - map - imagery - centered summary: Returns a static map in the ArcGIS Imagery style. description: | Returns an image of a static map in the ArcGIS Imagery style. The returned map image is centered at a given `WGS84` position, as defined using the `lon` and `lat` parameters. The map scale is controlled using the `zoomLevel` parameter. The size of the map image (in pixels) is defined using the `mapImageWidth` and `mapImageHeight` parameters. The text "Powered by ESRI" is positioned at the bottom-right of the map image. A data attribution string must also be displayed near the map image or by using an application popup or menu. For more information see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). ![arcgis/imagery](https://arcgis.com/sharing/rest/content/items/2fa29a1525804c7fb5455d659be3bbed/data) **Data providers:** Esri, Maxar, Earthstar Geographics and the GIS User Community. /generate-map/arcgis/navigation/centered-at: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/LongitudeParam' - $ref: '#/components/parameters/LatitudeParam' - $ref: '#/components/parameters/VectorStyleZoomLevelParam' - $ref: '#/components/parameters/MarkerSymbolParam' - $ref: '#/components/parameters/MapImageFormatParam' - $ref: '#/components/parameters/MapImageWidthParam' - $ref: '#/components/parameters/MapImageHeightParam' - $ref: '#/components/parameters/MarkerSymbolScaleParam' - $ref: '#/components/parameters/MarkerSymbolXOffsetParam' - $ref: '#/components/parameters/MarkerSymbolYOffsetParam' - $ref: '#/components/parameters/TokenParam' 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: ArcgisNavigationMapCenteredAtGet x-arcgis-frontmatter: keywords: - static - basemap - map - navigation - centered summary: Returns a static map in the ArcGIS Navigation style. description: | Returns an image of a static map in the ArcGIS Navigation style. The returned map image is centered at a given `WGS84` position, as defined using the `lon` and `lat` parameters. The map scale is controlled using the `zoomLevel` parameter. The size of the map image (in pixels) is defined using the `mapImageWidth` and `mapImageHeight` parameters. The text "Powered by ESRI" is positioned at the bottom-right of the map image. A data attribution string must also be displayed near the map image or by using an application popup or menu. For more information see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). ![arcgis/navigation](https://arcgis.com/sharing/rest/content/items/e487b9c4e6b5467fb74e441a9efc27b2/data) **Data providers:** Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors and the GIS User Community. /generate-map/arcgis/navigation-night/centered-at: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/LongitudeParam' - $ref: '#/components/parameters/LatitudeParam' - $ref: '#/components/parameters/VectorStyleZoomLevelParam' - $ref: '#/components/parameters/MarkerSymbolParam' - $ref: '#/components/parameters/MapImageFormatParam' - $ref: '#/components/parameters/MapImageWidthParam' - $ref: '#/components/parameters/MapImageHeightParam' - $ref: '#/components/parameters/MarkerSymbolScaleParam' - $ref: '#/components/parameters/MarkerSymbolXOffsetParam' - $ref: '#/components/parameters/MarkerSymbolYOffsetParam' - $ref: '#/components/parameters/TokenParam' 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: ArcgisNavigationNightMapCenteredAtGet x-arcgis-frontmatter: keywords: - static - basemap - map - navigation - night - centered summary: Returns a static map in the ArcGIS Navigation Night style. description: | Returns an image of a static map in the ArcGIS Navigation Night style. The returned map image is centered at a given `WGS84` position, as defined using the `lon` and `lat` parameters. The map scale is controlled using the `zoomLevel` parameter. The size of the map image (in pixels) is defined using the `mapImageWidth` and `mapImageHeight` parameters. The text "Powered by ESRI" is positioned at the bottom-right of the map image. A data attribution string must also be displayed near the map image or by using an application popup or menu. For more information see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). ![arcgis/navigation-night](https://arcgis.com/sharing/rest/content/items/1bda36c5de514fa08941c332cc58f510/data) **Data providers:** Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors and the GIS User Community. /generate-map/arcgis/streets/centered-at: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/LongitudeParam' - $ref: '#/components/parameters/LatitudeParam' - $ref: '#/components/parameters/VectorStyleZoomLevelParam' - $ref: '#/components/parameters/MarkerSymbolParam' - $ref: '#/components/parameters/MapImageFormatParam' - $ref: '#/components/parameters/MapImageWidthParam' - $ref: '#/components/parameters/MapImageHeightParam' - $ref: '#/components/parameters/MarkerSymbolScaleParam' - $ref: '#/components/parameters/MarkerSymbolXOffsetParam' - $ref: '#/components/parameters/MarkerSymbolYOffsetParam' - $ref: '#/components/parameters/TokenParam' 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: ArcgisStreetsMapCenteredAtGet x-arcgis-frontmatter: keywords: - static - basemap - map - streets - centered summary: Returns a static map in the ArcGIS Streets style. description: | Returns an image of a static map in the ArcGIS Streets style. The returned map image is centered at a given `WGS84` position, as defined using the `lon` and `lat` parameters. The map scale is controlled using the `zoomLevel` parameter. The size of the map image (in pixels) is defined using the `mapImageWidth` and `mapImageHeight` parameters. The text "Powered by ESRI" is positioned at the bottom-right of the map image. A data attribution string must also be displayed near the map image or by using an application popup or menu. For more information see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). ![arcgis/streets](https://arcgis.com/sharing/rest/content/items/ba8d8326499c425e9afdaeb18c964974/data) **Data providers:** Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors and the GIS User Community. /generate-map/arcgis/streets-night/centered-at: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Static Maps parameters: - $ref: '#/components/parameters/LongitudeParam' - $ref: '#/components/parameters/LatitudeParam' - $ref: '#/components/parameters/VectorStyleZoomLevelParam' - $ref: '#/components/parameters/MarkerSymbolParam' - $ref: '#/components/parameters/MapImageFormatParam' - $ref: '#/components/parameters/MapImageWidthParam' - $ref: '#/components/parameters/MapImageHeightParam' - $ref: '#/components/parameters/MarkerSymbolScaleParam' - $ref: '#/components/parameters/MarkerSymbolXOffsetParam' - $ref: '#/components/parameters/MarkerSymbolYOffsetParam' - $ref: '#/components/parameters/TokenParam' 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: ArcgisStreetsNightMapCenteredAtGet x-arcgis-frontmatter: keywords: - static - basemap - map - streets - night - centered summary: Returns a static map in the ArcGIS Streets Night style. description: | Returns an image of a static map in the ArcGIS Streets Night style. The returned map image is centered at a given `WGS84` position, as defined using the `lon` and `lat` parameters. The map scale is controlled using the `zoomLevel` parameter. The size of the map image (in pixels) is defined using the `mapImageWidth` and `mapImageHeight` parameters. The text "Powered by ESRI" is positioned at the bottom-right of the map image. A data attribution string must also be displayed near the map image or by using an application popup or menu. For more information see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). ![arcgis/streets-night](https://arcgis.com/sharing/rest/content/items/1e1736c74cce4e8bba026b718a849923/data) **Data providers:** Esri, TomTom, Garmin, FAO, NOAA, USGS, © OpenStreetMap contributors and the GIS User Community. /attribution/arcgis/imagery: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Map attribution parameters: - $ref: '#/components/parameters/FormatParam' 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: ArcgisImageryAttributionGet x-arcgis-frontmatter: keywords: - attribution - imagery summary: Returns the attribution for the ArcGIS Imagery style. description: | Returns the attribution for the ArcGIS Imagery style. Attribution data must be displayed with the map image. For more details see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). /attribution/arcgis/navigation: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Map attribution parameters: - $ref: '#/components/parameters/FormatParam' 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: ArcgisNavigationAttributionGet x-arcgis-frontmatter: keywords: - attribution - navigation summary: Returns the attribution for the ArcGIS Navigation style. description: | Returns the attribution for the ArcGIS Navigation style. Attribution data must be displayed with the map image. For more details see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). /attribution/arcgis/navigation-night: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Map attribution parameters: - $ref: '#/components/parameters/FormatParam' 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: ArcgisNavigationNightAttributionGet x-arcgis-frontmatter: keywords: - attribution - navigation - night summary: Returns the attribution for the ArcGIS Navigation Night style. description: | Returns the attribution for the ArcGIS Navigation Night style. Attribution data must be displayed with the map image. For more details see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). /attribution/arcgis/streets: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Map attribution parameters: - $ref: '#/components/parameters/FormatParam' 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: ArcgisStreetsAttributionGet x-arcgis-frontmatter: keywords: - attribution - streets summary: Returns the attribution for the ArcGIS Streets style. description: | Returns the attribution for the ArcGIS Streets style. Attribution data must be displayed with the map image. For more details see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). /attribution/arcgis/streets-night: get: security: - ArcGISTokenParameter: [] - ArcGISAuthorizationHeader: [] - ArcGISXEsriAuthorizationHeader: [] tags: - Map attribution parameters: - $ref: '#/components/parameters/FormatParam' 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: ArcgisStreetsNightAttributionGet x-arcgis-frontmatter: keywords: - attribution - streets - night summary: Returns the attribution for the ArcGIS Streets Night style. description: | Returns the attribution for the ArcGIS Streets Night style. Attribution data must be displayed with the map image. For more details see [Esri and Data Attribution](https://developers.arcgis.com/documentation/esri-and-data-attribution/). components: schemas: SimpleMarkerSymbol: type: string enum: - x - cross - square - triangle - circle - pin 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 Attribution: type: object description: Contains details of the map attribution. required: - attribution properties: attribution: type: string example: 'Sources: Esri, Maxar, GeoEye, Earthstar Geographics, CNES/Airbus DS, USDA, USGS, AeroGRID, IGN, © OpenStreetMap contributors, TomTom, Garmin, FAO, NOAA, and the GIS User Community' responses: StaticMapResponse: description: Static map in a desired image format. content: image/webp: schema: type: string format: binary image/jpg: schema: type: string format: binary image/png: schema: type: string format: binary AttributionResponse: description: Attribution for a map style. content: application/json: schema: $ref: '#/components/schemas/Attribution' UnauthorizedErrorResponse: description: Authentication Error. The API key or token is missing, invalid or expired. content: application/json: schema: $ref: '#/components/schemas/Error' ServerErrorResponse: description: An error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/Error' InvalidQueryErrorResponse: description: Invalid query parameters / Incorrect portal item type / Data URL parse failure. content: application/json: schema: $ref: '#/components/schemas/Error' PermissionMissingErrorResponse: description: | The supplied authentication information is valid but does not have permission to access the service. 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' parameters: 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 MarkerSymbolParam: name: markerSymbol in: query required: false description: | The map marker symbol that will be placed on the static map. This value can be a simple map marker symbol (see [SimpleMarkerSymbol](https://developers.arcgis.com/rest/static-maps/types/#simplemarkersymbol)) (`pin`, `X`, `cross`, `square`, `circle`, `triangle`) or the data URL encoding of a base64 encoded SVG symbol. You can create your own SVG symbol or obtain an SVG point symbol from a Github repository such as the [Calcite point symbols](https://github.com/Esri/calcite-point-symbols). To see the full range of SVG point symbols in this repository see [Calcite Design System](https://developers.arcgis.com/calcite-design-system/icons/?library=Point%20Symbols). Once you have an SVG file, read the file and obtain the its XML string. Next, convert the SVG XML string into a URL safe string as follows: 1. Convert the SVG XML string into a base64-encoded string. 2. Append the base64-encoded string to the data url prefix `data:/svg+xml;base64,`. 3. URL encode the prefixed string. 4. Set the `markerSymbol` parameter to the url safe string. As a Javascript example: ```js function encodeSVG(svgXMLString) { const base64EncodedString = btoa(svgXMLString); const dataURLAppended = "data:/svg+xml;base64," + base64Encoded; const urlSafeString = encodeURIComponent(dataURLAppended); return urlSafeString; } ``` schema: type: string enum: - pin - x - cross - square - circle - triangle - data%3A%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyBkYXRhLW5hbWU9Ik5ldyBTeW1ib2xzIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI%2BPHBhdGggZD0iTTEwLjUgMi4yYTguMyA4LjMgMCAxIDAgOC4zIDguMyA4LjMgOC4zIDAgMCAwLTguMy04LjN6TTEyIDE1aC0yVjcuMDY3TDcuODU4IDguNzQ5IDYuODAzIDcuNDAyIDEwLjAxNiA1SDEyeiIvPjwvc3ZnPg%3D%3D example: data%3A%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyBkYXRhLW5hbWU9Ik5ldyBTeW1ib2xzIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMSAyMSI%2BPHBhdGggZD0iTTEwLjUgMi4yYTguMyA4LjMgMCAxIDAgOC4zIDguMyA4LjMgOC4zIDAgMCAwLTguMy04LjN6TTEyIDE1aC0yVjcuMDY3TDcuODU4IDguNzQ5IDYuODAzIDcuNDAyIDEwLjAxNiA1SDEyeiIvPjwvc3ZnPg%3D%3D LongitudeParam: name: lon in: query schema: type: number minimum: -179.99 maximum: 179.99 example: -117.195846 required: true description: The longitude of the specified point within the WGS84 coordinate system. The longitude can be in the range of `-179.99` to `179.99`, representing the East/West or X-Axis. LatitudeParam: name: lat in: query schema: type: number minimum: -85.05 maximum: 85.05 example: 34.056997 required: true description: The latitude of the specified point within the WGS84 coordinate system. The latitude can be in the range of `-85.05` to `85.05`, representing the North/South or Y-Axis. RasterStyleZoomLevelParam: name: zoomLevel in: query schema: type: number enum: - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 default: 15 required: false description: | The level of detail or zoom level for a map. Supplying a level of `5` returns the smallest scale of the static map (the Country scale) and a level of `20` returns the largest scale (the House scale). The table below shows the scale of each level: level | scale | usage --- | --- | --- 5 | 1:9244648.868618 | Countries 6 | 1:4622324.434309 | States / Provinces 7 | 1:2311162.217155 | Counties 8 | 1:1155581.108577 | Counties 9 | 1:577790.554289 | County 10 | 1:288895.277144 | Metropolitan Area 11 | 1:144447.638572 | Cities 12 | 1:72223.819286 | City 13 | 1:36111.909643 | Town 14 | 1:18055.954822 | Neighborhood 15 | 1:9027.977411 | Streets 16 | 1:4513.9887055 | City block 17 | 1:2256.9943525 | Buildings 18 | 1:1128.4971765 | Building 19 | 1:564.248588 | Houses 20 | 1:282.124294 | Houses For more information on levels of detail see the [Zoom levels and scale](https://developers.arcgis.com/documentation/mapping-apis-and-services/reference/zoom-levels-and-scale/) topic. VectorStyleZoomLevelParam: name: zoomLevel in: query schema: type: number enum: - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 default: 15 required: false description: | The level of detail or zoom level for a map. Supplying a level of `5` returns the smallest scale of the static map (the Country scale) and a level of `23` returns the largest scale (the House scale). The table below shows the scale of each level: level | scale | usage --- | --- | --- 5 | 1:9244648.868618 | Countries 6 | 1:4622324.434309 | States / Provinces 7 | 1:2311162.217155 | Counties 8 | 1:1155581.108577 | Counties 9 | 1:577790.554289 | County 10 | 1:288895.277144 | Metropolitan Area 11 | 1:144447.638572 | Cities 12 | 1:72223.819286 | City 13 | 1:36111.909643 | Town 14 | 1:18055.954822 | Neighborhood 15 | 1:9027.977411 | Streets 16 | 1:4513.9887055 | City block 17 | 1:2256.9943525 | Buildings 18 | 1:1128.4971765 | Building 19 | 1:564.248588 | Houses 20 | 1:282.124294 | Houses 21 | 1:141.062147 | Houses 22 | 1:70.5310735 | House Property 23 | 1:35.2655368 | House Property For more information on levels of detail see the [Zoom levels and scale](https://developers.arcgis.com/documentation/mapping-apis-and-services/reference/zoom-levels-and-scale/) topic. MapImageWidthParam: name: mapImageWidth in: query schema: type: integer minimum: 64 maximum: 1024 default: 200 required: false description: The width of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. MapImageHeightParam: name: mapImageHeight in: query schema: type: integer minimum: 64 maximum: 1024 default: 200 required: false description: The height of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. MarkerSymbolScaleParam: name: markerSymbolScale in: query schema: type: number format: float minimum: 0.1 maximum: 2.0 default: 1.0 required: false description: | The scale of the overlaying map marker symbol as a multiplier of the symbol's dimensions. This value increments by 0.1. 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. MarkerSymbolXOffsetParam: name: markerSymbolOffsetX in: query schema: type: integer format: int32 minimum: -512 maximum: 512 default: 0 required: false description: The X offset of the map marker symbol in pixels from the center of the generated map image. MarkerSymbolYOffsetParam: name: markerSymbolOffsetY in: query schema: type: integer format: int32 minimum: -512 maximum: 512 default: 0 required: false description: The Y offset of the map marker symbol in pixels from the center of the generated map image. MapImageFormatParam: name: mapImageFormat in: query schema: type: string enum: - png - jpg - webp default: webp required: false description: Returns the image in the specified format. 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 `premium:user:staticMaps` privilege to use the static maps service. **Developer guide**: To learn more, go to [Security and authentication](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/). schema: type: string securitySchemes: ArcGISTokenParameter: type: apiKey in: query name: token description: | The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:staticMaps` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the static maps service. The case-sensitive `token` parameter can be either an API Key or short-lived token. See [ArcGIS security documentation](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/) for more information on authenticating with a token or API key. ArcGISXEsriAuthorizationHeader: type: http scheme: bearer bearerFormat: 'X-Esri-Authorization: Bearer ' description: | The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:staticMaps` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the static maps service. The authorization parameter can be either an API Key or short-lived token. See [ArcGIS security documentation](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/) for more information on authenticating with a token or API key. Supply the token in the request header using the "Bearer" scheme: `X-Esri-Authorization: Bearer ` ArcGISAuthorizationHeader: type: http scheme: bearer bearerFormat: 'Authorization: Bearer ' description: | The authentication token, created from an ArcGIS Location Platform account, with the `premium:user:staticMaps` [privilege](https://developers.arcgis.com/rest/users-groups-and-items/privileges.htm), used to access the static maps service. The authorization parameter can be either an API Key or short-lived token. See [ArcGIS security documentation](https://developers.arcgis.com/documentation/mapping-apis-and-services/security/) for more information on authenticating with a token or API key. Supply the token in the request header using the "Bearer" scheme: `Authorization: Bearer `