{
  "openapi": "3.0.1",
  "info": {
    "title": "Zillow Property Enrichment — Comps · Owner · Tax · Climate",
    "description": "Enrich any US property by ZPID, URL, or address into one merged record: comparable homes, similar listings, owner/listing contact, full tax history, climate & flood risk, walk scores, images, and apartment details. Pick only the datasets you need. Built for underwriting, comps, and lead enrichment.",
    "version": "1.0",
    "x-build-id": "ttXpvVkJXARdS4lG3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~zillow-property-enrichment-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-zillow-property-enrichment-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~zillow-property-enrichment-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-zillow-property-enrichment-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~zillow-property-enrichment-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-zillow-property-enrichment-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": {
          "properties": {
            "title": "🏠 Property Identifiers",
            "type": "array",
            "description": "🏠 **PROPERTIES TO ENRICH:** Provide one or more property identifiers. Each item is auto-detected as one of:\n\n- 🔢 **ZPID** — a numeric Zillow property ID, e.g. `44471319`\n- 🔗 **Property URL** — a full listing URL, e.g. `https://www.zillow.com/homedetails/2762-Downing-St-Jacksonville-FL-32205/44471319_zpid/` (apartment/building URLs with `/b/` or `/apartments/` are also supported)\n- 📍 **Address** — a full street address, e.g. `1875 Avondale Circle, Jacksonville, FL 32205`\n\n💡 **TIP:** Click \"Bulk edit\" to paste many identifiers (one per line). Addresses should include street, city, and state.\n\n📊 **TIER-BASED LIMITS:**\n- **FREE users:** Up to 5 properties per run\n- **PAID users:** Unlimited properties",
            "default": [
              "44471319"
            ],
            "items": {
              "type": "string"
            }
          },
          "datasets": {
            "title": "🧩 Enrichment Datasets",
            "uniqueItems": true,
            "type": "array",
            "description": "🧩 **DATASETS TO PULL:** Select which enrichments to merge into each property record. Each selected dataset becomes a keyed sub-object in the output row.\n\n- **comparable_homes** — nearby comparable sales/listings\n- **similar** — algorithmically similar properties\n- **ownerinfo** — owner / listing agent contact\n- **taxinfo** — full property tax history\n- **climate** — flood, fire, heat, wind & air risk + FEMA zone\n- **walk_transit_bike** — Walk, Transit & Bike scores\n- **propimages** — high-resolution property photos\n- **apartment_details** — building details for apartments/rental communities (resolved via LotID)\n\n💡 **TIP:** Leaving this empty pulls the default set: comparable_homes, ownerinfo, taxinfo, climate. Fewer datasets = faster, cheaper runs.\n\nℹ️ A dataset that returns no data (e.g. owner contact for an off-market home, or apartment details for a single-family house) is simply left empty — the property row still ships with the datasets that succeeded.",
            "items": {
              "type": "string",
              "enum": [
                "comparable_homes",
                "similar",
                "ownerinfo",
                "taxinfo",
                "climate",
                "walk_transit_bike",
                "propimages",
                "apartment_details"
              ],
              "enumTitles": [
                "🏘️ Comparable homes",
                "🔁 Similar properties",
                "👤 Owner / listing contact",
                "📜 Tax history",
                "🌊 Climate & flood risk",
                "🚶 Walk / Transit / Bike scores",
                "📷 Property images",
                "🏢 Apartment building details"
              ]
            },
            "default": [
              "comparable_homes",
              "ownerinfo",
              "taxinfo",
              "climate"
            ]
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}