Skip to content
GuidesPlaygroundDashboard

Query features by bounding box or H3 cell

FeatureCollection elements().query(ElementQueryParamsparams = ElementQueryParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/features

Query features by bounding box or H3 cell

ParametersExpand Collapse
ElementQueryParams params
Optional<String> bbox

Bounding box: south,west,north,east. At least one of bbox or h3 is required.

Optional<String> cursor

Cursor for pagination

Optional<String> h3

H3 cell index. At least one of bbox or h3 is required.

Optional<Long> limit

Maximum results (default 100, max 10000)

Optional<String> type

Element types (comma-separated: node,way,relation)

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

Query features by bounding box or H3 cell

package com.plazafyi.example;

import com.plazafyi.client.PlazaClient;
import com.plazafyi.client.okhttp.PlazaOkHttpClient;
import com.plazafyi.models.FeatureCollection;
import com.plazafyi.models.elements.ElementQueryParams;

public final class Main {
    private Main() {}

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

        FeatureCollection featureCollection = client.elements().query();
    }
}
Returns Examples