API Reference
Use Crawlora's Greystar API endpoints to extract supported public Greystar data as structured JSON. This documentation covers 9 active endpoints including 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, and related APIs. Developers can use these endpoints for monitoring, enrichment, research dashboards, internal data pipelines, and agent-native workflows without maintaining platform-specific scraping code. Each endpoint page documents authentication, request parameters such as section, slug, state, id, cURL examples, response examples, response schemas, errors, credit cost, and Playground testing. Send requests to the Crawlora API with an x-api-key header, review usage and plan limits on pricing, and test safe sample requests in Playground before moving the workflow into production.
Choose an endpoint, send an authenticated request with the x-api-key header, and inspect the normalized JSON response. The examples below use the public Crawlora API base URL and the same endpoint catalog used by Playground.
curl -X GET "https://api.crawlora.net/api/v1/greystar/markets" \
-H "x-api-key: $CRAWLORA_API_KEY"These endpoint cards are generated from the active Crawlora endpoint catalog, including method, path, auth mode, credit cost, parameter summary, docs, and Playground links.
/greystar/articlesapiKey1 credit/requestLists Greystar's renter guides (applying and leasing, general guides, moving) and blog posts from its public sitemap, newest first. Entries carry the section, slug, URL and last-modified date; fetch /greystar/articles/{section}/{slug} for the title and body.
Required params: None
/greystar/articles/{section}/{slug}apiKey3 credits/requestRetrieves one Greystar renter guide or blog post: title, description, category, publish date (blog posts), lead image, and the body as ordered heading, paragraph, and list blocks. Get section and slug values from /greystar/articles.
Required params: section:path, slug:path
/greystar/locationapiKey3 credits/requestRetrieves 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.
Required params: state:query
/greystar/locationsapiKey1 credit/requestLists Greystar's state, city, and neighborhood rental hub pages (the site's own location tree) with slugs and URLs. Use the slugs with /greystar/location for a hub's editorial content, child locations, listed communities, and FAQs.
Required params: None
/greystar/marketsapiKey1 credit/requestReturns every value accepted by the /greystar/search market_area, neighborhood, city, state, and country_code filters, each with the number of communities currently published. Derived from the full live community list, so it is the complete value space.
Required params: None
/greystar/newsroomapiKey1 credit/requestLists Greystar corporate newsroom releases and news articles from its public sitemap, newest first, with slug, URL and last-modified date. Fetch /greystar/newsroom/{slug} for the title, date, and body.
Required params: None
/greystar/newsroom/{slug}apiKey3 credits/requestRetrieves one Greystar newsroom release: title, type (for example Press Release), publish date, lead image, and body paragraphs. Older news stubs carry only a title and date, so the body can be empty. Get slugs from /greystar/newsroom.
Required params: slug:path
/greystar/properties/{id}apiKey5 credits/requestRetrieves a public Greystar community profile by its numeric property id: location, description, amenities, office hours, walk scores, tours, floor plans, published fees, and currently available units with starting prices and available dates. Get ids from /greystar/search.
Required params: id:path
/greystar/searchapiKey2 credits/requestLists 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.
Required params: None
| Endpoint | API path | Method | Credits | Required params | Docs | Playground |
|---|---|---|---|---|---|---|
| List Greystar renter guides and blog posts | /greystar/articles | GET | 1 credit/request | None | View docs | Try endpoint |
| Get a Greystar renter guide or blog post | /greystar/articles/{section}/{slug} | GET | 3 credits/request | section:path, slug:path | View docs | Try endpoint |
| Get a Greystar rental hub page | /greystar/location | GET | 3 credits/request | state:query | View docs | Try endpoint |
| List Greystar rental hub locations | /greystar/locations | GET | 1 credit/request | None | View docs | Try endpoint |
| List Greystar markets, neighborhoods, cities, and states | /greystar/markets | GET | 1 credit/request | None | View docs | Try endpoint |
| List Greystar newsroom releases | /greystar/newsroom | GET | 1 credit/request | None | View docs | Try endpoint |
| Get a Greystar newsroom release | /greystar/newsroom/{slug} | GET | 3 credits/request | slug:path | View docs | Try endpoint |
| Get a Greystar apartment community | /greystar/properties/{id} | GET | 5 credits/request | id:path | View docs | Try endpoint |
| Search Greystar apartment communities | /greystar/search | GET | 2 credits/request | None | View docs | Try endpoint |