SearchPropertiesRequest

Request model for POST /api/v1/properties/search. Supports polygon/multi-polygon geometry queries and point+radius queries.

  • cursor
    Type: null | string

    Pagination cursor from previous response.

  • filters
    Type: object · SearchFiltersRequest nullable

    Optional filters to apply alongside spatial query.

    • categories
      Type: array string[] | null

      Optional type filters with OR semantics. A property matches when it has at least one of the supplied categories.

    • country
      Type: null | string
    • tags
      Type: array string[] | null

      Optional tag filters with OR semantics. A property matches when its latest TimeSeries has at least one of the supplied tags.

  • near
    Type: object · SearchNearRequest nullable

    Center point for radius search. Mutually exclusive with within.

    • latitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
    • longitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
  • page_size
    Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    Number of results per page (1-500, default 50).

  • radius
    Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

    Search radius in meters. Required with near.

  • sort
    Type: null | string

    Sort order: "distance" or "updated" (default). "distance" requires near or sort_origin.

  • sort_origin
    Type: object · SearchNearRequest nullable

    Explicit origin point for distance calculation. Required for sort=distance with within.

    • latitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
    • longitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double
  • within
    nullable

    GeoJSON geometry object (Polygon or MultiPolygon only). Coordinates follow GeoJSON standard: [longitude, latitude]. Mutually exclusive with near.