POST
/
api
/
scrapers
/
real-estate-com-au
/
create-and-run
curl --request POST \
  --url https://app.mrscraper.com/api/scrapers/real-estate-com-au/create-and-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Realestate.com.au Scraper",
  "options": "locations",
  "urls": [
    "https://www.realestate.com.au/property-residential+land-vic-ballarat+east-203862964",
    "https://www.realestate.com.au/property-residential+land-vic-redan-204046608",
    "https://www.realestate.com.au/project/avenue-hill-cardigan-600040980"
  ],
  "locations": [
    "Ballarat - Greater Region, VIC",
    "Hurstville, NSW 2220"
  ],
  "including_surrounding_areas": false,
  "only_show_properties_with_a_price": true,
  "channel": "buy",
  "property_types": [
    "land"
  ],
  "landsize_minimum": "any",
  "landsize_maximum": "1000"
}'
{
  "message": "Scraping queued successfully",
  "scraper": {
    "id": 3967,
    "name": "Realestate.com.au Scraper",
    "url": [
      "Default"
    ],
    "urls": [
      "Default"
    ],
    "scheduled": false,
    "schedule": null,
    "created_at": "2024-10-23T09:49:50.000000Z",
    "updated_at": "2024-10-23T09:49:50.000000Z"
  },
  "results": [
    {
      "scraping_run_id": 378181,
      "user_id": 5573,
      "scraper_name": "Realestate.com.au Scraper",
      "scrapped_url": "Default",
      "scraped_url": "Default",
      "scraper_id": 3967,
      "status": "running",
      "updated_at": "2024-10-23T09:49:50.000000Z",
      "created_at": "2024-10-23T09:49:50.000000Z",
      "id": 1172476,
      "scraper": {
        "id": 3967,
        "user_id": 5573,
        "sharing": false,
        "share_uuid": null,
        "name": "Realestate.com.au Scraper",
        "type": "real_estate_com_au",
        "urls": "Default",
        "pdf_urls": "Default",
        "ai_prompt": null,
        "ai_scope": null,
        "headers": null,
        "cookies": null,
        "user_agent": null,
        "disabled_resources": null,
        "delay": 0,
        "html_wanted": false,
        "screenshot_wanted": false,
        "screenshot_type": null,
        "locale": null,
        "scheduled": false,
        "cron": null,
        "cron_timezone": "UTC",
        "paginate": 0,
        "pagination_type": null,
        "infinite_pagination_type": null,
        "infinite_pagination_seconds": null,
        "infinite_pagination_text": null,
        "infinite_pagination_css_selector": null,
        "infinite_pagination_n_selector": null,
        "load_more_selector": null,
        "pagination_query_parameter": null,
        "pagination_next_page_selector": null,
        "pagination_limit_type": null,
        "pagination_max_page": null,
        "max_next_page": null,
        "pagination_max_variable": null,
        "created_at": "2024-10-23T09:49:50.000000Z",
        "updated_at": "2024-10-23T09:49:50.000000Z",
        "cron_minutes": "*",
        "cron_minutes_n_detail": null,
        "cron_minutes_x_detail": null,
        "cron_hours": "*",
        "cron_hours_n_detail": null,
        "cron_hours_x_detail": null,
        "cron_day_of_month": "*",
        "cron_day_of_month_x_detail": null,
        "cron_month": "*",
        "cron_month_x_detail": null,
        "cron_day_of_week": "*",
        "cron_day_of_week_x_detail": null,
        "click_action_enabled": false,
        "click_action_selector": null,
        "click_action_wait": "no",
        "workflow": [
          {
            "type": "query",
            "data": {
              "channel": "buy",
              "localities": [
                {
                  "searchLocation": "Ballarat - Greater Region, VIC"
                }
              ],
              "filters": {
                "propertyTypes": [
                  "land"
                ],
                "surroundingSuburbs": false,
                "excludeNoDisplayPrice": false,
                "landSize": {
                  "maximum": "1000"
                }
              }
            }
          }
        ],
        "version": 2,
        "proxy_type": "rotation",
        "proxy_host": null,
        "proxy_port": null,
        "proxy_username": null,
        "proxy_password": null,
        "parsers": null,
        "deleted_at": null,
        "external_auth": null
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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.

Example:

"Realestate.com.au Scraper"

​
options
enum<string>
required

The filter options

Available options:
locations,
links
Example:

"locations"

​
urls
string[]
required

Array of individual url listings (required if options is links).

Example:
[
  "https://www.realestate.com.au/property-residential+land-vic-ballarat+east-203862964",
  "https://www.realestate.com.au/property-residential+land-vic-redan-204046608",
  "https://www.realestate.com.au/project/avenue-hill-cardigan-600040980"
]
​
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.

Example:
[
  "Ballarat - Greater Region, VIC",
  "Hurstville, NSW 2220"
]
​
channel
enum<string>
required

Channel property type filter.

Available options:
buy,
rent,
sold
Example:

"buy"

​
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

Example:
["land"]
​
including_surrounding_areas
boolean

Including surrounding areas filter.

Example:

false

​
only_show_properties_with_a_price
boolean

Only show properties with a price filter.

Example:

true

​
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,
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
Example:

"any"

​
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
Example:

"1000"

Response

200 - application/json
​
message
string
Example:

"Scraping queued successfully"

​
scraper
object
Example:
{
  "id": 3967,
  "name": "Realestate.com.au Scraper",
  "url": ["Default"],
  "urls": ["Default"],
  "scheduled": false,
  "schedule": null,
  "created_at": "2024-10-23T09:49:50.000000Z",
  "updated_at": "2024-10-23T09:49:50.000000Z"
}
​
results
any[]
Example:
[
  {
    "scraping_run_id": 378181,
    "user_id": 5573,
    "scraper_name": "Test Real Estate API",
    "scrapped_url": "Default",
    "scraped_url": "Default",
    "scraper_id": 3967,
    "status": "running",
    "updated_at": "2024-10-23T09:49:50.000000Z",
    "created_at": "2024-10-23T09:49:50.000000Z",
    "id": 1172476,
    "scraper": {
      "id": 3967,
      "user_id": 5573,
      "sharing": false,
      "share_uuid": null,
      "name": "Test Real Estate API",
      "type": "real_estate_com_au",
      "urls": "Default",
      "pdf_urls": "Default",
      "ai_prompt": null,
      "ai_scope": null,
      "headers": null,
      "cookies": null,
      "user_agent": null,
      "disabled_resources": null,
      "delay": 0,
      "html_wanted": false,
      "screenshot_wanted": false,
      "screenshot_type": null,
      "locale": null,
      "scheduled": false,
      "cron": null,
      "cron_timezone": "UTC",
      "paginate": 0,
      "pagination_type": null,
      "infinite_pagination_type": null,
      "infinite_pagination_seconds": null,
      "infinite_pagination_text": null,
      "infinite_pagination_css_selector": null,
      "infinite_pagination_n_selector": null,
      "load_more_selector": null,
      "pagination_query_parameter": null,
      "pagination_next_page_selector": null,
      "pagination_limit_type": null,
      "pagination_max_page": null,
      "max_next_page": null,
      "pagination_max_variable": null,
      "created_at": "2024-10-23T09:49:50.000000Z",
      "updated_at": "2024-10-23T09:49:50.000000Z",
      "cron_minutes": "*",
      "cron_minutes_n_detail": null,
      "cron_minutes_x_detail": null,
      "cron_hours": "*",
      "cron_hours_n_detail": null,
      "cron_hours_x_detail": null,
      "cron_day_of_month": "*",
      "cron_day_of_month_x_detail": null,
      "cron_month": "*",
      "cron_month_x_detail": null,
      "cron_day_of_week": "*",
      "cron_day_of_week_x_detail": null,
      "click_action_enabled": false,
      "click_action_selector": null,
      "click_action_wait": "no",
      "workflow": [
        {
          "type": "query",
          "data": {
            "channel": "buy",
            "localities": [
              {
                "searchLocation": "Ballarat - Greater Region, VIC"
              }
            ],
            "filters": {
              "propertyTypes": ["land"],
              "surroundingSuburbs": false,
              "excludeNoDisplayPrice": false,
              "landSize": { "maximum": "1000" }
            }
          }
        }
      ],
      "version": 2,
      "proxy_type": "rotation",
      "proxy_host": null,
      "proxy_port": null,
      "proxy_username": null,
      "proxy_password": null,
      "parsers": null,
      "deleted_at": null,
      "external_auth": null
    }
  }
]