Docs menu

Greystar API endpoint

Greystar Location API

Retrieves one Greystar state, city, or neighborhood rental hub: title, description, editorial guide text as ordered blocks, child locations with summaries, communities listed on the page (id, name, address, and price text when shown), and FAQs. State, city, and neighborhood slugs must come from /greystar/locations; unknown values return 400.

GETapiKey3 credits/requestGreystargreystar.LocationDetail/greystar/location

Endpoint facts

Method: GET
API path: /greystar/location
Auth: apiKey
Credits: 3 credits/request
Charged on: Successful 2xx responses only
Platform: Greystar
Response schema: #/definitions/greystar.LocationDetail
MCP tool: greystar_location

Greystar Scraper API Try Greystar Location API in Playground Greystar API documentation

How this endpoint behaves

MCP tool: greystar_location

Query parameters

state (required): state slug from /greystar/locations, for example tx.
city (optional): city slug from /greystar/locations.
neighborhood (optional): neighborhood slug from /greystar/locations; requires city.

Response behavior

Returns one rental hub page: level (state, city, or neighborhood), title, description, blocks (the editorial guide text as ordered heading, subheading, paragraph, and list_item entries), sub_locations (direct children with name, slug, path, and summary), communities (communities listed on the page with id, name, slug, url, address, and price_text when shown), and faqs (question and answer pairs). Use a community id with /greystar/properties/{id}. State hubs list sub-locations but usually no communities. Child summaries are truncated by the site. Slugs are checked against the live location list first, so an unknown value returns 400 rather than a missing page.

Sampled response

Request, 14 Oct 2026: GET /greystar/location?city=bryan-college-station&state=tx
Items in blocks: 18
Fields filled in every checked item: 2

Field	Filled in, of 18 checked	Values in the sample
type	18	paragraph (9), subheading (5), heading (4)
text	18	“Discover Greystar Communities” and 17 other values

Request parameters

Parameter	Type	Required	Description	Example
state	string	Yes	State slug from /greystar/locations, e.g. tx	tx
city	string	No	City slug from /greystar/locations
neighborhood	string	No	Neighborhood slug from /greystar/locations; requires city
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/greystar/location?state=tx" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "level": "city",
    "state": "tx",
    "city": "bryan-college-station",
    "path": "/homes-to-rent/us/tx/bryan-college-station",
    "title": "Bryan-College Station",
    "blocks": [
      {
        "type": "heading",
        "text": "Welcome to Bryan-College Station: A Texan-Style College Town!"
      }
    ],
    "sub_locations": [
      {
        "name": "Bryan",
        "slug": "bryan",
        "path": "/homes-to-rent/us/tx/bryan-college-station/bryan"
      }
    ],
    "communities": [
      {
        "id": "16439",
        "name": "Reveille Ranch",
        "slug": "reveille-ranch-college-station-tx",
        "url": "https://www.greystar.com/reveille-ranch-college-station-tx/p_16439",
        "address": "3645 Wellborn Rd, College Station, TX 77801"
      }
    ],
    "faqs": [
      {
        "question": "What are some popular outdoor activities in Bryan-College Station?",
        "answer": "Lick Creek Park features hiking and biking trails."
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/greystar.LocationDetail

Field	Type	Required	Description
blocks	array	No
blocks[].text	string	No
blocks[].type	string	No	heading, subheading, paragraph, list_item
city	string	No
communities	array	No
communities[].address	string	No
communities[].id	string	No
communities[].name	string	No
communities[].price_text	string	No
communities[].slug	string	No
communities[].url	string	No
description	string	No
faqs	array	No
faqs[].answer	string	No
faqs[].question	string	No
level	string	No
neighborhood	string	No
path	string	No
state	string	No
sub_locations	array	No
sub_locations[].name	string	No
sub_locations[].path	string	No
sub_locations[].slug	string	No
sub_locations[].summary	string	No
sub_locations[].url	string	No
title	string	No
url	string	No

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/greystar/location?state=tx" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing MCP server Acceptable use

More Greystar endpoint docs Greystar Scraper API Greystar Articles API documentation Greystar Article API documentation Greystar Locations API documentation Greystar Markets API documentation Greystar Newsroom API documentation Greystar Newsroom Article API documentation

Open in Playground Back to group

Docs menu

Greystar API endpoint

Greystar Location API

GETapiKey3 credits/requestGreystargreystar.LocationDetail/greystar/location

Endpoint facts

Method: GET
API path: /greystar/location
Auth: apiKey
Credits: 3 credits/request
Charged on: Successful 2xx responses only
Platform: Greystar
Response schema: #/definitions/greystar.LocationDetail
MCP tool: greystar_location

Greystar Scraper API Try Greystar Location API in Playground Greystar API documentation

How this endpoint behaves

MCP tool: greystar_location

Query parameters

state (required): state slug from /greystar/locations, for example tx.
city (optional): city slug from /greystar/locations.
neighborhood (optional): neighborhood slug from /greystar/locations; requires city.

Response behavior

Sampled response

Request, 14 Oct 2026: GET /greystar/location?city=bryan-college-station&state=tx
Items in blocks: 18
Fields filled in every checked item: 2

Field	Filled in, of 18 checked	Values in the sample
type	18	paragraph (9), subheading (5), heading (4)
text	18	“Discover Greystar Communities” and 17 other values

Request parameters

Parameter	Type	Required	Description	Example
state	string	Yes	State slug from /greystar/locations, e.g. tx	tx
city	string	No	City slug from /greystar/locations
neighborhood	string	No	Neighborhood slug from /greystar/locations; requires city
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/greystar/location?state=tx" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "level": "city",
    "state": "tx",
    "city": "bryan-college-station",
    "path": "/homes-to-rent/us/tx/bryan-college-station",
    "title": "Bryan-College Station",
    "blocks": [
      {
        "type": "heading",
        "text": "Welcome to Bryan-College Station: A Texan-Style College Town!"
      }
    ],
    "sub_locations": [
      {
        "name": "Bryan",
        "slug": "bryan",
        "path": "/homes-to-rent/us/tx/bryan-college-station/bryan"
      }
    ],
    "communities": [
      {
        "id": "16439",
        "name": "Reveille Ranch",
        "slug": "reveille-ranch-college-station-tx",
        "url": "https://www.greystar.com/reveille-ranch-college-station-tx/p_16439",
        "address": "3645 Wellborn Rd, College Station, TX 77801"
      }
    ],
    "faqs": [
      {
        "question": "What are some popular outdoor activities in Bryan-College Station?",
        "answer": "Lick Creek Park features hiking and biking trails."
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/greystar.LocationDetail

Field	Type	Required	Description
blocks	array	No
blocks[].text	string	No
blocks[].type	string	No	heading, subheading, paragraph, list_item
city	string	No
communities	array	No
communities[].address	string	No
communities[].id	string	No
communities[].name	string	No
communities[].price_text	string	No
communities[].slug	string	No
communities[].url	string	No
description	string	No
faqs	array	No
faqs[].answer	string	No
faqs[].question	string	No
level	string	No
neighborhood	string	No
path	string	No
state	string	No
sub_locations	array	No
sub_locations[].name	string	No
sub_locations[].path	string	No
sub_locations[].slug	string	No
sub_locations[].summary	string	No
sub_locations[].url	string	No
title	string	No
url	string	No

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/greystar/location?state=tx" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing MCP server Acceptable use

Open in Playground Back to group

Greystar Location API

Endpoint facts

How this endpoint behaves

Query parameters

Response behavior

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related

Greystar Location API

Endpoint facts

How this endpoint behaves

Query parameters

Response behavior

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related