{
  "openapi": "3.0.1",
  "info": {
    "title": "United Real Estate City & ZIP Listing Search",
    "description": "Search United Real Estate by city, state, ZIP code or keyword, filtering by property type, listing status, price, beds/baths and size, returning address, price, size and listing brokerage per home.",
    "version": "1.0",
    "x-build-id": "jNBK01g7eGuCnVxjD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nimbryxo-studio~united-real-estate-city-and-zip-listing-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nimbryxo-studio-united-real-estate-city-and-zip-listing-search",
        "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/nimbryxo-studio~united-real-estate-city-and-zip-listing-search/runs": {
      "post": {
        "operationId": "runs-sync-nimbryxo-studio-united-real-estate-city-and-zip-listing-search",
        "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/nimbryxo-studio~united-real-estate-city-and-zip-listing-search/run-sync": {
      "post": {
        "operationId": "run-sync-nimbryxo-studio-united-real-estate-city-and-zip-listing-search",
        "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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "byUrls",
              "byMlsNumbers",
              "nearby"
            ],
            "type": "string",
            "description": "What to fetch. `search` finds listings by location, ZIP, keyword or map radius. `byUrls` scrapes specific listing pages. `byMlsNumbers` looks listings up by MLS number. `nearby` searches around a latitude/longitude point.",
            "default": "search"
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "City to search, e.g. `Austin`. For mode=search; combine with `state`."
          },
          "state": {
            "title": "State",
            "enum": [
              "",
              "AL",
              "AK",
              "AZ",
              "AR",
              "CA",
              "CO",
              "CT",
              "DE",
              "DC",
              "FL",
              "GA",
              "HI",
              "ID",
              "IL",
              "IN",
              "IA",
              "KS",
              "KY",
              "LA",
              "ME",
              "MD",
              "MA",
              "MI",
              "MN",
              "MS",
              "MO",
              "MT",
              "NE",
              "NV",
              "NH",
              "NJ",
              "NM",
              "NY",
              "NC",
              "ND",
              "OH",
              "OK",
              "OR",
              "PA",
              "RI",
              "SC",
              "SD",
              "TN",
              "TX",
              "UT",
              "VT",
              "VA",
              "WA",
              "WV",
              "WI",
              "WY"
            ],
            "type": "string",
            "description": "US state for the city search. For mode=search."
          },
          "zipCode": {
            "title": "ZIP code",
            "type": "string",
            "description": "Search a US ZIP code instead of city/state. Five digits, e.g. `78701`. For mode=search."
          },
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Free-text search across listing addresses, descriptions and MLS numbers, e.g. `waterfront`, `pool` or `1191266`. For mode=search."
          },
          "propertyTypes": {
            "title": "Property types",
            "uniqueItems": true,
            "type": "array",
            "description": "Restrict to one or more property types. Empty = all types. With includeDetails, results are post-filtered by the detail property type when the source label is recognized. For mode=search.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "10",
                "11",
                "12"
              ],
              "enumTitles": [
                "Single Family / Detached",
                "Multi-family",
                "Condo / Townhome / Apartment",
                "Farm / Ranch",
                "Lot and Land",
                "Commercial",
                "Mobile",
                "Waterfront",
                "Other",
                "Industrial",
                "Recreational"
              ]
            },
            "default": []
          },
          "listingStatuses": {
            "title": "Listing status",
            "uniqueItems": true,
            "type": "array",
            "description": "Restrict to one or more listing statuses. Empty = the site default (active listings). For mode=search.",
            "items": {
              "type": "string",
              "enum": [
                "10001",
                "10005",
                "10011"
              ],
              "enumTitles": [
                "Active",
                "Pending",
                "Coming Soon"
              ]
            },
            "default": []
          },
          "minPrice": {
            "title": "Min price (USD)",
            "minimum": 0,
            "maximum": 500000000,
            "type": "integer",
            "description": "Minimum listing price."
          },
          "maxPrice": {
            "title": "Max price (USD)",
            "minimum": 0,
            "maximum": 500000000,
            "type": "integer",
            "description": "Maximum listing price."
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of bedrooms."
          },
          "maxBedrooms": {
            "title": "Max bedrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum number of bedrooms."
          },
          "minBathrooms": {
            "title": "Min bathrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Minimum number of bathrooms."
          },
          "maxBathrooms": {
            "title": "Max bathrooms",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum number of bathrooms."
          },
          "minSqft": {
            "title": "Min square feet",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Minimum interior square footage."
          },
          "maxSqft": {
            "title": "Max square feet",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum interior square footage."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "recommended",
              "PropertySize desc",
              "PropertySize",
              "YearBuilt desc",
              "YearBuilt",
              "ListPrice desc",
              "ListPrice"
            ],
            "type": "string",
            "description": "Result ordering.",
            "default": "recommended"
          },
          "includeDetails": {
            "title": "Include full property details",
            "type": "boolean",
            "description": "Open each listing page and add photos, description, year built, lot size, MLS number, county, coordinates, tax amount, amenities, feature lists and listing-agent contact. Slower because it makes one extra request per listing. In search/nearby mode it also post-filters by the requested property type when the detail type is recognized. For mode=search and mode=nearby.",
            "default": false
          },
          "listingUrls": {
            "title": "Listing URLs",
            "type": "array",
            "description": "United Real Estate listing page URLs or paths, e.g. `https://www.unitedrealestate.com/home/for-sale/austin-tx/3808-balcones-dr/60134949`. For mode=byUrls.",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "title": "Listing URL",
                  "description": "A full United Real Estate listing URL or listing path.",
                  "type": "string"
                }
              }
            },
            "default": []
          },
          "mlsNumbers": {
            "title": "MLS numbers",
            "uniqueItems": true,
            "type": "array",
            "description": "MLS listing numbers to look up, e.g. `1191266`. Each is searched nationwide and a record is emitted only when the listing detail page shows the exact MLS number. For mode=byMlsNumbers.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "latitude": {
            "title": "Latitude",
            "minimum": -90,
            "maximum": 90,
            "type": "number",
            "description": "Center latitude for mode=nearby, e.g. `30.2672`."
          },
          "longitude": {
            "title": "Longitude",
            "minimum": -180,
            "maximum": 180,
            "type": "number",
            "description": "Center longitude for mode=nearby, e.g. `-97.7431`."
          },
          "radiusMiles": {
            "title": "Radius (miles)",
            "minimum": 0.1,
            "maximum": 500,
            "type": "number",
            "description": "Approximate search radius around the coordinate point. The source uses a map bounding box, so corner results can be farther than this value. For mode=nearby.",
            "default": 10
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Hard cap on emitted listings. Search results are fetched 250 at a time.",
            "default": 50
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}