> ## Documentation Index
> Fetch the complete documentation index at: https://qwady.wiki/llms.txt
> Use this file to discover all available pages before exploring further.

# Building & Listing Types

> Enums for building types, listing statuses, and sale types

## BuildingType

Used in search filters (`buildingType` parameter) and returned in listing/building responses.

| Value          | Description                                                                        |
| -------------- | ---------------------------------------------------------------------------------- |
| `CONDO`        | Condominium: individually owned units in a shared building                         |
| `CO_OP`        | Co-operative: residents own shares in a corporation that owns the building         |
| `CONDOP`       | Condop: a co-op that operates under condo-like rules (a real NYC ownership hybrid) |
| `RENTAL`       | Rental building: units available for lease only                                    |
| `TOWNHOUSE`    | Townhouse: multi-story attached or semi-attached home                              |
| `HOUSE`        | Single-family house                                                                |
| `SINGLEFAMILY` | Single-family dwelling                                                             |
| `TWOFAMILY`    | Two-family house                                                                   |
| `THREEFAMILY`  | Three-family house                                                                 |
| `FOURFAMILY`   | Four-family dwelling                                                               |
| `MULTI_FAMILY` | Multi-family residential building                                                  |
| `MIXED_USE`    | Mixed-use building (residential + commercial)                                      |
| `HYBRID`       | Mixed ownership/structure type reported by the source                              |
| `COMMERCIAL`   | Commercial building                                                                |
| `UNKNOWN`      | Type not reported by the source                                                    |

<Note>
  `MULTIFAMILY` (no underscore) is accepted as an input alias for `MULTI_FAMILY` on
  the `buildingType` and `excludeBuildingType` filters. Responses always return the
  canonical spelling `MULTI_FAMILY`.
</Note>

### Usage in search

Pass one or more values as a comma-separated string:

```bash theme={null}
# Search for condos and co-ops
curl "https://borough.qwady.app/v1/search/rentals?buildingType=CONDO,CO_OP"

# Search only townhouses
curl "https://borough.qwady.app/v1/search/sales?buildingType=TOWNHOUSE"
```

```typescript theme={null}
const results = await borough.rentals.search({
  buildingType: "CONDO,CO_OP",
});
```

## ListingStatus

Returned in the `status` field of listing responses.

| Value         | Description                                                          |
| ------------- | -------------------------------------------------------------------- |
| `ACTIVE`      | Currently available on the market                                    |
| `IN_CONTRACT` | Under contract - offer accepted, sale pending - *reserved; see note* |
| `OFF_MARKET`  | No longer available                                                  |

<Note>
  Borough currently emits **`ACTIVE`** and **`OFF_MARKET`** only. `IN_CONTRACT` is a
  reserved value that the data feed does not yet surface, so listings transition
  directly from `ACTIVE` to `OFF_MARKET` when they leave the market. Treat
  `IN_CONTRACT` as a forward-compatible value: match on it if present, but do not
  rely on it for in-contract detection today.
</Note>

Search endpoints return `ACTIVE` listings by default. The property detail endpoint (`/v1/property/{id}`) returns `ACTIVE` or `OFF_MARKET` listings.

## SaleType

Used as a filter on `/v1/search/sales` only (not applicable to rentals).

| Value          | Description                                                     |
| -------------- | --------------------------------------------------------------- |
| `RESALE`       | Standard resale: existing owner selling                         |
| `SPONSOR_UNIT` | New development or sponsor sale: first sale from developer      |
| `FORECLOSURE`  | Foreclosure: bank-owned or distressed sale                      |
| `RESTRICTED`   | Income- or age-restricted sale (HDFC-style)                     |
| `AUCTION`      | Sold at auction                                                 |
| `SHORT`        | Short sale: lender-approved sale below the outstanding mortgage |
| `UNKNOWN`      | Sale type not reported by the source                            |

### Usage in search

```bash theme={null}
# Search for new development condos in Manhattan
curl "https://borough.qwady.app/v1/search/sales?saleType=SPONSOR_UNIT&buildingType=CONDO&areas=100"
```

```typescript theme={null}
const results = await borough.sales.search({
  saleType: "SPONSOR_UNIT",
  buildingType: "CONDO",
  areas: "100",
});
```