{
  "openapi": "3.0.1",
  "info": {
    "title": "RentCafe City Apartment Price & Amenity Finder",
    "description": "Search RentCafe.com apartment listings for a US city by bedroom count, price tier or amenity, returning address, coordinates, pricing by unit type, rating and management company per property.",
    "version": "1.0",
    "x-build-id": "FGTHoolTbKU4tvQjP"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dataspryva~rentcafe-city-apartment-price-and-amenity-finder/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dataspryva-rentcafe-city-apartment-price-and-amenity-finder",
        "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/dataspryva~rentcafe-city-apartment-price-and-amenity-finder/runs": {
      "post": {
        "operationId": "runs-sync-dataspryva-rentcafe-city-apartment-price-and-amenity-finder",
        "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/dataspryva~rentcafe-city-apartment-price-and-amenity-finder/run-sync": {
      "post": {
        "operationId": "run-sync-dataspryva-rentcafe-city-apartment-price-and-amenity-finder",
        "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": [
              "city",
              "urls"
            ],
            "type": "string",
            "description": "`City search` builds a RentCafe search from a city and the filters below. `Search URLs` scrapes one or more existing RentCafe city search URLs and applies any filters you set on top of each URL.",
            "default": "city"
          },
          "location": {
            "title": "City",
            "type": "string",
            "description": "A US city as it appears on RentCafe, e.g. `austin-tx`, `Austin, TX`, or `new-york-city-ny`; spaces and commas are converted to the RentCafe URL slug. A full RentCafe city search URL is also accepted. Required in `City search` mode."
          },
          "searchUrls": {
            "title": "RentCafe search URLs",
            "type": "array",
            "description": "One or more RentCafe city search URLs, e.g. `https://www.rentcafe.com/apartments-for-rent/austin-tx/pet-friendly/`. Required in `Search URLs` mode. Each URL's own path filter and supported query parameters are honoured; filters below override matching URL parameters.",
            "items": {
              "type": "string"
            }
          },
          "beds": {
            "title": "Bedrooms",
            "enum": [
              "",
              "studio",
              "1",
              "2",
              "3",
              "4plus"
            ],
            "type": "string",
            "description": "RentCafe's own bedroom filter. `Studio` matches studios; `4+` matches four or more bedrooms.",
            "default": ""
          },
          "bathrooms": {
            "title": "Bathrooms",
            "enum": [
              "",
              "1",
              "2",
              "3plus"
            ],
            "type": "string",
            "description": "Minimum bathroom count.",
            "default": ""
          },
          "petPolicy": {
            "title": "Pet policy",
            "enum": [
              "",
              "pet-friendly",
              "cats",
              "dogs",
              "no-pets"
            ],
            "type": "string",
            "description": "RentCafe pet-policy filter.",
            "default": ""
          },
          "amenity": {
            "title": "Amenity",
            "enum": [
              "",
              "c1",
              "c2",
              "c3",
              "c4",
              "c5",
              "c6",
              "c7",
              "c8",
              "c9",
              "c10",
              "c11",
              "c12",
              "c16",
              "c17",
              "c18",
              "c19",
              "c21",
              "c23",
              "c24",
              "c25",
              "c34"
            ],
            "type": "string",
            "description": "One apartment amenity that every returned community must offer, using RentCafe's own amenity filter.",
            "default": ""
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "",
              "apartment",
              "condo",
              "home",
              "townhouse",
              "student",
              "affordable"
            ],
            "type": "string",
            "description": "RentCafe property-type filter.",
            "default": ""
          },
          "minPrice": {
            "title": "Minimum rent ($/month)",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Only include communities with a unit at or above this monthly rent. Uses RentCafe's own price filter, and the record is re-checked after parsing."
          },
          "maxPrice": {
            "title": "Maximum rent ($/month)",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Only include communities with a unit at or below this monthly rent. Uses RentCafe's own price filter, and the record is re-checked after parsing."
          },
          "minRating": {
            "title": "Minimum rating (0-5)",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Drop communities rated below this. Whole numbers from 3 to 5 are also sent to RentCafe's rating filter; other values are applied to the returned records."
          },
          "rentSpecialsOnly": {
            "title": "Rent specials only",
            "type": "boolean",
            "description": "Only include communities currently advertising a rent special.",
            "default": false
          },
          "moveInDate": {
            "title": "Move-in date",
            "type": "string",
            "description": "Optional move-in date in `YYYY-MM-DD` format; RentCafe returns communities with availability around that date."
          },
          "sort": {
            "title": "Sort order",
            "enum": [
              "",
              "price-low",
              "price-high",
              "rating-high",
              "newest",
              "virtual-tour"
            ],
            "type": "string",
            "description": "Result order applied by RentCafe.",
            "default": ""
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Hard cap on emitted communities. RentCafe's public city search paginates its own community results, usually 25 per page; the status message reports when the source ceiling is reached.",
            "default": 25
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}