- Notifications
You must be signed in to change notification settings - Fork16
irahorecka/pycraigslist
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Craigslist API wrapper
- I do not work or have an affiliation with Craigslist.
- This library is intended for educational purposes.
If you encounter issues retrieving posts from Craigslist due to Cloudflare’s anti-scraping measures, consider usingFlareSolverr. This open-source proxy solution bypasses Cloudflare’s protections.
To get started:
- Follow theinstallation guide to spin up the Docker container.
- Route your API requests through FlareSolverr to retrieve the desired HTML content.
pip install pycraigslistFind cars & trucks for sale with keyword "Mazda Miata" in the East BayArea, California:
importpycraigslistmiatas=pycraigslist.forsale.cta(site="sfbay",area="eby",query="Mazda Miata")formiatainmiatas.search():print(miata)>>> {'country':'US','region':'CA','site':'sfbay','area':'eby','category':'cto','id':'7291715564','repost_of':'','last_updated':'2021-03-15 09:06','title':'1990 Mazda Miata','neighborhood':'oakland lake merritt / grand','price':'$5,000','url':'https://sfbay.craigslist.org/eby/cto/d/oakland-1990-mazda-miata/7291715564.html'}# ...
Search for anything on Craigslist with Python!
pycraigslist.community(craigslist.org > community)pycraigslist.events(craigslist.org > eventcalendar)pycraigslist.forsale(craigslist.org > for sale)pycraigslist.gigs(craigslist.org > gigs)pycraigslist.housing(craigslist.org > housing)pycraigslist.jobs(craigslist.org > jobs)pycraigslist.resumes(craigslist.org > resumes)pycraigslist.services(craigslist.org > services)
Search for posts in parent classes for a broader query. For example,finding paid gigs in Portland, Oregon:
importpycraigslistpaid_gigs=pycraigslist.gigs(site="portland",is_paid=True)forgiginpaid_gigs.search():print(gig)>>> {'country':'US','region':'OR','site':'portland','area':'mlt','category':'lbg','id':'7295392821','repost_of':'7292985211','last_updated':'2021-03-22 13:00','title':'Packing and moving','neighborhood':'SE Portland','price':'','url':'https://portland.craigslist.org/mlt/lbg/d/portland-packing-and-moving/7295392821.html'}# ...
Most pycraigslist classes have subclasses to allow for a targeted query.For example:
pycraigslist.forsale.bia(craigslist.org > for sale >bikes)pycraigslist.forsale.cta(craigslist.org > for sale >cars & trucks)pycraigslist.housing.apa(craigslist.org > housing >apartments / housing for rent)pycraigslist.housing.roo(craigslist.org > housing >apartments / rooms & shares)
Use class method.get_categories() to search for subclasses. Theresulting keys are the subclass names.
importpycraigslistprint(pycraigslist.housing.get_categories())>>> {'apa':'apartments / housing for rent','swp':'housing swap','off':'office & commercial','prk':'parking & storage','rea':'real estate','reb':'real estate - by dealer','reo':'real estate - by owner','roo':'rooms & shares','sub':'sublets & temporary','vac':'vacation rentals','hou':'wanted: apts','rew':'wanted: real estate','sha':'wanted: room/share','sbw':'wanted: sublet/temp'}
E.g., usepycraigslist.housing.vac to search for vacation rentals.
Apply search filters to narrow your query. Use.get_filters() to findvalid filters for a class or subclass instance.
Search filters are sensitive to the language of the region. E.g., getfilters for cars & trucks for sale in Tokyo, Japan:
importpycraigslisttokyo_autos=pycraigslist.forsale.cta(site="tokyo")print(tokyo_autos.get_filters())>>> {'query':'...','search_titles':'True/False','has_image':'True/False','posted_today':'True/False','bundle_duplicates':'True/False','search_distance':'...','zip_code':'...','min_price':'...','max_price':'...','make_model':'...','min_year':'...','max_year':'...','min_miles':'...','max_miles':'...','min_engine_displacement':'...','max_engine_displacement':'...','condition': ['新品','ほぼ新品','美品','良品','使用に問題なし','サルベージ'],'auto_cylinders': ['3気筒','4気筒','5気筒','6気筒','8気筒','10気筒','12気筒','その他'],'auto_drivetrain': ['前輪','後輪','4WD'],'auto_fuel_type': ['ガソリン','ディーゼル','ハイブリッド','電気','その他'],'auto_paint': ['ブラック','ブルー','ブラウン','グリーン','グレー','オレンジ','パープル','レッド','シルバー','ホワイト','イエロー','カスタム'],'auto_size': ['コンパクト','フルサイズ','中型','サブコンパクト'],'auto_title_status': ['クリーン','サルベージ','再生','部品のみ','先取特権','不明'],'auto_transmission': ['MT','AT','その他'],'auto_bodytype': ['バス','コンバーチブル','クーペ','ハッチバック','ミニバン','オフロード','ピックアップ','セダン','トラック','SUV','ワゴン','バン','その他'],'language': ['afrikaans','català','dansk','deutsch','english','español','suomi','français','italiano','nederlands','norsk','português','svenska','filipino','türkçe','中文','العربية','日本語','한국말','русский','tiếng việt']}
E.g., use the filter parameter "クリーン" to find cars & trucks withclean titles:
importpycraigslisttokyo_autos=pycraigslist.forsale.cta(site="tokyo",auto_title_status="クリーン")forautointokyo_autos.search():print(auto)>>> {'country':'JP','region':'','site':'tokyo','area':'','category':'cto','id':'7301105503','repost_of':'','last_updated':'2021-04-03 14:04','title':'Suzuki Jimny 660 XG 4WD Keyless Entry Aluminum Wheel Non-Smoking Car','neighborhood':'Chiba Ken, Noda shi, Funakata 1630-1','price':'¥650,000','url':'https://tokyo.craigslist.org/cto/d/suzuki-jimny-660-xg-4wd-keyless-entry/7301105503.html'}# ...
When applying many filters, pass a dictionary of filters into thefilters keyword parameter. Note: keyword argument filters willoverridefilters if there are conflicting keys. For example:
importpycraigslistbike_filters= {"bicycle_frame_material":"steel",# Array of filter values are accepted"bicycle_wheel_size": ["650C","700C"],"bicycle_type":"road",}# This would search for titanium road bikes with size 650C or 700C wheelstitanium_bikes=pycraigslist.forsale.bia(site="sfbay",area="sfc",bicycle_frame_material="titanium",filters=bike_filters)
To search for Craigslist posts, use.search()..search() will returna dictionary of post attributes (typestr) and will search for everypost by default. Use thelimit keyword parameter to add a stop limitto a query. For example, uselimit=50 to get 50 posts. There is amaximum of 3000 posts per query.
E.g., find the first 20 posts for farming and gardening services inDenver, Colorado:
importpycraigslistgardening_services=pycraigslist.services.fgs(site="denver")forserviceingardening_services.search(limit=20):print(service)>>> {'country':'US','region':'CO','site':'denver','area':'','category':'fgs','id':'7301324564','repost_of':'6974119634','last_updated':'2021-04-03 11:47','title':'🌲 Tree Removal/Trimming, Stump Grind: LICENSED/INSURED! 720-605-1584','neighborhood':'All Areas','price':'','url':'https://denver.craigslist.org/fgs/d/littleton-tree-removal-trimming-stump/7301324564.html'}# ...
Use.search_detail() to get detailed Craigslist posts. Thelimitkeyword parameter in.search also applies to.search_detail. Setinclude_body=True to include the post's body in the output. Bydefault,include_body=False. Disclaimer:.search_detail is more timeconsuming than.search.
E.g., get detailed posts with the post body for all cars & trucks forsale in Abilene, Texas:
importpycraigslistall_autos=pycraigslist.forsale.cta(site="abilene")forautoinall_autos.search_detail(include_body=True):print(auto)>>> {'country':'US','region':'TX','site':'abilene','area':'','category':'cto','id':'7309894792','repost_of':'','last_updated':'2021-04-20 12:17','title':'2009 Mercedes GL-320','neighborhood':'Brownwood','price':'$12,000','url':'https://abilene.craigslist.org/cto/d/brownwood-2009-mercedes-gl-320/7309894792.html','lat':'31.729000','lon':'-99.019000','address':'','misc': ['2009 mercedes-benz gl-class'],'condition':'excellent','drive':'fwd','fuel':'diesel','odometer':'100700','paint_color':'black','title_status':'clean','transmission':'automatic','body':'BEAUTIFUL car inside and out!! Diesel with only 100k, mechanic says its in great condition.'}# ...
__doc__: Gets category name.url: Gets full URL.count: Gets number of posts.
importpycraigslisteast_bay_apa=pycraigslist.housing.apa(site="sfbay",area="eby",max_price=800)# 1print(east_bay_apa.__doc__)>>>'apartments / housing for rent'# 2print(east_bay_apa.url)>>>'https://sfbay.craigslist.org/search/eby/apa?searchNearby=1&s=0&max_price=800'# 3print(east_bay_apa.count)>>>56
pycraigslist has the following exceptions:
ConnectionError: exceeded maximum retries for a queryHTTPError: encountered a client or server errorInvalidFilterValue: filter is not recognized or has an invalidvalue
To use pycraigslist exceptions, import / import frompycraigslist.exceptions. For example:
importpycraigslistfrompycraigslist.exceptionsimportConnectionError,HTTPError,InvalidFilterValuetry:sf_bikes=pycraigslist.forsale.bia(site="sfbay",area="sfc",min_price=50)forbikeinsf_bikes.search():print(bike)exceptConnectionError:print("Yikes! Something's up with the network.")exceptHTTPErrorase:print(f"Bad HTTP response encountered:{e.status_code}{e.detail}")exceptInvalidFilterValuease:print(f"Craigslist filter validation failed. Filter: '{e.name}', Value: '{e.value}'")
If you are having issues or would like to propose a new feature, pleaseuse theissuestracker.
This project is licensed under the MIT license.
About
Craigslist API wrapper
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors4
Uh oh!
There was an error while loading.Please reload this page.