# Search

## Search OSM features by name

`search.query(SearchQueryParams**kwargs)  -> FeatureCollection`

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

Search OSM features by name

### Parameters

- `q: str`

  Search query string

- `cursor: Optional[str]`

  Cursor for pagination

- `limit: Optional[int]`

  Maximum results (default 25, max 100)

- `output_fields: Optional[str]`

  Comma-separated property fields to include

- `output_include: Optional[str]`

  Extra computed fields: bbox, distance, center

- `output_precision: Optional[int]`

  Coordinate decimal precision (1-15, default 7)

- `output_sort: Optional[str]`

  Sort by: distance, name, osm_id

### Returns

- `class FeatureCollection: …`

  GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body:

| Header          | Description                                      |
| --------------- | ------------------------------------------------ |
| `X-Limit`       | Requested result limit                           |
| `X-Has-More`    | `true` if more results exist                     |
| `X-Next-Cursor` | Opaque cursor for next page (cursor pagination)  |
| `X-Next-Offset` | Numeric offset for next page (offset pagination) |
| `Link`          | RFC 8288 `rel="next"` link to the next page      |

  Content-Type is `application/geo+json`.

  - `features: List[GeoJsonFeature]`

    Array of GeoJSON Feature objects

    - `geometry: GeoJsonGeometry`

      GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

      - `coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]`

        Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

        - `List[float]`

          [longitude, latitude] or [longitude, latitude, elevation]

        - `List[List[float]]`

          Array of [lng, lat] positions

        - `List[List[List[float]]]`

          Array of linear rings / line strings

        - `List[List[List[List[float]]]]`

          Array of polygons

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Dict[str, object]`

      OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries.

    - `type: Literal["Feature"]`

      Always `Feature`

      - `"Feature"`

    - `id: Optional[str]`

      Compound identifier in `type/osm_id` format

  - `type: Literal["FeatureCollection"]`

    Always `FeatureCollection`

    - `"FeatureCollection"`

### Example

```python
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)
```

#### Response

```json
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "@id": "bar",
        "@type": "bar",
        "amenity": "bar",
        "cuisine": "bar",
        "name": "bar"
      },
      "type": "Feature",
      "id": "node/21154906"
    }
  ],
  "type": "FeatureCollection"
}
```

## Search OSM features by name

`search.query_post(SearchQueryPostParams**kwargs)  -> FeatureCollection`

**post** `/api/v1/search`

Search OSM features by name

### Parameters

- `q: str`

  Search query string

- `cursor: Optional[str]`

  Cursor for pagination

- `limit: Optional[int]`

  Maximum results (default 25, max 100)

- `output_fields: Optional[str]`

  Comma-separated property fields to include

- `output_include: Optional[str]`

  Extra computed fields: bbox, distance, center

- `output_precision: Optional[int]`

  Coordinate decimal precision (1-15, default 7)

- `output_sort: Optional[str]`

  Sort by: distance, name, osm_id

### Returns

- `class FeatureCollection: …`

  GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body:

| Header          | Description                                      |
| --------------- | ------------------------------------------------ |
| `X-Limit`       | Requested result limit                           |
| `X-Has-More`    | `true` if more results exist                     |
| `X-Next-Cursor` | Opaque cursor for next page (cursor pagination)  |
| `X-Next-Offset` | Numeric offset for next page (offset pagination) |
| `Link`          | RFC 8288 `rel="next"` link to the next page      |

  Content-Type is `application/geo+json`.

  - `features: List[GeoJsonFeature]`

    Array of GeoJSON Feature objects

    - `geometry: GeoJsonGeometry`

      GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

      - `coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]`

        Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

        - `List[float]`

          [longitude, latitude] or [longitude, latitude, elevation]

        - `List[List[float]]`

          Array of [lng, lat] positions

        - `List[List[List[float]]]`

          Array of linear rings / line strings

        - `List[List[List[List[float]]]]`

          Array of polygons

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Dict[str, object]`

      OSM tags flattened as key-value pairs, plus `@type` (node/way/relation) and `@id` (OSM ID) metadata fields. May include `distance_m` for proximity queries.

    - `type: Literal["Feature"]`

      Always `Feature`

      - `"Feature"`

    - `id: Optional[str]`

      Compound identifier in `type/osm_id` format

  - `type: Literal["FeatureCollection"]`

    Always `FeatureCollection`

    - `"FeatureCollection"`

### Example

```python
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_post(
    q="q",
)
print(feature_collection.features)
```

#### Response

```json
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "@id": "bar",
        "@type": "bar",
        "amenity": "bar",
        "cuisine": "bar",
        "name": "bar"
      },
      "type": "Feature",
      "id": "node/21154906"
    }
  ],
  "type": "FeatureCollection"
}
```