Skip to content

API request

The current public rendering route is:

GET https://api.wmsvt.com/api/v1.0.2/queued-wms

The query combines access control, map selection, and output settings. Parameter names are normalized to lowercase by the TypeScript service, but examples use the canonical lowercase spelling.

Request lifecycle

  1. Validate the API key.
  2. Detect a capabilities request, when applicable.
  3. Resolve a stored style alias or use the supplied style URL.
  4. Validate BBOX, dimensions, DPI, style URL, and attribution option.
  5. Queue the render.
  6. Load the style and referenced remote assets.
  7. Render and post-process the image.
  8. Return the image and remove the temporary file.

The current Express queue admits one active request per process. Integrations should expect render latency, use a suitable client timeout, and avoid immediate retry storms.

URL encoding

Always encode query values individually. A style URL may itself contain ?, &, =, or a provider key. Concatenating strings by hand can truncate or reinterpret it.

curl --get "$WMSVT_ENDPOINT" \
  --data-urlencode "key=$WMSVT_API_KEY" \
  --data-urlencode "styleurl=$STYLE_URL" \
  --data-urlencode "bbox=$BBOX" \
  --data-urlencode 'width=1200' \
  --data-urlencode 'height=800' \
  --data-urlencode 'dpi=96' \
  --output map.png
const url = new URL("https://api.wmsvt.com/api/v1.0.2/queued-wms");
url.search = new URLSearchParams({
  key: process.env.WMSVT_API_KEY,
  styleurl: process.env.STYLE_URL,
  bbox: "238138.09,6238073.60,264358.09,6264293.63",
  width: "1200",
  height: "800",
  dpi: "96"
});

const response = await fetch(url);
if (!response.ok) throw new Error(await response.text());
const image = Buffer.from(await response.arrayBuffer());

Keep this code on a trusted server. Putting a long-lived key in browser JavaScript makes it public.

Capabilities

The TypeScript service contains GetCapabilities handling when service=WMS and request=GetCapabilities are present, after API-key validation. Treat this as a product-specific compatibility surface until the advertised WMS version, schema validity, and production endpoint have been tested together.