Craigslist API: search Craigslist apartments for rent
Input
site optionalThe Craigslist city, as its web address starts: sfbay (SF Bay Area), newyork, losangeles, seattle, boston, chicago…
Default: "sfbay"sort optionalquery optionalKeywords, as typed in the site's search box.
catsOk optionalOnly listings that allow cats.
dogsOk optionalOnly listings that allow dogs.
maxSqft optionalminSqft optionalsubarea optionalOne part of the city's area, as Craigslist abbreviates it. For sfbay: sfc (San Francisco), eby (East Bay), pen (Peninsula), sby (South Bay), nby (North Bay), scz (Santa Cruz). Omit for the whole area.
category optionalapartments: whole units for rent. rooms: a room in a shared home. sublets: sublets and temporary stays.
Default: "apartments"hasImage optionalOnly listings with photos.
maxPrice optionalMaximum monthly rent, in the site's currency.
minPrice optionalMinimum monthly rent, in the site's currency.
furnished optionalOnly furnished listings.
postalCode optionalZIP code to measure distance from; use with distanceMiles.
titlesOnly optionalMatch the keywords against listing titles only.
maxBedrooms optionalminBedrooms optionalpostedToday optionalOnly listings posted today.
maxBathrooms optionalminBathrooms optionaldistanceMiles optionalOnly listings within this many miles of postalCode.
Output
count requiredtotal requiredHow many listings match on the site, counting reposts of one listing that the site shows once.
complete requiredtrue: every match is in listings. false: only the newest batch came back; narrow the filters to reach the rest.
listings requiredsearchUrl requiredThe search page as the site resolved it.
