API Reference
Log In
API Reference

/tours/{tourId}/route-map

get
https://api.dev.orbit.do/v5/tours//route-map

Returns a URL to a rendered route-map image for the tour's stops. The URL points to a publicly accessible PNG that can be embedded directly, for example in an email. Pick the shape with format. The first request for a tour and format may take a moment while the image is rendered; later requests are served from cache.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
enum
Defaults to standard

Size and aspect ratio of the image. standard is 800x400 and is used when the parameter is omitted, wide is 1280x640 (2:1), square is 1280x1280 (1:1). The route line and the stop markers are scaled to the format, so a larger image is drawn with a heavier line and larger markers rather than the same thin one. Each format is cached and addressed separately, so the same tour has a different URL per format.

Allowed:
Responses

400

unknown value for format

401

unauthorized

404

tour not found or has no stop coordinates

Updated about 1 month ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?