routing

Forecast weather along a route, aligned to each point's ETA (see module docs).

post/v1/weather/along

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/v1/weather/along
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Request body

depart_atstring nullable

Departure time, RFC 3339; defaults to now.

duration_snumber double nullable

Total route duration in seconds, used to compute each sample's ETA by arc-length fraction. Omit to fall back to a generic [DEFAULT_AVERAGE_SPEED_KPH] estimate (flagged in the response as duration_source: "estimated_default_speed"); pass the real value from /route for accurate alignment.

sample_interval_mnumber double nullable

Route-sampling interval in metres; default 25,000, clamped to 5,000–100,000, and the point count is separately capped at [MAX_SAMPLES].

shapestring required

The route shape as a polyline6 string.

Response

Per-sample weather aligned to each point's estimated time of arrival

attributionstring nullable

The credit to show next to the forecast, verbatim. Present when at least one sample carries real data.

attribution_urlstring nullable

Where the credit links (https://open-meteo.com/): Open-Meteo's licence asks for a link next to any place its data is displayed. Present exactly when attribution is.

depart_atstring required

The departure time actually used (RFC 3339 UTC).

derived_fieldsstring[] nullable

The sample fields MapMap derives rather than reads from Open-Meteo (precipitation_type from rain and snowfall, severe from the WMO code), so a display can indicate the changes the licence asks to be indicated. Present exactly when attribution is.

duration_snumber double required

The route duration actually used, seconds.

duration_sourcestring required

provided | estimated_default_speed, see [DurationSource].

licence_urlstring nullable

The data licence to link with the credit (CC BY 4.0). Present exactly when attribution is.

sample_interval_mnumber double required

The sampling interval actually used, metres (after clamping/the [MAX_SAMPLES] cap, may be coarser than requested on a long route).

Changes

No recorded changes to this operation across all 1 revision of this API.