> For the complete documentation index, see [llms.txt](https://cityweft.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cityweft.gitbook.io/docs/readme.md).

# Welcome

Welcome to the **Cityweft API** — your gateway to high-quality, context-rich **3D city models**, **terrain data**, and **infrastructure information** across the globe.

Cityweft provides developers, designers, and AEC professionals with seamless access to:

* ⚙️ Accurate 3D urban models
* 🏗️ Infrastructure data
* 🗺️ Geo-referenced terrain meshes
* 🚦 Smart metadata for early-stage planning

Our API is designed to integrate effortlessly with your platform, enabling dynamic urban context loading, site analysis, and location-specific decision-making — all with just a few lines of code.

Whether you're building a digital twin, urban planning tool, or a generative design platform, **Cityweft** helps you start every project with the right data in a flexible format.

{% hint style="info" %}
The API is under active development. While we aim to avoid breaking changes in existing versions, some parameters may still change.
{% endhint %}

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Basic Overview on How to Access and Work With Cityweft's Output</td><td><a href="/files/1z6B1t4uPWHnAmFvH56k">/files/1z6B1t4uPWHnAmFvH56k</a></td><td></td><td><a href="/pages/CyH2xJQs9yWJ1S8BYNav">/pages/CyH2xJQs9yWJ1S8BYNav</a></td></tr><tr><td><strong>Three.js Guide</strong></td><td>Learn How To Quickly Integrate the Urban Context to Your Three.js Scene</td><td><a href="/files/33soeSv4e5CJxE4v1S4t">/files/33soeSv4e5CJxE4v1S4t</a></td><td></td><td><a href="/pages/JjjojIyKxaiBPzzLwvtg">/pages/JjjojIyKxaiBPzzLwvtg</a></td></tr><tr><td><strong>Customizations</strong></td><td>Explore Advanced API Settings Designed to Customize Your Output</td><td><a href="/files/Wz94yyABeI6OZdUOkCaB">/files/Wz94yyABeI6OZdUOkCaB</a></td><td></td><td><a href="/pages/DSQqnsAqJPnIRyPgQJ1S">/pages/DSQqnsAqJPnIRyPgQJ1S</a></td></tr></tbody></table>

### Geometry Types

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th><select multiple><option value="GXJDE1CloO2K" label="Meshes" color="blue"></option><option value="P8roCyk5SLOJ" label="Nodes" color="blue"></option><option value="00g40lPSezeL" label="ElevationMaps" color="blue"></option></select></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th></tr></thead><tbody><tr><td><strong>Buildings</strong></td><td>Buildings Geometry  </td><td><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/pages/ZXxfwYY21Yz9PCv9X7ja">/pages/ZXxfwYY21Yz9PCv9X7ja</a></td><td><a href="/files/BOm9MOXNO2RmZCGcYlL6">/files/BOm9MOXNO2RmZCGcYlL6</a></td><td></td></tr><tr><td><strong>Barriers</strong></td><td>Walls &#x26; Fences Geometry</td><td><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/pages/ZsB8hDaBeC6Pmn10p5cu">/pages/ZsB8hDaBeC6Pmn10p5cu</a></td><td><a href="/files/AvGM8Z5DGRpYtU1AHwYh">/files/AvGM8Z5DGRpYtU1AHwYh</a></td><td></td></tr><tr><td><strong>Surface</strong></td><td>Surface Geometry</td><td><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/pages/HPgwnZuyemXTFjfBHW39">/pages/HPgwnZuyemXTFjfBHW39</a></td><td><a href="/files/zrWifafreaHQEjkSxROQ">/files/zrWifafreaHQEjkSxROQ</a></td><td></td></tr><tr><td><strong>Infrastructure</strong></td><td>Surface Information</td><td><span data-option="P8roCyk5SLOJ">Nodes</span></td><td><a href="/pages/oa0XskrCEgbVlYaOnehE">/pages/oa0XskrCEgbVlYaOnehE</a></td><td><a href="/files/gr9o8LV7dWl0ZcJ3Raws">/files/gr9o8LV7dWl0ZcJ3Raws</a></td><td></td></tr><tr><td><strong>Topography</strong></td><td>Topography geometry</td><td><span data-option="00g40lPSezeL">ElevationMaps, </span><span data-option="GXJDE1CloO2K">Meshes</span></td><td><a href="/pages/QwHFLVleY7QejI9V4gc3">/pages/QwHFLVleY7QejI9V4gc3</a></td><td><a href="/files/28nesxSgVMKfW3CnyGGx">/files/28nesxSgVMKfW3CnyGGx</a></td><td></td></tr></tbody></table>