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(SearchQueryParams**kwargs) -> FeatureCollection

GET/api/v1/search

Search OSM features by name

ParametersExpand Collapse

q: str

Search query string

cursor: Optional[str]

Cursor for pagination

limit: Optional[int]

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: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

List[float]

List[List[float]]

List[List[List[float]]]

List[List[List[List[float]]]]

type: Literal["Point", "LineString", "Polygon", 3 more]

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: Dict[str, object]

type: Literal["Feature"]

id: Optional[str]

Feature identifier (type/osm_id)

osm_id: Optional[int]

OpenStreetMap ID

type: Literal["FeatureCollection"]

Search OSM features by name

Python

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

import os
from plaza import Plaza

client = Plaza(
    api_key=os.environ.get("PLAZA_API_KEY"),  # This is the default and can be omitted
)
feature_collection = client.search.query(
    q="q",
)
print(feature_collection.features)

Returns Examples