## Search OSM features by name

`client.search.query(SearchQueryParamsquery, RequestOptionsoptions?): FeatureCollection`

**get** `/api/v1/search`

Search OSM features by name

### Parameters

- `query: SearchQueryParams`

  - `q: string`

    Search query string

  - `cursor?: string`

    Cursor for pagination

  - `limit?: number`

    Maximum results (default 25, max 100)

### Returns

- `FeatureCollection`

  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: GeoJsonGeometry`

      - `coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Record<string, unknown>`

    - `type: "Feature"`

      - `"Feature"`

    - `id?: string`

      Feature identifier (type/osm_id)

    - `osm_id?: number`

      OpenStreetMap ID

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
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);
```