# Query ## Execute a multi-step query pipeline `query().execute(QueryExecuteParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : QueryExecuteResponse` **post** `/api/v1/query` Execute a multi-step query pipeline ### Parameters - `params: QueryExecuteParams` - `steps: List` Ordered list of query steps to execute - `type: Type` Step type: `overpass`, `sparql`, `filter`, or `transform` - `OVERPASS("overpass")` - `SPARQL("sparql")` - `FILTER("filter")` - `TRANSFORM("transform")` - `query: Optional` Query string for this step (required for overpass/sparql steps) ### Returns - `class QueryExecuteResponse:` Pipeline execution result containing the output of each step. - `steps: List` Results from each pipeline step in execution order ### Example ```kotlin package com.plazafyi.example import com.plazafyi.client.PlazaClient import com.plazafyi.client.okhttp.PlazaOkHttpClient import com.plazafyi.models.query.QueryExecuteParams import com.plazafyi.models.query.QueryExecuteResponse fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val params: QueryExecuteParams = QueryExecuteParams.builder() .addStep(QueryExecuteParams.Step.builder() .type(QueryExecuteParams.Step.Type.OVERPASS) .build()) .build() val response: QueryExecuteResponse = client.query().execute(params) } ``` #### Response ```json { "steps": [ { "foo": "bar" } ] } ``` ## Execute an Overpass QL query `query().overpass(QueryOverpassParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection` **post** `/api/v1/overpass` Execute an Overpass QL query ### Parameters - `params: QueryOverpassParams` - `overpassQuery: OverpassQuery` Overpass QL query request. The query is executed against Plaza's OSM database and results are returned as GeoJSON. ### 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.query.OverpassQuery import com.plazafyi.models.query.QueryOverpassParams fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val params: OverpassQuery = OverpassQuery.builder() .data("[out:json];node[amenity=cafe](around:500,48.8566,2.3522);out body;") .build() val featureCollection: FeatureCollection = client.query().overpass(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" } ``` ## Execute a SPARQL query `query().sparql(QuerySparqlParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : SparqlResult` **post** `/api/v1/sparql` Execute a SPARQL query ### Parameters - `params: QuerySparqlParams` - `sparqlQuery: SparqlQuery` SPARQL query request. Queries OSM data using SPARQL syntax. Results are returned as a JSON object with a `results` array. ### Returns - `class SparqlResult:` SPARQL query result. Contains a `results` array of GeoJSON Feature objects. Unlike REST feature endpoints, SPARQL results may omit `@type`, `@id`, and compound `id` fields depending on the query shape. - `results: List` Array of GeoJSON Features matching the SPARQL query. Features include `@type` and `@id` metadata when the source element type is known, but may contain only tags as properties for untyped results. - `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 as key-value pairs, optionally with `@type` and `@id` metadata - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format (present when element type is known) ### Example ```kotlin package com.plazafyi.example import com.plazafyi.client.PlazaClient import com.plazafyi.client.okhttp.PlazaOkHttpClient import com.plazafyi.models.query.QuerySparqlParams import com.plazafyi.models.query.SparqlQuery import com.plazafyi.models.query.SparqlResult fun main() { val client: PlazaClient = PlazaOkHttpClient.fromEnv() val params: SparqlQuery = SparqlQuery.builder() .query("SELECT ?s ?name WHERE { ?s osm:name ?name . ?s osm:amenity \"cafe\" } LIMIT 10") .build() val sparqlResult: SparqlResult = client.query().sparql(params) } ``` #### Response ```json { "results": [ { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "foo": "bar" }, "type": "Feature", "id": "id" } ] } ``` ## Domain Types ### Overpass Query - `class OverpassQuery:` Overpass QL query request. The query is executed against Plaza's OSM database and results are returned as GeoJSON. - `data: String` Overpass QL query string ### Sparql Query - `class SparqlQuery:` SPARQL query request. Queries OSM data using SPARQL syntax. Results are returned as a JSON object with a `results` array. - `query: String` SPARQL query string ### Sparql Result - `class SparqlResult:` SPARQL query result. Contains a `results` array of GeoJSON Feature objects. Unlike REST feature endpoints, SPARQL results may omit `@type`, `@id`, and compound `id` fields depending on the query shape. - `results: List` Array of GeoJSON Features matching the SPARQL query. Features include `@type` and `@id` metadata when the source element type is known, but may contain only tags as properties for untyped results. - `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 as key-value pairs, optionally with `@type` and `@id` metadata - `type: Type` Always `Feature` - `FEATURE("Feature")` - `id: Optional` Compound identifier in `type/osm_id` format (present when element type is known)