Skip to content
Navigation

Render a parcel image (PNG) - query-string variant

Same as the POST variant but driven entirely by query parameters. Send the auth token in the token header; the token query parameter still works but is deprecated (a URL carries it into logs) and is refused from outside the box once RES_TOKEN_QUERY=deny is set. For an <img src>, proxy the image through your own server, which adds the header.

GET
https://res.aireon.ch/res_api/parcel_image

Authorization

  • ResApiToken
    optional
    API key in header
  • ResApiTokenQuery
    optional
    API key in query

Query parameters

  • token
    string
    required

    RES API token.

  • lat
    optional
    number

    WGS84 latitude. Provide lat+lng or x_3857+y_3857.

  • lng
    optional
    number

    WGS84 longitude.

  • x_3857
    optional
    number

    Web Mercator X. Provide lat+lng or x_3857+y_3857.

  • y_3857
    optional
    number

    Web Mercator Y.

  • img_size
    optional
    integer

    Output image width/height in pixels.

    default: 512
  • bounding_dist
    optional
    number

    Half-extent of the rendered bounding box, in metres.

    default: 200
  • style
    optional
    ratio_v_free
    or
    score
    or
    red
    or
    green

    Render style.

    default: "ratio_v_free"

Returns

200

PNG image, or a plain-text error body.

HTML
PNG
string

401

Authentication missing or invalid.
JSON
  • error
    string
    required

    Human-readable error description.

  • message
    optional
    string

    Optional underlying error message.

500

Internal failure while building the WMS request. Plain text, Cache-Control: no-store.

502

GeoServer WMS unreachable, or it answered a non-2xx status or a non-image body (a WMS ServiceException). Plain text, Cache-Control: no-store.

Type to search…

↑↓ navigate↵ selectEsc close