Docs menu

Greystar API endpoint

Greystar Location API

Use Crawlora's Greystar Location API to extract supported public Greystar data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.

GETapiKey3 credits/requestGreystargreystar.LocationDetail/greystar/location

Endpoint facts

Method: GET
API path: /greystar/location
Auth: apiKey
Credits: 3 credits/request
Platform: Greystar
Response schema: #/definitions/greystar.LocationDetail
MCP tool: greystar_location

Overview

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. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.

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

Request parameters

Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.

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"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: 3 credits/request
Charged response: Successful 2xx responses

Plan	Price	Included credits	Daily cap	Rate limit	Overage
Free	$0/mo	2,000	500 daily credits	5/min	No overage
Starter	$9/mo	20,000	5,000 daily credits	15/min	$0.75/1,000 overage credits when enabled
Growth	$29/mo	100,000	25,000 daily credits	45/min	$0.45/1,000 overage credits when enabled
Pro	$79/mo	400,000	No daily cap	120/min	$0.30/1,000 overage credits
Business	$199/mo	1,200,000	No daily cap	300/min	$0.20/1,000 overage credits
Enterprise	$499/mo	5,000,000	No daily cap	1,000/min	$0.12/1,000 overage credits

Infrastructure behavior

This endpoint is executed through Crawlora's managed scraping infrastructure.

Proxy strategy: managed automatically where needed
Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
Browser cluster: supported dynamic workloads can be routed through distributed browser instances
Retry behavior: automatic retry/fallback may be used depending on endpoint type
Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

MCP

MCP URL: https://mcp.crawlora.net/mcp
Tool name: greystar_location
Transport: Streamable HTTP
Auth: Authorization: Bearer $CRAWLORA_API_KEY
Docs resource: docs://index

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.

Error behavior

Crawlora does not silently return bad data when the upstream page cannot be used.

Status	Common failure case
400	Invalid input or missing required parameter
429	Plan or endpoint rate limit exceeded
500	Internal execution error
502	Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved

When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.

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

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

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"

Responsible public web data workflows

Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.

Read Crawlora terms

More Greystar endpoint docs Greystar Scraper API Crawlora API pricing Try Greystar Location API in Playground 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