Endpoint Playground
Searches active StreetEasy rentals in one or more areas with the public site's price, room, building, amenity, pet, open-house, tour, transit, and sort filters. Obtain valid area IDs from /streeteasy/areas.
curl 'https://api.crawlora.net/api/v1/streeteasy/rentals/search?area_id=271&sort=default' \
-H "x-api-key: $CRAWLORA_API_KEY"| Parameter | Type | Required | Prefilled value | Description |
|---|---|---|---|---|
| area_id | array | Yes | 271 | StreetEasy area ID from /streeteasy/areas; repeat for multiple areas |
| page | integer | No | 1-based result page | |
| per_page | integer | No | Results per page, 1-500 | |
| sort | string | No | default | Result order |
| min_price | integer | No | Minimum monthly rent | |
| max_price | integer | No | Maximum monthly rent | |
| min_bedrooms | integer | No | Minimum bedrooms; zero means studio | |
| max_bedrooms | integer | No | Maximum bedrooms | |
| min_bathrooms | number | No | Minimum bathrooms | |
| max_bathrooms | number | No | Maximum bathrooms | |
| min_sqft | integer | No | Minimum square footage | |
| max_sqft | integer | No | Maximum square footage | |
| building_type | array | No | Building type; repeat for multiple | |
| amenity | array | No | Required amenity; repeat for multiple | |
| optional_amenity | array | No | Preferred amenity; results may omit these. Repeat for multiple. | |
| pets_allowed | boolean | No | Require listings that allow pets | |
| open_house | boolean | No | Require an open house within the next seven days | |
| tour_3d | boolean | No | Require a 3D tour | |
| video_tour | boolean | No | Require a video tour | |
| transit_line | array | No | Nearby transit line; repeat for multiple |
{
"code": 200,
"msg": "OK",
"data": {
"search": {
"criteria": "area:401|price:3000-|status:open"
},
"totalCount": 252,
"edges": [
{
"type": "OrganicRentalEdge",
"node": {
"id": "4786719",
"areaName": "Astoria",
"bedroomCount": 1,
"buildingType": "RENTAL",
"fullBathroomCount": 1,
"price": 3125,
"status": "ACTIVE",
"street": "26-19 2nd Street",
"unit": "401",
"urlPath": "/building/26_19-2-street-queens/401"
}
}
]
}
}The sample response, schema and code snippets below work without an account. Sending a live request needs an API key.