---
title: "Extreme year (hot, cold, heatwave, moisture, P90 solar, ...)"
method: POST
path: "/api/generate/xmy"
tags: ["Generate weather files"]
---

# Extreme year (hot, cold, heatwave, moisture, P90 solar, ...)

`POST /api/generate/xmy`

## Request

- Base URL: `https://epw.tools`
- URL: `https://epw.tools/api/generate/xmy`
- Auth: API key in header `X-API-Key`

Extreme year picked from a range of actual years by the chosen criterion. 1 credit.

Starts a background job and returns `{"job_id": ...}` immediately. Credits are charged on submission and refunded if the job fails; the balance after the call is in the `X-Credits-Remaining` response header. Then poll `GET /api/jobs/{job_id}`, stream `/api/jobs/{job_id}/stream`, or register a webhook.

## Headers

- `X-API-Key` string, nullable

## Request body

- XMYRequest
  - `lat` number, required
  - `lon` number, required
  - `location_name` string, required
  - `start_year` integer, required
  - `end_year` integer, required
  - `mode` string
  - `dc_edition` string
  - `data_source` string
  - `design_years` string

## Response `200`

Successful Response

- unknown

## Other responses

- `402`: Insufficient credits for this operation.
- `422`: Validation Error
- `429`: Rate limit exceeded — retry after a short delay.

---

[API](https://skmtc.dev/epw/apis/epw-tools-api.md) · [All operations](https://skmtc.dev/epw/apis/epw-tools-api/llms.txt) · [OpenAPI document](https://skmtc.dev/epw/apis/epw-tools-api/revisions/e6b60fc7a6d7?raw)