GitHub
LinkedIn
Mail
API Documentation
Housing
Use the Housing REST API to create calls to get housing data from Craigslist. Posts are renewed every two hours. Please use this API for educational purposes.
The housing API is currently unavailable.
Due to Craigslist's recent policy changes, the housing API is unavailable until further notice.
Notice
Only the SF Bay Area is supported at the moment. Use: sfbay
Search for housing within a Craigslist site.
Every site has a landing page and the URL's subdomain is the site's key. For example, use sfbay for https://sfbay.craigslist.org/ and monterey for https://monterey.craigslist.org/.
E.g., Find 100 posts in the SF Bay Area with a minimum price of $1200.
api.irahorecka.com/housing/sfbay?limit=100&min_price=1200
|
Name
|
Description
|
|---|---|
| id | <int> Craigslist post ID. |
| limit | <int> Number of results per request. Default is 50. |
| neighborhood | <str> Craigslist neighborhood within parent region. |
| housing_type | <str> Housing type, e.g. 'apartment'. |
| laundry | <str> Laundry amenities, e.g. 'laundry in bldg'. |
| parking | <str> Parking amenities, e.g. 'carport'. |
| min_bedrooms | <int> Minimum bedrooms |
| max_bedrooms | <int> Maximum bedrooms |
| min_ft2 | <int> Minimum area (ft2) |
| max_ft2 | <int> Maximum area (ft2) |
| min_price | <int> Minimum price (USD) |
| max_price | <int> Maximum price (USD) |
Notice
Only the SF Bay Area is supported at the moment. Use: sfbay/eby, sfbay/nby, sfbay/pen, sfbay/sby, sfbay/scz, sfbay/sfc
Search for housing within a Craigslist area. An area is a sub-region within a site. If you look at the SF Bay Area Craigslist page, you'll notice the hyperlinks sfc, sby, eby, pen, nby, and scz at the top.
If such hyperlinks are present in a Craigslist landing page, you may use these keys to further narrow your query by location. Note: not all sites have areas.
E.g., Find posts with carport parking in the East Bay Area.
api.irahorecka.com/housing/sfbay/eby?parking=carport
|
Name
|
Description
|
|---|---|
| id | <int> Craigslist post ID. |
| limit | <int> Number of results per request. Default is 50. |
| neighborhood | <str> Craigslist neighborhood within parent region. |
| housing_type | <str> Housing type, e.g. 'apartment'. |
| laundry | <str> Laundry amenities, e.g. 'laundry in bldg'. |
| parking | <str> Parking amenities, e.g. 'carport'. |
| min_bedrooms | <int> Minimum bedrooms |
| max_bedrooms | <int> Maximum bedrooms |
| min_ft2 | <int> Minimum area (ft2) |
| max_ft2 | <int> Maximum area (ft2) |
| min_price | <int> Minimum price (USD) |
| max_price | <int> Maximum price (USD) |