API Reference

Search

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search OSM features by name

search().query(SearchQueryParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection

GET/api/v1/search

Search OSM features by name

ParametersExpand Collapse

params: SearchQueryParams

q: String

Search query string

cursor: Optional<String>

Cursor for pagination

limit: Optional<Long>

Maximum results (default 25, max 100)

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).

features: List<GeoJsonFeature>

geometry: GeoJsonGeometry

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

id: Optional<String>

Feature identifier (type/osm_id)

osmId: Optional<Long>

OpenStreetMap ID

type: Type

Search OSM features by name

Kotlin

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

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.SearchQueryParams

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

    val params: SearchQueryParams = SearchQueryParams.builder()
        .q("q")
        .build()
    val featureCollection: FeatureCollection = client.search().query(params)
}

Returns Examples