# Search

## Search OSM features by name

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

Search OSM features by name

### Query Parameters

- `q: string`

  Search query string

- `cursor: optional string`

  Cursor for pagination

- `limit: optional number`

  Maximum results (default 25, max 100)

### Returns

- `FeatureCollection = object { 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 of GeoJsonFeature`

    - `geometry: GeoJsonGeometry`

      - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

        GeoJSON coordinates array (nesting depth varies by geometry type)

        - `array of number`

        - `array of array of number`

        - `array of array of array of number`

        - `array of array of array of array of number`

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

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: map[unknown]`

    - `type: "Feature"`

      - `"Feature"`

    - `id: optional string`

      Feature identifier (type/osm_id)

    - `osm_id: optional number`

      OpenStreetMap ID

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```http
curl https://plaza.fyi/api/v1/search \
    -H "Authorization: Bearer $PLAZA_API_KEY"
```