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 an Overpass QL query

ParametersExpand Collapse
body: QueryOverpassParams { data }
data: string

Overpass QL query string

ReturnsExpand Collapse
FeatureCollection { features, type }

Bare GeoJSON FeatureCollection. Pagination metadata is returned in HTTP headers (X-Limit, X-Has-More, X-Next-Cursor, X-Next-Offset, Link).

features: Array<GeoJsonFeature { geometry, properties, type, 2 more } >
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"

Execute an Overpass QL query

import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const featureCollection = await client.query.overpass({ data: 'data' });

console.log(featureCollection.features);
Returns Examples