Docs menu
StreetEasy API endpoint
StreetEasy Building Details API
Use Crawlora's StreetEasy Building Details API to extract supported public StreetEasy 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.
GETapiKey5 credits/requestStreetEasystreeteasy.BuildingDetails
StreetEasy/streeteasy/buildings/{slug}Endpoint facts
- Method
- GET
- API path
- /streeteasy/buildings/{slug}
- Auth
- apiKey
- Credits
- 5 credits/request
- Platform
- StreetEasy
- Response schema
- #/definitions/streeteasy.BuildingDetails
- MCP tool
- streeteasy_building
Overview
Retrieves public building facts, location, description, policies, amenities, and available sale/rental listing cards from StreetEasy's server-rendered building page. Pass the building slug from a StreetEasy /building/{slug} URL. 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
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 |
|---|---|---|---|---|---|
| slug (path) | string | Yes | StreetEasy building slug | ||
| x-api-key (header) | string | Yes | API key required |
cURL example
curl -X GET "https://api.crawlora.net/api/v1/streeteasy/buildings/%3Cslug%3E" \ -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
- 5 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
Browser cluster behavior
Some targets require real browser execution because the data is loaded through JavaScript, dynamic rendering, or interaction-like browser behavior.
For supported endpoints, Crawlora can route requests through a managed browser cluster. This allows Crawlora to execute JavaScript, load dynamic content, apply browser-level request behavior, and normalize the rendered result into JSON.
You do not need to operate your own Playwright, Puppeteer, Chrome, proxy, queue, or retry infrastructure.
MCP
- MCP URL
- https://mcp.crawlora.net/mcp
- Tool name
- streeteasy_building
- Transport
- Streamable HTTP
- Auth
- Authorization: Bearer $CRAWLORA_API_KEY
- Docs resource
- docs://index
Response behavior
Returns the page's building name, address, building type, neighborhood labels, unit/floor/year facts, description, other building facts, policies, amenity groups, and available sale/rental counts. The listing arrays contain cards present in the rendered building page; use the sale or rental search endpoint for broader listing searches. A nonexistent building returns `404`; an upstream challenge, malformed page, or transport failure returns an upstream error.
Catalog quality warnings
- missing example for required path param: slug
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
{
"slug": "sample-house",
"url": "https://streeteasy.com/building/sample-house",
"name": "Sample House",
"address": "10 Example Street, New York, NY 10001",
"building_type": "Condo building",
"neighborhoods": [
"Chelsea"
],
"unit_count": 75,
"floor_count": 10,
"year_built": 1930,
"description": "A full-service condominium building.",
"facts": [
{
"label": "Property class",
"value": "R4"
}
],
"policies": [],
"amenities": [
{
"name": "Services and facilities",
"items": [
"Doorman",
"Elevator"
]
}
],
"available_sale_count": 1,
"available_rental_count": 0,
"available_sale_listings": [
{
"listing_type": "sale",
"unit": "#2A",
"url_path": "/building/sample-house/2a",
"price": "$1,250,000",
"bedrooms": "2 beds",
"bathrooms": "1.5 baths"
}
],
"available_rental_listings": []
}Request schema
No body schema
Response schema
#/definitions/streeteasy.BuildingDetails
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| address | string | No | ||||
| amenities | array | No | ||||
| amenities[].items | array | No | ||||
| amenities[].name | string | No | ||||
| available_rental_count | integer | No | ||||
| available_rental_listings | array | No | ||||
| available_rental_listings[].bathrooms | string | No | ||||
| available_rental_listings[].bedrooms | string | No | ||||
| available_rental_listings[].listed_by | string | No | ||||
| available_rental_listings[].listing_type | string | No | ||||
| available_rental_listings[].photo_url | string | No | ||||
| available_rental_listings[].price | string | No | ||||
| available_rental_listings[].square_footage | string | No | ||||
| available_rental_listings[].unit | string | No | ||||
| available_rental_listings[].url_path | string | No | ||||
| available_sale_count | integer | No | ||||
| available_sale_listings | array | No | ||||
| available_sale_listings[].bathrooms | string | No | ||||
| available_sale_listings[].bedrooms | string | No | ||||
| available_sale_listings[].listed_by | string | No | ||||
| available_sale_listings[].listing_type | string | No | ||||
| available_sale_listings[].photo_url | string | No | ||||
| available_sale_listings[].price | string | No | ||||
| available_sale_listings[].square_footage | string | No | ||||
| available_sale_listings[].unit | string | No | ||||
| available_sale_listings[].url_path | string | No | ||||
| building_type | string | No | ||||
| description | string | No | ||||
| facts | array | No | ||||
| facts[].label | string | No | ||||
| facts[].value | string | No | ||||
| floor_count | integer | No | ||||
| name | string | No | ||||
| neighborhoods | array | No | ||||
| policies | array | No | ||||
| slug | string | No | ||||
| unit_count | integer | No | ||||
| url | string | No | ||||
| year_built | integer | No |
Code examples
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/streeteasy/buildings/%3Cslug%3E" \
-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