[docs] clarify example

pull/31/head
Cullen Watson 2023-10-04 10:14:11 -05:00 committed by GitHub
parent c4870677c2
commit 68e15ce696
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions

View File

@ -52,7 +52,7 @@ options:
Name of the output file (without extension) Name of the output file (without extension)
-p PROXY, --proxy PROXY -p PROXY, --proxy PROXY
Proxy to use for scraping Proxy to use for scraping
-d DAYS, --days DAYS Sold in last _ days filter. -d DAYS, --days DAYS Sold/listed in last _ days filter.
-r RADIUS, --radius RADIUS -r RADIUS, --radius RADIUS
Get comparable properties within _ (eg. 0.0) miles. Only applicable for individual addresses. Get comparable properties within _ (eg. 0.0) miles. Only applicable for individual addresses.
-m, --mls_only If set, fetches only MLS listings. -m, --mls_only If set, fetches only MLS listings.
@ -73,8 +73,8 @@ filename = f"output/{current_timestamp}.csv"
properties = scrape_property( properties = scrape_property(
location="San Diego, CA", location="San Diego, CA",
listing_type="sold", # for_sale, for_rent listing_type="sold", # or (for_sale, for_rent)
last_x_days=30, # sold/listed in last 30 days last_x_days=30, # sold in last 30 days - listed in last x days if (for_sale, for_rent)
mls_only=True, # only fetch MLS listings mls_only=True, # only fetch MLS listings
) )
print(f"Number of properties: {len(properties)}") print(f"Number of properties: {len(properties)}")