Endpoint Playground

Try the Greystar Location API

Test Crawlora's Greystar Location 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/location
Platform: Greystar
Auth: apiKey
Credits: 3 credits/request
Required params: state
Common optional params: city, neighborhood

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

Prefilled cURL

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

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
state	string	Yes	tx	State slug from /greystar/locations, e.g. tx
city	string	No		City slug from /greystar/locations
neighborhood	string	No		Neighborhood slug from /greystar/locations; requires city

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."
      }
    ]
  }
}

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

GETapiKey3 credits/requestgreystar.LocationDetailGreystar

GET /greystar/location

Get a Greystar rental hub page

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.

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.

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

Required query parameters

state

requiredstring

State slug from /greystar/locations, e.g. tx

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_location

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": {
    "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."
      }
    ]
  }
}

Endpoint details

Method: GET
Path: /greystar/location
Authentication: apiKey
Credit cost: 3 credits/request
Platform: Greystar
Parameters: 4 documented fields

Request parameters

state:querycity:queryneighborhood:queryx-api-key:header

Response schema fields

blocksblocks[].textblocks[].typecitycommunitiescommunities[].addresscommunities[].idcommunities[].namecommunities[].price_textcommunities[].slugcommunities[].urldescription

Sample response summary

{
  "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."
      }
    ]
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/greystar/location?state=<state>" \
  -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 List Greystar rental hub locations List Greystar markets, neighborhoods, cities, and states List Greystar newsroom releases

Endpoint Playground

Try the Greystar Location API

Endpoint facts

Method: GET
API path: /greystar/location
Platform: Greystar
Auth: apiKey
Credits: 3 credits/request
Required params: state
Common optional params: city, neighborhood

Prefilled cURL

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

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
state	string	Yes	tx	State slug from /greystar/locations, e.g. tx
city	string	No		City slug from /greystar/locations
neighborhood	string	No		Neighborhood slug from /greystar/locations; requires city

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."
      }
    ]
  }
}

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

GETapiKey3 credits/requestgreystar.LocationDetailGreystar

GET /greystar/location

Get a Greystar rental hub page

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

Required query parameters

state

requiredstring

State slug from /greystar/locations, e.g. tx

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_location

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": {
    "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."
      }
    ]
  }
}

Endpoint details

Method: GET
Path: /greystar/location
Authentication: apiKey
Credit cost: 3 credits/request
Platform: Greystar
Parameters: 4 documented fields

Request parameters

state:querycity:queryneighborhood:queryx-api-key:header

Response schema fields

blocksblocks[].textblocks[].typecitycommunitiescommunities[].addresscommunities[].idcommunities[].namecommunities[].price_textcommunities[].slugcommunities[].urldescription

Sample response summary

{
  "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."
      }
    ]
  }
}

cURL example

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