---
title: "Search available Greystar apartment units"
method: GET
path: "/greystar/units"
tags: ["Greystar"]
---

# Search available Greystar apartment units

`GET /greystar/units`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/greystar/units`
- Auth: API key in header `x-api-key`

Searches apartment units currently available to rent on greystar.com within one location (nationwide by default), filtered by bedrooms, bathrooms, building type, community highlights, and monthly price, sorted by relevance or price. Results are grouped by community: each carries its address, coordinates, the number of matching units, and up to about 100 units with unit number, floor plan, bedrooms, bathrooms, price range, and lease term. The response also returns filter counts for the location. Several values of one filter match any of them. Get location values from /greystar/unit-locations.

## Query parameters

- `location` string
- `bedrooms` string[]
- `bathrooms` string[]
- `building_type` string[]
- `highlights` string[]
- `min_price` number
- `max_price` number
- `sort` 'relevance' | 'price_asc'
- `page` integer
- `per_page` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- GreystarUnitSearchResult
  - `facets` GreystarUnitFacets
    - `bathrooms` GreystarFacetCount[]
      - `count` integer
      - `value` string
    - `bedrooms` GreystarFacetCount[]
      - `count` integer
      - `value` string
    - `building_types` GreystarFacetCount[]
      - `count` integer
      - `value` string
    - `highlights` GreystarFacetCount[]
      - `count` integer
      - `value` string
  - `location` string
  - `page` integer
  - `per_page` integer
  - `properties` GreystarUnitProperty[]
    - `address` string
    - `city` string
    - `latitude` number
    - `longitude` number
    - `matching_units` integer
    - `name` string
    - `postal_code` string
    - `property_id` string
    - `state` string
    - `state_name` string
    - `thumbnail_url` string
    - `units` GreystarListedUnit[]
      - `banner` string
      - `bathrooms` number
      - `bedrooms` number
      - `floorplan` string
      - `max_price` number
      - `min_base_rent_lease_term` integer
      - `min_price` number
      - `price` number
      - `required_monthly_fees_max` number
      - `required_monthly_fees_min` number
      - `unit_id` string
      - `unit_number` string
    - `units_truncated` boolean
  - `total_count` integer
  - `total_pages` integer

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)