Platform Book a call

API documentation

Python and TypeScript SDKs and the REST API for urban climate simulation: install, get a key, run your first area. The full guide is on our docs site.

Quickstart

Install the SDK, get an API key from the platform, set INFRARED_API_KEY and run your first area in a few lines of Python or TypeScript.

Get an API key

  1. Sign up at platform.infrared.city. The free plan includes 900 tokens for 42 days.
  2. Create an API key in the platform.
  3. Set the key as the environment variable INFRARED_API_KEY. The SDK examples read it from there.
# pip install infrared-sdk   (set INFRARED_API_KEY)
from infrared_sdk import InfraredClient, SvfModelRequest
from infrared_sdk.analyses.types import AnalysesName

client = InfraredClient()
request = SvfModelRequest(analysis_type=AnalysesName.sky_view_factors)
result = client.run_area_and_wait(request, site, buildings=my_buildings)
grid = result.physical_grid()   # one value per cell, NaN = no value

The SDK splits large areas into tiles, runs them and merges the result. A free preview tells you how many jobs a run will bill before you start.

Read the SDK guide