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.
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
- Sign up at platform.infrared.city. The free plan includes 900 tokens for 42 days.
- Create an API key in the platform.
- 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)
# Buildings outside our served cities: pip install "infrared-sdk[geodata]"
from infrared_sdk import InfraredClient, SvfModelRequest
from infrared_sdk.analyses.types import AnalysesName
area = {"type": "Polygon", "coordinates": [[ # a block in Vienna
[16.369, 48.207], [16.373, 48.207], [16.373, 48.209],
[16.369, 48.209], [16.369, 48.207]]]}
with InfraredClient() as client:
buildings = client.buildings.get_area(area)
result = client.run_area_and_wait(
SvfModelRequest(analysis_type=AnalysesName.sky_view_factors),
area, buildings=buildings)
grid = result.physical_grid() # sky view factor, 0 to 100 %
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