Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Search

Search OSM features by name

search().queryPost(SearchQueryPostParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection
POST/api/v1/search

Search OSM features by name

ParametersExpand Collapse
params: SearchQueryPostParams
q: String

Search query string

cursor: Optional<String>

Cursor for pagination

format: Optional<String>

Response format: json (default), geojson, csv, ndjson

limit: Optional<Long>

Maximum results (default 25, max 100)

outputFields: Optional<String>

Comma-separated property fields to include

outputInclude: Optional<String>

Extra computed fields: bbox, distance, center

outputPrecision: Optional<Long>

Coordinate decimal precision (1-15, default 7)

outputSort: Optional<String>

Sort by: distance, name, osm_id

ReturnsExpand Collapse
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<GeoJsonFeature>

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.

One of the following:
List<Double>
List<List<Double>>
List<List<List<Double>>>
List<List<List<List<Double>>>>
type: Type

Geometry type

One of the following:
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

id: Optional<String>

Compound identifier in type/osm_id format

type: Type

Always FeatureCollection

Search OSM features by name

package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.FeatureCollection
import com.plazafyi.models.search.SearchQueryPostParams

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: SearchQueryPostParams = SearchQueryPostParams.builder()
        .q("q")
        .build()
    val featureCollection: FeatureCollection = client.search().queryPost(params)
}
{
  "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"
}
Returns Examples
{
  "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"
}