Greystar API endpoint
Use Crawlora's Greystar Article 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.
/greystar/articles/{section}/{slug}Retrieves 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. 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.
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 | Default | Description | Example |
|---|---|---|---|---|---|
| section (path) | string | Yes | Content section Allowed values: applying-and-leasing, general-guides, moving, blog. | blog | |
| slug (path) | string | Yes | Article slug from /greystar/articles | the-best-plants-for-apartment-living | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/greystar/articles/blog/the-best-plants-for-apartment-living" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| 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 |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Returns `title`, `description`, `category`, `image_url`, and `blocks`, the article body as ordered `heading`, `subheading`, `paragraph`, and `list_item` entries. Blog posts also carry `published_date` (as shown on the page) and `published_at` (`YYYY-MM-DD`); renter guides carry no publish date, and their `category` is the section. Breadcrumb text and the blog's related-posts section are excluded. An unknown slug returns `404`; an invalid section or slug returns `400`.
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.
| 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": 200,
"msg": "OK",
"data": {
"section": "blog",
"slug": "the-best-plants-for-apartment-living",
"url": "https://www.greystar.com/blog/the-best-plants-for-apartment-living",
"title": "The Best Indoor Plants for Apartments",
"category": "Lifestyle",
"published_date": "November 7, 2025",
"published_at": "2025-11-07",
"blocks": [
{
"type": "paragraph",
"text": "Looking to liven up your apartment with a fresh, natural touch?"
},
{
"type": "heading",
"text": "Dracaena"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/greystar.Article
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| blocks | array | No | ||||
| blocks[].text | string | No | ||||
| blocks[].type | string | No | heading, subheading, paragraph, list_item | |||
| category | string | No | ||||
| description | string | No | ||||
| image_url | string | No | ||||
| published_at | string | No | ||||
| published_date | string | No | ||||
| section | string | No | ||||
| slug | string | No | ||||
| title | string | No | ||||
| url | string | No |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/greystar/articles/blog/the-best-plants-for-apartment-living" \
-H "x-api-key: $CRAWLORA_API_KEY"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