create_heatmap
Generate a temperature heatmap for a specified urban area and time range. Provide a GeoJSON polygon and filter type to receive inline results or an activity ID to retrieve later.
Instructions
Run a temperature heatmap and wait for the result inline. Measured heatmaps take 21-38 seconds. If the wait runs out you get the activity_id back and nothing is lost - the job keeps running and check_status collects it. An identical earlier request is served from the local archive for free. filter_type: 1 = single hour (start_date + start_time); 2 = range of hours, same day (start_date + start_time + end_time); 3 = single day (start_date only); 4 = range of days (start_date + end_date). granularity is the tile edge in metres (60, 80, 100); omit it to let the API choose. analytic_type is optional (tcm, time_of_measure, exceedance, persistence); omit it for plain temperature. start_time is interpreted as local time at the area of interest, not UTC.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | auto = the raw API payload when it fits the context budget, otherwise a summary naming every way to fetch it. geojson = the raw payload whatever its size. columnar = a compact table, about 12x smaller. | auto |
| wait_s | No | Seconds to wait inline before returning the activity_id instead. | |
| end_date | No | ||
| end_time | No | ||
| direction | No | ||
| threshold | No | ||
| start_date | No | ||
| start_time | No | HH:MM, local to the area, not UTC. | |
| filter_type | No | 1 = single hour (start_date + start_time); 2 = range of hours, same day (start_date + start_time + end_time); 3 = single day (start_date only); 4 = range of days (start_date + end_date) | |
| granularity | No | Tile edge in metres: 60, 80, 100. | |
| polygon_aoi | Yes | Area of interest as GeoJSON. | |
| analytic_type | No | Optional analytic: tcm, time_of_measure, exceedance, persistence. |