Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference

Query

Execute an Overpass QL query
client.query.overpass(QueryOverpassParams { data } body, RequestOptionsoptions?): FeatureCollection { features, type }
POST/api/v1/overpass
Execute a SPARQL query
client.query.sparql(QuerySparqlParams { query } body, RequestOptionsoptions?): SparqlResult { features, type }
POST/api/v1/sparql
ModelsExpand Collapse
OverpassQuery { data }
data: string

Overpass QL query string

SparqlQuery { query }
query: string

SPARQL query string

SparqlResult { features, type }

GeoJSON FeatureCollection of SPARQL query results

features: Array<GeoJsonFeature { geometry, properties, type, 2 more } >

GeoJSON features from SPARQL query

geometry: GeoJsonGeometry { coordinates, type }
coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Record<string, unknown>
type: "Feature"
id?: string

Feature identifier (type/osm_id)

osm_id?: number

OpenStreetMap ID

type: "FeatureCollection"