Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Query

Execute an Overpass QL query

FeatureCollection query().overpass(QueryOverpassParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/api/v1/overpass

Execute an Overpass QL query

ParametersExpand Collapse
QueryOverpassParams params
OverpassQuery overpassQuery
ReturnsExpand Collapse
class FeatureCollection:

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

List<GeoJsonFeature> features
Coordinates coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List<double>
List<List<double>>
List<List<List<double>>>
List<List<List<List<double>>>>
Type type
One of the following:
POINT("Point")
LINE_STRING("LineString")
POLYGON("Polygon")
MULTI_POINT("MultiPoint")
MULTI_LINE_STRING("MultiLineString")
MULTI_POLYGON("MultiPolygon")
Properties properties
Type type
Optional<String> id

Feature identifier (type/osm_id)

Optional<Long> osmId

OpenStreetMap ID

Type type

Execute an Overpass QL query

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.FeatureCollection;
import com.plazafyi.models.query.OverpassQuery;
import com.plazafyi.models.query.QueryOverpassParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        PlazaClient client = PlazaOkHttpClient.fromEnv();

        OverpassQuery params = OverpassQuery.builder()
            .data("data")
            .build();
        FeatureCollection featureCollection = client.query().overpass(params);
    }
}
Returns Examples