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(**kwargs) -> FeatureCollection { features, type }

GET/api/v1/search

Search OSM features by name

ParametersExpand Collapse

q: String

Search query string

cursor: String

Cursor for pagination

limit: Integer

Maximum results (default 25, max 100)

ReturnsExpand Collapse

class FeatureCollection { features, type }

Bare GeoJSON FeatureCollection. Pagination metadata is returned in HTTP headers (X-Limit, X-Has-More, X-Next-Cursor, X-Next-Offset, Link).

features: Array[GeoJsonFeature { geometry, properties, type, 2 more } ]

geometry: GeoJsonGeometry { coordinates, type }

coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array[Float]

Array[Array[Float]]

Array[Array[Array[Float]]]

Array[Array[Array[Array[Float]]]]

type: :Point | :LineString | :Polygon | 3 more

One of the following:

:Point

:LineString

:Polygon

:MultiPoint

:MultiLineString

:MultiPolygon

properties: Hash[Symbol, untyped]

type: :Feature

id: String

Feature identifier (type/osm_id)

osm_id: Integer

OpenStreetMap ID

type: :FeatureCollection

Search OSM features by name

Ruby

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

feature_collection = plaza.search.query(q: "q")

puts(feature_collection)

Returns Examples