POST
/
api
/
scrapers
/
real-estate-com-au
/
create-and-run

Authorizations

Authorization
string
headerrequired

You can retrieve your token by visiting the API Tokens section inside your profile page or see https://docs.mrscraper.com/documentation/api-token for the details.

Body

application/json
name
string
required

The name of the scraping task.

locations
string[]
required

Locations filter for real estate scraping. You can go to https://realestate.com.au to get the location. The location can be multiple.

including_surrounding_areas
boolean

Including surrounding areas filter.

only_show_properties_with_a_price
boolean

Only show properties with a price filter.

channel
enum<string>
required

Channel property type filter.

Available options:
buy,
rent,
sold
property_types
string[]
required

Property types filter for real estate scraping. Can be multiple. Available options: all, house, townhouse, unit apartment, villa, retire, land, acreage, rural, unitblock

landsize_minimum
enum<string>

Landsize minimum filter. Should be smaller than landsize_maximum.

Available options:
any,
200,
300,
400,
500,
600,
700,
800,
900,
1000
landsize_maximum
enum<string>

Landsize maximum filter. Should be larger than landsize_minimum.

Available options:
any,
200,
300,
400,
500,
600,
700,
800,
900,
1000,
1200,
1500,
1750,
2000,
3000,
4000,
5000,
10000,
20000,
30000,
40000,
50000,
100000,
200000,
300000,
400000,
500000,
600000,
700000,
800000,
900000,
1000000,
1500000,
2000000,
3000000,
5000000,
10000000,
30000000,
50000000,
100000000

Response

200 - application/json
message
string
scraper
object
results
any[]
Create and run a PDF scraper