---
title: "Render a named map image"
method: GET
path: "/v1/spatial/maps/{mapName}/image"
tags: ["Mapping Service: Render Maps"]
---

# Render a named map image

`GET /v1/spatial/maps/{mapName}/image`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/spatial/maps/{mapName}/image`
- Auth: API key in header `Authorization` and HTTP bearer

Renders a map image for an existing named map, identified by name in the URL path, using query parameters. Returns image/png or image/jpeg based on the format parameter.

For an ad-hoc map defined by layers rather than a saved map, use **Render a map image** instead.

**Map Extent Options:**
- Use `centerX`, `centerY` with `zoom`/`scale` for center-based rendering
- Use `bbox` for bounding box rendering (no center needed)

**Authorization:** Requires EXECUTE permission on the named map.

## Path parameters

- `mapName` string, required

## Query parameters

- `width` integer, required
- `height` integer, required
- `centerX` number, double
- `centerY` number, double
- `crs` string
- `zoom` number, double
- `zoomUnit` string
- `scale` number, double
- `minx` number, double
- `miny` number, double
- `maxx` number, double
- `maxy` number, double
- `resolution` integer
- `backgroundColor` string
- `backgroundOpacity` number, double
- `format` string, required

## Response `200`

Named map image rendered successfully. Returns PNG or JPEG based on the format parameter.

## Other responses

- `400`: Invalid parameters or missing required parameters
- `403`: Caller does not have EXECUTE permission on the named map
- `404`: Named map not found

---

[API](https://skmtc.dev/precisely/apis/mapping-api.md) · [All operations](https://skmtc.dev/precisely/apis/mapping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/mapping-api/revisions/cea0ad9440c5?raw)
