Skip to content

Parameters

These values describe the TypeScript route used by the public examples.

Parameter Required Format Current behavior
key Yes Non-empty string Issued WMS-VT API key. Invalid keys return a not-found response.
bbox Yes minX,minY,maxX,maxY Four decimal numbers without spaces. The public renderer currently uses Web Mercator coordinates.
width Yes Positive number Output width; source validation accepts 1 through 16,384. Use an integer.
height Yes Positive number Output height; source validation accepts 1 through 16,384. Use an integer.
dpi Yes Positive number Source validation accepts 10 through 700. DPI influences symbol and text scaling.
styleurl Yes for portable requests Absolute HTTP(S) URL or issued alias URL of a MapLibre-compatible style. Encode the entire value as one query parameter.
attribution No true or false May suppress service-added attribution when the API-key configuration allows it. It does not remove source-license obligations.

Example values

bbox=238138.090518,6238073.596726,264358.090923,6264293.626065
width=1600
height=1600
dpi=96
styleurl=https://maps.example.com/style.json

Stored style aliases

The TypeScript implementation can resolve a value shaped like {{identifier}} through its key/value store. This can keep an upstream style URL out of ordinary requests. Aliases are issued configuration, not arbitrary values a caller can invent, and should only be documented to customers for whom the feature is enabled.

Implementation differences

The Rust endpoint uses a different route and query shape, including optional epsg, format, dpi, and style values. Do not mix those parameters into the production TypeScript examples until that renderer becomes the public contract.

Limits are not an SLA

Passing source validation does not ensure that a render will fit the deployed service's time or memory budget. Test the intended style, extent, size, and request volume.