Endpoint Playground

Try the Greystar Search API

Test Crawlora's Greystar Search API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /greystar/search
Platform: Greystar
Auth: apiKey
Credits: 2 credits/request
Required params: None
Common optional params: query, market_area, neighborhood, city, state, country_code

Greystar Search API documentation Greystar platform page Crawlora API pricing Try Greystar Articles API Try Greystar Article API Try Greystar Location API Try Greystar Locations API Try Greystar Markets API

Prefilled cURL

curl "https://api.crawlora.net/api/v1/greystar/search?sort=relevance" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
query	string	No		Free-text match on name, address, city, neighborhood, market area, or postal code (max 160 characters)
market_area	string	No		Exact market area from /greystar/markets, e.g. Greater Austin
neighborhood	string	No		Exact neighborhood from /greystar/markets
city	string	No		Exact city from /greystar/markets
state	string	No		State or region abbreviation from /greystar/markets, e.g. TX
country_code	string	No		ISO country code from /greystar/markets, e.g. US
min_price	number	No		Minimum starting monthly rent; excludes communities with no published price
max_price	number	No		Maximum starting monthly rent; excludes communities with no published price
sort	string	No	relevance	Result order
page	integer	No		1-based page
per_page	integer	No		Results per page, 1-100

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "total_count": 16,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "properties": [
      {
        "id": "23303",
        "name": "Lantower Edgewater",
        "address": "14201 N Interstate 35",
        "city": "Pflugerville",
        "state": "TX",
        "state_name": "Texas",
        "postal_code": "78660",
        "country_code": "US",
        "market_area": "Greater Austin",
        "min_price": null,
        "display_price": null,
        "min_base_rent_lease_term": null,
        "required_monthly_fees_min": 97,
        "required_monthly_fees_max": 97,
        "thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
      }
    ]
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey2 credits/requestgreystar.SearchResultGreystar

GET /greystar/search

Search Greystar apartment communities

Lists Greystar communities published on greystar.com, optionally filtered by market area, neighborhood, city, state, country, starting rent, or free text. Filter values must come from /greystar/markets; an unknown value returns 400. Starting prices reflect each community's published minimum and are null when none is published. Results come from a snapshot refreshed every few minutes.

Response behavior

Filter values match case-insensitively but must exist in `/greystar/markets`; an unknown value returns `400` instead of an empty list. Filters combine with AND. Results come from a snapshot of every published community refreshed every few minutes, so `total_count` is exact for the snapshot. `min_price` is the community's published starting rent and is `null` when none is published. A page past the end returns an empty `properties` array. Use a result's `id` with `/greystar/properties/{id}` for floor plans, fees, and available units.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

MCP tool

MCP URL

https://mcp.crawlora.net/mcp

Tool name

greystar_search

MCP auth

Authorization: Bearer $CRAWLORA_API_KEY

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "total_count": 16,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "properties": [
      {
        "id": "23303",
        "name": "Lantower Edgewater",
        "address": "14201 N Interstate 35",
        "city": "Pflugerville",
        "state": "TX",
        "state_name": "Texas",
        "postal_code": "78660",
        "country_code": "US",
        "market_area": "Greater Austin",
        "min_price": null,
        "display_price": null,
        "min_base_rent_lease_term": null,
        "required_monthly_fees_min": 97,
        "required_monthly_fees_max": 97,
        "thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
      }
    ]
  }
}

Endpoint details

Method: GET
Path: /greystar/search
Authentication: apiKey
Credit cost: 2 credits/request
Platform: Greystar
Parameters: 12 documented fields

Request parameters

query:querymarket_area:queryneighborhood:querycity:querystate:querycountry_code:querymin_price:querymax_price:querysort:querypage:queryper_page:queryx-api-key:header

Response schema fields

pageper_pagepropertiesproperties[].addressproperties[].cityproperties[].country_codeproperties[].display_priceproperties[].idproperties[].market_areaproperties[].min_base_rent_lease_termproperties[].min_priceproperties[].name

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "total_count": 16,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "properties": [
      {
        "id": "23303",
        "name": "Lantower Edgewater",
        "address": "14201 N Interstate 35",
        "city": "Pflugerville",
        "state": "TX",
        "state_name": "Texas",
        "postal_code": "78660",
        "country_code": "US",
        "market_area": "Greater Austin",
        "min_price": null,
        "display_price": null,
        "min_base_rent_lease_term": null,
        "required_monthly_fees_min": 97,
        "required_monthly_fees_max": 97,
        "thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/greystar/search" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing List Greystar renter guides and blog posts Get a Greystar renter guide or blog post Get a Greystar rental hub page List Greystar rental hub locations List Greystar markets, neighborhoods, cities, and states

Endpoint Playground

Try the Greystar Search API

Endpoint facts

Method: GET
API path: /greystar/search
Platform: Greystar
Auth: apiKey
Credits: 2 credits/request
Required params: None
Common optional params: query, market_area, neighborhood, city, state, country_code

Prefilled cURL

curl "https://api.crawlora.net/api/v1/greystar/search?sort=relevance" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
query	string	No		Free-text match on name, address, city, neighborhood, market area, or postal code (max 160 characters)
market_area	string	No		Exact market area from /greystar/markets, e.g. Greater Austin
neighborhood	string	No		Exact neighborhood from /greystar/markets
city	string	No		Exact city from /greystar/markets
state	string	No		State or region abbreviation from /greystar/markets, e.g. TX
country_code	string	No		ISO country code from /greystar/markets, e.g. US
min_price	number	No		Minimum starting monthly rent; excludes communities with no published price
max_price	number	No		Maximum starting monthly rent; excludes communities with no published price
sort	string	No	relevance	Result order
page	integer	No		1-based page
per_page	integer	No		Results per page, 1-100

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "total_count": 16,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "properties": [
      {
        "id": "23303",
        "name": "Lantower Edgewater",
        "address": "14201 N Interstate 35",
        "city": "Pflugerville",
        "state": "TX",
        "state_name": "Texas",
        "postal_code": "78660",
        "country_code": "US",
        "market_area": "Greater Austin",
        "min_price": null,
        "display_price": null,
        "min_base_rent_lease_term": null,
        "required_monthly_fees_min": 97,
        "required_monthly_fees_max": 97,
        "thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
      }
    ]
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey2 credits/requestgreystar.SearchResultGreystar

GET /greystar/search

Search Greystar apartment communities

Response behavior

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

MCP tool

MCP URL

https://mcp.crawlora.net/mcp

Tool name

greystar_search

MCP auth

Authorization: Bearer $CRAWLORA_API_KEY

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "total_count": 16,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "properties": [
      {
        "id": "23303",
        "name": "Lantower Edgewater",
        "address": "14201 N Interstate 35",
        "city": "Pflugerville",
        "state": "TX",
        "state_name": "Texas",
        "postal_code": "78660",
        "country_code": "US",
        "market_area": "Greater Austin",
        "min_price": null,
        "display_price": null,
        "min_base_rent_lease_term": null,
        "required_monthly_fees_min": 97,
        "required_monthly_fees_max": 97,
        "thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
      }
    ]
  }
}

Endpoint details

Method: GET
Path: /greystar/search
Authentication: apiKey
Credit cost: 2 credits/request
Platform: Greystar
Parameters: 12 documented fields

Request parameters

query:querymarket_area:queryneighborhood:querycity:querystate:querycountry_code:querymin_price:querymax_price:querysort:querypage:queryper_page:queryx-api-key:header

Response schema fields

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "total_count": 16,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "properties": [
      {
        "id": "23303",
        "name": "Lantower Edgewater",
        "address": "14201 N Interstate 35",
        "city": "Pflugerville",
        "state": "TX",
        "state_name": "Texas",
        "postal_code": "78660",
        "country_code": "US",
        "market_area": "Greater Austin",
        "min_price": null,
        "display_price": null,
        "min_base_rent_lease_term": null,
        "required_monthly_fees_min": 97,
        "required_monthly_fees_max": 97,
        "thumbnail_url": "https://s7d9.scene7.com/is/image/greystarprod/23303CLB1"
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/greystar/search" \
  -H "x-api-key: $CRAWLORA_API_KEY"