Python SDK quickstart

Requires: Python and an API key. The GeoDataFrame and download methods need an active license for the dataset and consume credits. The SDK is in preview; the REST API it wraps is generally available.

Install and create a client

Install topolab (add the [geo] extras for GeoPandas support) and construct a Client with your key. Load the key from the environment rather than hard-coding it. Datasets are addressed by their table name, such as nl-domino-poi.

pip install "topolab[geo]"

import os
from topolab import Client

tl = Client(api_key=os.environ["TOPOLAB_API_KEY"])

Read a GeoDataFrame

.to_geodataframe() downloads the dataset and parses it into a GeoPandas GeoDataFrame with geometry in WGS84 (EPSG:4326). This pulls the full export, so it consumes credits and requires an active license for the dataset. Use .sample() first to check the schema for free.

gdf = tl.dataset("nl-domino-poi").to_geodataframe()
gdf.plot()

GA equivalent while the SDK is in preview

The generally available path is the GeoJSON download endpoint, which you can read straight into GeoPandas: curl the /files/geojson endpoint with your X-API-Key header, then gpd.read_file(...) the result. The Client targets production by default; pass environment="staging" to switch.