# Elements ## Query features by spatial predicate, bounding box, or H3 cell `elements().query(ElementQueryParamsparams = ElementQueryParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection` **get** `/api/v1/features` Query features by spatial predicate, bounding box, or H3 cell ### Parameters - `params: ElementQueryParams` - `bbox: Optional` Legacy shorthand. Bounding box: south,west,north,east. Use spatial predicates (near, within, intersects) instead. - `contains: Optional` Geometry that features must contain - `crosses: Optional` Geometry that features must cross - `cursor: Optional` Cursor for pagination - `h3: Optional` Legacy shorthand. H3 cell index. Use spatial predicates instead. - `intersects: Optional` Geometry that features must intersect - `limit: Optional` Maximum results (default 100, max 10000) - `near: Optional` Point geometry for proximity search (lat,lng). Requires radius. - `outputBuffer: Optional` Buffer geometry by meters - `outputCentroid: Optional` Replace geometry with centroid - `outputFields: Optional` Comma-separated property fields to include - `outputGeometry: Optional` Include geometry (default true) - `outputInclude: Optional` Extra computed fields: bbox, distance, center - `outputPrecision: Optional` Coordinate decimal precision (1-15, default 7) - `outputSimplify: Optional` Simplify geometry tolerance in meters - `outputSort: Optional` Sort by: distance, name, osm_id - `radius: Optional` Search radius in meters (for near) or buffer distance (for other predicates) - `touches: Optional` Geometry that features must touch - `type: Optional` Element types (comma-separated: node,way,relation) - `within: Optional` Geometry that features must be within ### Returns - `class FeatureCollection:` GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body: | Header | Description | | --------------- | ------------------------------------------------ | | `X-Limit` | Requested result limit | | `X-Has-More` | `true` if more results exist | | `X-Next-Cursor` | Opaque cursor for next page (cursor pagination) | | `X-Next-Offset` | Numeric offset for next page (offset pagination) | | `Link` | RFC 8288 `rel="next"` link to the next page | Content-Type is `application/geo+json`. - `features: List` Array of GeoJSON Feature objects - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format - `type: Type` Always `FeatureCollection` - `FEATURE_COLLECTION("FeatureCollection")` ### Example ```kotlin 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 fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val featureCollection: FeatureCollection = client.elements().query() } ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ], "type": "FeatureCollection" } ``` ## Query features by spatial predicate, bounding box, or H3 cell `elements().queryPost(ElementQueryPostParamsparams = ElementQueryPostParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection` **post** `/api/v1/features` Query features by spatial predicate, bounding box, or H3 cell ### Parameters - `params: ElementQueryPostParams` - `bbox: Optional` Legacy shorthand. Bounding box: south,west,north,east. Use spatial predicates (near, within, intersects) instead. - `contains: Optional` Geometry that features must contain - `crosses: Optional` Geometry that features must cross - `cursor: Optional` Cursor for pagination - `h3: Optional` Legacy shorthand. H3 cell index. Use spatial predicates instead. - `intersects: Optional` Geometry that features must intersect - `limit: Optional` Maximum results (default 100, max 10000) - `near: Optional` Point geometry for proximity search (lat,lng). Requires radius. - `outputBuffer: Optional` Buffer geometry by meters - `outputCentroid: Optional` Replace geometry with centroid - `outputFields: Optional` Comma-separated property fields to include - `outputGeometry: Optional` Include geometry (default true) - `outputInclude: Optional` Extra computed fields: bbox, distance, center - `outputPrecision: Optional` Coordinate decimal precision (1-15, default 7) - `outputSimplify: Optional` Simplify geometry tolerance in meters - `outputSort: Optional` Sort by: distance, name, osm_id - `radius: Optional` Search radius in meters (for near) or buffer distance (for other predicates) - `touches: Optional` Geometry that features must touch - `type: Optional` Element types (comma-separated: node,way,relation) - `within: Optional` Geometry that features must be within ### Returns - `class FeatureCollection:` GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body: | Header | Description | | --------------- | ------------------------------------------------ | | `X-Limit` | Requested result limit | | `X-Has-More` | `true` if more results exist | | `X-Next-Cursor` | Opaque cursor for next page (cursor pagination) | | `X-Next-Offset` | Numeric offset for next page (offset pagination) | | `Link` | RFC 8288 `rel="next"` link to the next page | Content-Type is `application/geo+json`. - `features: List` Array of GeoJSON Feature objects - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format - `type: Type` Always `FeatureCollection` - `FEATURE_COLLECTION("FeatureCollection")` ### Example ```kotlin 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.ElementQueryPostParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val featureCollection: FeatureCollection = client.elements().queryPost() } ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ], "type": "FeatureCollection" } ``` ## Get feature by type and ID `elements().retrieve(ElementRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : GeoJsonFeature` **get** `/api/v1/features/{type}/{id}` Get feature by type and ID ### Parameters - `params: ElementRetrieveParams` - `type: String` - `id: Optional` ### Returns - `class GeoJsonFeature:` GeoJSON Feature representing an OSM element. Tags from the original OSM element are flattened directly into `properties` (not nested under a `tags` key). Metadata fields `@type` and `@id` identify the OSM element type and ID within properties. - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format ### Example ```kotlin package com.plazafyi.example import com.plazafyi.client.PlazaClient import com.plazafyi.client.okhttp.PlazaOkHttpClient import com.plazafyi.models.GeoJsonFeature import com.plazafyi.models.elements.ElementRetrieveParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val params: ElementRetrieveParams = ElementRetrieveParams.builder() .type("type") .id(0L) .build() val geoJsonFeature: GeoJsonFeature = client.elements().retrieve(params) } ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ``` ## Get feature by type and ID `elements().lookup(ElementLookupParamsparams = ElementLookupParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : GeoJsonFeature` **post** `/api/v1/features/lookup` Get feature by type and ID ### Parameters - `params: ElementLookupParams` ### Returns - `class GeoJsonFeature:` GeoJSON Feature representing an OSM element. Tags from the original OSM element are flattened directly into `properties` (not nested under a `tags` key). Metadata fields `@type` and `@id` identify the OSM element type and ID within properties. - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format ### Example ```kotlin package com.plazafyi.example import com.plazafyi.client.PlazaClient import com.plazafyi.client.okhttp.PlazaOkHttpClient import com.plazafyi.models.GeoJsonFeature import com.plazafyi.models.elements.ElementLookupParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val geoJsonFeature: GeoJsonFeature = client.elements().lookup() } ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ``` ## Fetch multiple features by type and ID `elements().batch(ElementBatchParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection` **post** `/api/v1/features/batch` Fetch multiple features by type and ID ### Parameters - `params: ElementBatchParams` - `batchRequest: BatchRequest` Fetch multiple OSM elements by their type and ID in a single request. Maximum 100 elements per batch. ### Returns - `class FeatureCollection:` GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body: | Header | Description | | --------------- | ------------------------------------------------ | | `X-Limit` | Requested result limit | | `X-Has-More` | `true` if more results exist | | `X-Next-Cursor` | Opaque cursor for next page (cursor pagination) | | `X-Next-Offset` | Numeric offset for next page (offset pagination) | | `Link` | RFC 8288 `rel="next"` link to the next page | Content-Type is `application/geo+json`. - `features: List` Array of GeoJSON Feature objects - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format - `type: Type` Always `FeatureCollection` - `FEATURE_COLLECTION("FeatureCollection")` ### Example ```kotlin 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.BatchRequest import com.plazafyi.models.elements.ElementBatchParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val params: BatchRequest = BatchRequest.builder() .addElement(BatchRequest.Element.builder() .id(21154906L) .type(BatchRequest.Element.Type.NODE) .build()) .addElement(BatchRequest.Element.builder() .id(4589123L) .type(BatchRequest.Element.Type.WAY) .build()) .build() val featureCollection: FeatureCollection = client.elements().batch(params) } ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ], "type": "FeatureCollection" } ``` ## Find features near a geographic point `elements().nearby(ElementNearbyParamsparams = ElementNearbyParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection` **get** `/api/v1/features/nearby` Find features near a geographic point ### Parameters - `params: ElementNearbyParams` - `lat: Optional` Legacy shorthand. Latitude (-90 to 90). Use near param instead. - `limit: Optional` Maximum results (default 20, max 100) - `lng: Optional` Legacy shorthand. Longitude (-180 to 180). Use near param instead. - `near: Optional` Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params. - `outputBuffer: Optional` Buffer geometry by meters - `outputCentroid: Optional` Replace geometry with centroid - `outputFields: Optional` Comma-separated property fields to include - `outputGeometry: Optional` Include geometry (default true) - `outputInclude: Optional` Extra computed fields: bbox, distance, center - `outputPrecision: Optional` Coordinate decimal precision (1-15, default 7) - `outputSimplify: Optional` Simplify geometry tolerance in meters - `outputSort: Optional` Sort by: distance, name, osm_id - `radius: Optional` Search radius in meters (default 500, max 10000) ### Returns - `class FeatureCollection:` GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body: | Header | Description | | --------------- | ------------------------------------------------ | | `X-Limit` | Requested result limit | | `X-Has-More` | `true` if more results exist | | `X-Next-Cursor` | Opaque cursor for next page (cursor pagination) | | `X-Next-Offset` | Numeric offset for next page (offset pagination) | | `Link` | RFC 8288 `rel="next"` link to the next page | Content-Type is `application/geo+json`. - `features: List` Array of GeoJSON Feature objects - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format - `type: Type` Always `FeatureCollection` - `FEATURE_COLLECTION("FeatureCollection")` ### Example ```kotlin 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.ElementNearbyParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val featureCollection: FeatureCollection = client.elements().nearby() } ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ], "type": "FeatureCollection" } ``` ## Find features near a geographic point `elements().nearbyPost(ElementNearbyPostParamsparams = ElementNearbyPostParams.none(), RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection` **post** `/api/v1/features/nearby` Find features near a geographic point ### Parameters - `params: ElementNearbyPostParams` - `lat: Optional` Legacy shorthand. Latitude (-90 to 90). Use near param instead. - `limit: Optional` Maximum results (default 20, max 100) - `lng: Optional` Legacy shorthand. Longitude (-180 to 180). Use near param instead. - `near: Optional` Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params. - `outputBuffer: Optional` Buffer geometry by meters - `outputCentroid: Optional` Replace geometry with centroid - `outputFields: Optional` Comma-separated property fields to include - `outputGeometry: Optional` Include geometry (default true) - `outputInclude: Optional` Extra computed fields: bbox, distance, center - `outputPrecision: Optional` Coordinate decimal precision (1-15, default 7) - `outputSimplify: Optional` Simplify geometry tolerance in meters - `outputSort: Optional` Sort by: distance, name, osm_id - `radius: Optional` Search radius in meters (default 500, max 10000) ### Returns - `class FeatureCollection:` GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body: | Header | Description | | --------------- | ------------------------------------------------ | | `X-Limit` | Requested result limit | | `X-Has-More` | `true` if more results exist | | `X-Next-Cursor` | Opaque cursor for next page (cursor pagination) | | `X-Next-Offset` | Numeric offset for next page (offset pagination) | | `Link` | RFC 8288 `rel="next"` link to the next page | Content-Type is `application/geo+json`. - `features: List` Array of GeoJSON Feature objects - `geometry: GeoJsonGeometry` GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints. - `coordinates: Coordinates` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `List` - `List>` - `List>>` - `List>>>` - `type: Type` Geometry type - `POINT("Point")` - `LINE_STRING("LineString")` - `POLYGON("Polygon")` - `MULTI_POINT("MultiPoint")` - `MULTI_LINE_STRING("MultiLineString")` - `MULTI_POLYGON("MultiPolygon")` - `properties: Properties` OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries. - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format - `type: Type` Always `FeatureCollection` - `FEATURE_COLLECTION("FeatureCollection")` ### Example ```kotlin 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.ElementNearbyPostParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val featureCollection: FeatureCollection = client.elements().nearbyPost() } ``` #### Response ```json { "features": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ], "type": "FeatureCollection" } ``` ## Domain Types ### Batch Request - `class BatchRequest:` Fetch multiple OSM elements by their type and ID in a single request. Maximum 100 elements per batch. - `elements: List` Array of element references to fetch - `id: Long` OSM element ID - `type: Type` OSM element type - `NODE("node")` - `WAY("way")` - `RELATION("relation")`