latestOpenAPI 3.1.0Proprietary2026-08-175035117.5 KB

019f79ecdd6c

Maps

Get a map layer from a query

Returns metadata and URLs to fetch a map layer built from a SQL query.

Omit format to get the full response with a URL per available format. Pass format to get that single format directly.

get/v3/maps/{connectionName}/query

Path parameters

connectionNamestring required

Name of the connection to use.

Query parameters

qstring required

The SQL query, or the name of a named source.

queryParametersstring

Values for the parameters in the query, as a JSON string. Named object on BigQuery, positional array on Snowflake, Redshift and PostgreSQL.

spatialDataColumnstring

Column holding the geometry or spatial index. Defaults to geom. Required from v=3.3 onwards.

spatialDataType'geo' | 'h3' | 'h3int' | 'quadbin'

Type of the spatial column. Defaults to geo. Required from v=3.3 onwards.

geo_columnstring

Legacy way to select the geometry column, in the form [spatialIndexType:]columnName. Use spatialDataColumn and spatialDataType instead — from v=3.3 this parameter returns 400.

columnsstring

Comma-separated list of columns to return.

format'ndjson' | 'geojson' | 'json' | 'binary' | 'tilejson'

Return a single format instead of the full response. Omit to get URLs for every available format.

tileResolution0.25 | 0.5 | 1 | 2 | 4

Resolution of the generated tiles.

aggregationExpstring

Aggregation expression applied when building spatial index tiles, for example SUM(population) as population.

aggregationResLevelinteger

Resolution level for spatial index aggregation. Requires aggregationExp. Defaults to 6 for quadbin and 4 for H3.

v'3.0' | '3.1' | '3.2' | '3.3' | '3.4'

API version. From 3.3, spatialDataColumn and spatialDataType replace geo_column.

Response

Map layer metadata and download URLs.

sizeinteger

Size of the source in bytes.

nrowsinteger

Number of rows in the source.