{
  "openapi": "3.0.1",
  "info": {
    "title": "realestate.co.nz Scraper - NZ Listings, Sold Prices & Agents",
    "description": "Scrape realestate.co.nz, New Zealand's agency-owned property portal: houses for sale and rent, commercial, rural and business listings with agent contacts, school zones, council RV, sold prices and AVM estimates.",
    "version": "1.0",
    "x-build-id": "QEYHyGJyLd85XdgYH"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~realestate-nz-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-realestate-nz-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/sian.agency~realestate-nz-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-realestate-nz-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/sian.agency~realestate-nz-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-realestate-nz-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "operation": {
            "title": "🎯 What do you want to scrape?",
            "enum": [
              "search",
              "sold"
            ],
            "type": "string",
            "description": "Pick one per run. Property Search reads live listings — for sale, to rent, commercial, rural and business — and is where the volume is. Sold Prices & Valuations reads the portal's property records instead: what a place actually sold for, its council rateable value and its current estimate, whether or not it is on the market today.",
            "default": "search"
          },
          "locations": {
            "title": "📍 New Zealand places",
            "type": "array",
            "description": "Region, district or suburb slugs. A region on its own: auckland, canterbury, wellington, waikato, otago, bay-of-plenty, northland, southland. A district: auckland/rodney, canterbury/selwyn. A suburb: wellington/wellington-city/te-aro, auckland/north-shore-city/devonport. One search runs per place, so three places return roughly three times the rows. The full list of 21 regions, 85 districts and 1,899 suburbs is the portal's own; an unrecognised place is reported by name and skipped, never…",
            "default": [
              "auckland"
            ],
            "items": {
              "type": "string"
            }
          },
          "category": {
            "title": "🏘️ What kind of listing",
            "enum": [
              "res_sale",
              "res_rent",
              "com_sale",
              "com_lease",
              "rural_sale",
              "biz_sale"
            ],
            "type": "string",
            "description": "Which part of the portal to search. Homes for sale is the largest, at 40,884 live listings nationwide; commercial for lease is second at 28,391, and homes to rent has 8,420. Only used by Property Search — Sold Prices & Valuations reads property records, which are not split by category.",
            "default": "res_sale"
          },
          "propertyTypes": {
            "title": "🏗️ Property types",
            "type": "array",
            "description": "Narrow to particular property types, by slug. Homes for sale: house, apartment, townhouse, unit, studio, section, lifestyle-property, lifestyle-section, home-and-income, retirement-living, multiple-properties, carpark, boat-shed. Homes to rent uses the same names. Commercial: office-building, retail-property, industrial-buildings, warehouse, showroom, commercial-land, industrial-land, hotel-motel-leisure, investment-opportunities. Rural: grazing, dairy, cropping, forestry, horticulture,…",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "listingUrls": {
            "title": "🔗 Specific listing URLs",
            "type": "array",
            "description": "Already know which listings you want? Paste realestate.co.nz listing URLs here — https://www.realestate.co.nz/43121617/residential/sale/8-kaipara-crescent-helensville — or bare listing IDs like 43121617, and Property Search reads exactly those instead of running a place search. Same row, same fields, same price per row as a search result: the portal returns identical data either way, so there is no premium for choosing the listings yourself. Ignored by Sold Prices & Valuations.",
            "default": [],
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "minPrice": {
            "title": "💵 Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings at or above this price. NZD. For homes to rent this is the weekly rent, so 500 means $500 a week. Leave empty for no lower bound. Listings marked Auction, Tender, Deadline Sale or Price by Negotiation carry no number, and the portal excludes them from a price-filtered search."
          },
          "maxPrice": {
            "title": "💰 Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings at or below this price. NZD, and weekly for rentals. Leave empty for no upper bound."
          },
          "minBedrooms": {
            "title": "🛏️ Minimum bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Only listings with at least this many bedrooms. Leave empty for any. Sections, land and most commercial listings have no bedroom count and drop out when this is set."
          },
          "minBathrooms": {
            "title": "🛁 Minimum bathrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Only listings with at least this many bathrooms. Leave empty for any."
          },
          "minLandArea": {
            "title": "🌳 Minimum land area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this much land, in square metres. 5000 finds lifestyle blocks; 809 is the classic quarter-acre. Rural listings are published in hectares and are converted before the comparison, so one number works across both."
          },
          "minFloorArea": {
            "title": "📐 Minimum floor area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with at least this much building floor area, in square metres. The main filter for commercial space, where land area is often irrelevant."
          },
          "keywords": {
            "title": "🔎 Keywords in the listing",
            "type": "string",
            "description": "Free-text words the portal matches against the listing text: sea views, north facing, subdividable, motivated vendor, granny flat. Separate several with commas. Narrows hard — pool alone cuts 40,884 homes for sale to 3,696."
          },
          "openHomesOnly": {
            "title": "🚪 Only listings with an open home",
            "type": "boolean",
            "description": "Only listings with an open home scheduled. 4,000 homes for sale have one at any time. The open-home start and end times come back on every row regardless.",
            "default": false
          },
          "newBuildsOnly": {
            "title": "🏗️ Only new builds",
            "type": "boolean",
            "description": "Only listings the agency has flagged as new construction — 6,647 of the homes currently for sale.",
            "default": false
          },
          "mortgageeSalesOnly": {
            "title": "⚖️ Only mortgagee sales",
            "type": "boolean",
            "description": "Only mortgagee sales, where the lender is selling. A small, fast-moving set — 64 nationwide at the time of writing — and the one filter distressed-asset buyers ask for first.",
            "default": false
          },
          "petFriendlyOnly": {
            "title": "🐾 Only pet-friendly rentals",
            "type": "boolean",
            "description": "Only rentals that accept pets. Applies to Homes to rent; on a sale category the portal ignores it and the run says so rather than pretending it filtered.",
            "default": false
          },
          "sortBy": {
            "title": "↕️ Order the listings by",
            "enum": [
              "latest",
              "oldest",
              "lowest-price",
              "highest-price",
              "featured"
            ],
            "type": "string",
            "description": "Newest first is what a monitoring job wants: run it on a schedule and the new listings are at the top of every run. Used by Property Search only.",
            "default": "latest"
          },
          "soldWithin": {
            "title": "🗓️ Sold within",
            "enum": [
              "3-months",
              "6-months",
              "12-months",
              "24-months",
              "any"
            ],
            "type": "string",
            "description": "How far back Sold Prices & Valuations looks. Recent sales are the ones comparable-sales work needs; Any time returns every property record in the area, including ones that have never sold, whose council valuation and estimate are still there. Ignored by Property Search.",
            "default": "12-months"
          },
          "soldSortBy": {
            "title": "↕️ Order the sales by",
            "enum": [
              "latest-sale",
              "oldest-sale",
              "highest-sold-price",
              "lowest-sold-price"
            ],
            "type": "string",
            "description": "Ordering for Sold Prices & Valuations. Most recent first tracks a market week by week; highest first surfaces the top of a suburb. Ignored by Property Search.",
            "default": "latest-sale"
          },
          "maxResults": {
            "title": "🔢 Maximum rows",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many rows for the whole run, not per place — a three-place run capped at 100 returns 100 rows, not 300. Rows arrive 100 per request, so the run stops at the first request that crosses your limit. One place-and-filter combination can return at most 10,000 rows because the portal will not paginate past that; to go deeper, split the run by district or suburb, or by price band. The run says so in the log rather than truncating quietly.",
            "default": 100
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}