https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/beta/static-maps/arcgis/{arcgis-style}/centered-atReturns a static map that displays an ArcGIS Basemap style, centered at a specified WGS84 position, as defined by the x and y parameters.
The geographical extent of the map is defined by a radius parameter.
The center of the map can be highlighted using a pin or circle
marker symbol, that can be customized with a color and label. The static
map image width and height can be defined, along with the image format,
which can be png, jpeg, or webp.
Choose this option if you want to:
- display a symbol (pin or circle) in the centre of your static map.
- place a label (A-Z, a-z, 1-9) on the symbol.
- change the color and scale of the symbol.
Choose the POST option if you want to:
- display a custom symbol in the centre of your static map.
Please note that the ArcGIS Basemap style attribution statement must be
displayed every time the static map is visible. It must be positioned
very close to the static map, or it can be provided via a popup or menu
if the static map is embedded in an application or website. The relevant
attribution statement for an ArcGIS Basemap style is available from the
/static-maps/arcgis/{arcgis-style}/attribution endpoint. For more
information see the ArcGIS Location Platform Agreement on the
Terms of use.
Query parameters
| Name | Type | Required | Default value | Description |
|---|---|---|---|---|
x | number(double) | | The x-coordinate, or longitude value, of the point expressed in WGS84 decimal degrees. | |
y | number(double) | | The y-coordinate, or latitude value, of the point expressed in WGS84 decimal degrees. | |
radius | RadiusDistance | | The radius (in meters), defines the minimum geographical area around a specified point that is shown on the static map. | |
symbolStyle | string | | The style of the marker symbol. | |
symbolScale | SymbolScale | 1 | The scale of the marker symbol as a multiplier of the symbol's dimensions. | |
symbolColor | HexColor | 007 | The hexadecimal color code for the marker symbol. | |
symbolLabel | SymbolLabel | | The label to be displayed on the marker symbol. | |
mapImageWidth | MapImageWidth | 200 | The width of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. | |
mapImageHeight | MapImageHeight | 200 | The height of the requested map image in pixels at 96 DPI between 64 and 1024 pixels. | |
mapImageFormat | MapImageFormat | webp | The format of the map image, such as | |
padding | Padding | 0 | The padding applied to the static map adds extra map content between the static map's extent and the edge of the image. | |
token | string | | The authentication token, used to access the static maps service. |
x
The x-coordinate, or longitude value, of the point expressed in WGS84 decimal degrees.
The value can be in the range of -179.99 to 179.99, representing the East/West or X-Axis.
- Minimum
- -179.9
- Maximum
- 179.9
y
The y-coordinate, or latitude value, of the point expressed in WGS84 decimal degrees.
The value can be in the range of -85.05 to 85.05, representing the North/South or Y-Axis.
- Minimum
- -85.05
- Maximum
- 85.05
radius
The radius (in meters), defines the minimum geographical area around a specified point that is shown on the static map.
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) | Type of usage (approximate) |
|---|---|
| 10 | Building |
| 100 | Streets |
| 1000 | Town |
| 10000 | County |
| 100000 | State |
| 1000000 | Country |
The radius has a minimum value of 10 meters and a maximum value of
20,000,000 meters.
- Minimum
- 10
- Maximum
- 20000000
symbolScale
The scale of the marker symbol as a multiplier of the symbol's dimensions.
A scale value less than 1.0 indicates that the symbol is scaled down, while a value greater than 1.0 indicates that the symbol is scaled up. For example, a scale of 0.5 will reduce the symbol's dimensions to half its original size. A scale of 2.0 will double the symbol's dimensions.
The minimum scale is 0.1 and the maximum scale is 4.0.
- Minimum
- 0.1
- Maximum
- 4
- Default
- 1
symbolColor
The hexadecimal color code for the marker symbol.
It has the form RRGGBB.
RRis the red valueGGis the green valueBBis the blue value
- Minimum length
- 6
- Maximum length
- 6
- Default
- 007AC2
symbolLabel
The label to be displayed on the marker symbol.
The label can be a maximum of two letters or numbers from a-z, A-Z, or 0-9.
- Minimum length
- 1
- Maximum length
- 2
mapImageWidth
The width of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.
- Minimum
- 64
- Maximum
- 1024
- Default
- 200
mapImageHeight
The height of the requested map image in pixels at 96 DPI between 64 and 1024 pixels.
- Minimum
- 64
- Maximum
- 1024
- Default
- 200
mapImageFormat
The format of the map image, such as png, jpg, webp.
- Default
- webp
Enumerated values
padding
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.
- Default
- [0]
token
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 <YOUR_TOKEN>X-Esri-Authorization: Bearer <YOUR_TOKEN>
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.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
arcgis-style | string | The name of a style from the ArcGIS Basemap style family. |
arcgis-style
The name of a style from the ArcGIS Basemap style family.
| Group | Style | Example | Description | Data attribution |
|---|---|---|---|---|
| Streets | navigation | 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 | 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 | 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 | 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 | 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 |
Enumerated values
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Static map in a desired image format. | string(binary) |
| 400 | Bad Request | Invalid query parameters / Incorrect portal item type / Data URL parse failure. | Error |
| 401 | Unauthorized | Authentication Error. The API key or token is missing, invalid or expired. | Error |
| 403 | Forbidden | The requested resource cannot be accessed because of incorrect sharing permissions. | Error |
| 404 | Not Found | The requested resource cannot be found - this could be due to missing map data at the requested location and zoom level. | Error |
| 5XX | Server Error | An error occurred on the server. | Error |
Examples
Request
# You can also use wget
curl -X GET 'https://static-maps-api.arcgis.com/arcgis/rest/services/static-maps-service/beta/static-maps/arcgis/streets/centered-at?x=-117.1957&y=34.0561&radius=1000&token=YOUR_TOKEN'