3DCityLoader CLI Tool

The 3DCityLoader Command Line Inteface provides a interface for interacting with the API and handling file downloads.

1. Install the 3DCityLoader CLI Tool

Download the latest release of the 3DCityLoader CLI Tool for your operating system an arcitecture:
Unzip the file: tar -xvf 3dcl_XXX.tar.gz

Optionally, move the binary in a location where you can execute it globally: mv 3dcl /usr/local/bin/3dcl

2. Download a 3D City Model

To download a 3D model, you need to provide a bounding box, a center point, or an address to the
3dcl export command.

Before you can make requests to the API, you will need to create an API token for your account and ensure that a valid payment method is set up. You can find it under Account Settings » API Tokens. Adding a payment method will not trigger any costs; you will only be charged for the services you use.

The permissions export.create, export.read, and export.pay are required to use the Simple Export API via CLI.

The token can be passed as an environment variable CITYLOADER_API_TOKEN or as a flag --api-token.

In the following example, we will download a 3D model of Berlin, Germany in STL format and save the extracted file to the './download' directory, ready for further processing.

    3dcl --api-token XXX export --address "Berlin, Germany" -f stl -o download

Another example shows how to download a 3D terrain model of the alps ready for 3d printing defined by a bbox as STL file scaled to 200x200mm with a base height of 10mm and a coordinate system of EPSG:3857. Use -srs 3857to preserve the correct aspect ratio from the input bounding box, while keeping the correct z scale by setting the --sz flag. The file is saved as output.stl in the current directory.

    3dcl --api-token XXX export --bbox "7.631465,45.953811,7.686851,45.992304" -i terrain --srs 3857 --sz --tsx 200 --base-height 10  --of output.stl

Run 3dcl --help export to see all available options.