API Reference

Search

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search OSM features by name

client.search.query(SearchQueryParams { q, cursor, limit } query, RequestOptionsoptions?): FeatureCollection { features, type }

GET/api/v1/search

Search OSM features by name

ParametersExpand Collapse

query: SearchQueryParams { q, cursor, limit }

q: string

Search query string

cursor?: string

Cursor for pagination

limit?: number

Maximum results (default 25, max 100)

ReturnsExpand Collapse

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<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

Array<number>

Array<Array<number>>

Array<Array<Array<number>>>

Array<Array<Array<Array<number>>>>

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

One of the following:

"Point"

"LineString"

"Polygon"

"MultiPoint"

"MultiLineString"

"MultiPolygon"

properties: Record<string, unknown>

type: "Feature"

id?: string

Feature identifier (type/osm_id)

osm_id?: number

OpenStreetMap ID

type: "FeatureCollection"

Search OSM features by name

TypeScript

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const featureCollection = await client.search.query({ q: 'q' });

console.log(featureCollection.features);

Returns Examples