Generate weather files

Typical year (TMY: Sandia, ISO 15927-4 or custom weights)

Typical year built from a range of actual years (Sandia by default; ISO 15927-4 and custom weights need a paid account). 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.

post/api/generate/tmy

Request

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

Headers

X-API-Keystring nullable

Request body

latnumber required
lonnumber required
location_namestring required
start_yearinteger required
end_yearinteger required
dc_editionstring
weightsobject
data_sourcestring
use_casestring
recency_halflife_yearsnumber nullable
tmy_methodstring
design_yearsstring

Response

Successful Response

unknown required

Changes

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