API Reference

Search

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search OSM features by name

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

GET/api/v1/search

Search OSM features by name

ParametersExpand Collapse

SearchQueryParams params

String q

Search query string

Optional<String> cursor

Cursor for pagination

Optional<Long> limit

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

List<GeoJsonFeature> features

GeoJsonGeometry geometry

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

Search OSM features by name

Java

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;

public final class Main {
    private Main() {}

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

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

Returns Examples