{ "openapi": "3.0.1", "info": { "title": "FurnishedFinder $1💰 Listings, Amenities & Reviews", "description": "From $1/1K. Scrape furnishedfinder.com listings by city or URL. Extract structured data including price, beds, baths, occupancy, amenities, photos, location, square footage, ratings, reviews, utilities, house rules, and fees. Fast and reliable via the site's data API.", "version": "1.1", "x-build-id": "UU5kX0Ez91Cof0h3r" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~furnishedfinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-furnishedfinder-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/abotapi~furnishedfinder-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-furnishedfinder-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/abotapi~furnishedfinder-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-furnishedfinder-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "url" ], "type": "string", "description": "search = enter cities and filters. url = paste Furnished Finder search or property URLs.", "default": "search" }, "locations": { "title": "Cities", "type": "array", "description": "Cities to scrape. Accepts free text ('Houston, TX', 'Houston'), 'City, State', or a Furnished Finder slug ('us--tx--houston'). One search box is built around each city.", "default": [ "Houston, TX" ], "items": { "type": "string" } }, "propertyTypeClass": { "title": "Property type", "enum": [ "any", "entire_unit", "room" ], "type": "string", "description": "Entire unit (whole place) or Room (private/shared room). Leave as Any for both.", "default": "any" }, "minPrice": { "title": "Min monthly price (USD)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent. Leave empty for no minimum." }, "maxPrice": { "title": "Max monthly price (USD)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent. Leave empty for no maximum." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum bedroom count. Leave empty for any." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Minimum bathroom count. Leave empty for any." }, "moveInDate": { "title": "Move-in date (YYYY-MM-DD)", "type": "string", "description": "Only listings available by this date. Leave empty for any. Applies to search mode." }, "moveOutDate": { "title": "Move-out date (YYYY-MM-DD)", "type": "string", "description": "Only listings that can host a stay ending on this date. Leave empty for any. Applies to search mode." }, "urls": { "title": "URLs", "type": "array", "description": "Paste Furnished Finder city search URLs (/housing/us--tx--houston, also with ?map= or ?filters= queries, or the legacy /rooms suffix) or property URLs (/property/999116_1 or /property/999116). Multi-URL supported. Left untouched, this list of one example per URL shape is scraped (capped by Max listings).", "default": [ "https://www.furnishedfinder.com/housing/us--tx--houston", "https://www.furnishedfinder.com/housing/us--tx--houston?map=%7B%22min%22%3A%7B%22latitude%22%3A29.5049885802716%2C%22longitude%22%3A-95.83213727429509%7D%2C%22max%22%3A%7B%22latitude%22%3A30.1253449588269%2C%22longitude%22%3A-95.04882504723966%7D%7D", "https://www.furnishedfinder.com/property/999116_1", "https://www.furnishedfinder.com/property/999116", "https://www.furnishedfinder.com/housing/us--tx--austin?filters=%5B%7B%22key%22%3A%22property-type-class%22%2C%22value%22%3A%22room%22%7D%5D", "https://www.furnishedfinder.com/housing/us--tx--houston/rooms" ], "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch full property details", "type": "boolean", "description": "ON: each listing gets description, square footage, rating, review count, utilities, house rules, fees, full amenity list and bed/bath breakdown (one extra request per listing). OFF: faster, listing-card fields only.", "default": true }, "fetchReviews": { "title": "Include guest reviews", "type": "boolean", "description": "ON: add a reviews array per listing (reviewer, star rating, date, text, landlord reply). Applies whenever the full property page is fetched ('Fetch full property details' ON, or any pasted property URL), and only listings that have reviews cost an extra request. Billing: every 10 delivered reviews (rounded up over the whole run, only on returned listings) adds one detail-enrichment unit, capped by Max reviews per listing. Turn OFF to keep details but skip reviews.", "default": true }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Keep at most this many guest reviews on each listing (newest first as returned by the site). Only used when Include guest reviews is ON. Billing: every 10 delivered reviews (rounded up over the whole run, only on returned listings) adds one detail-enrichment unit, so this cap bounds the review charge per listing.", "default": 20 }, "maxPages": { "title": "Max pages per city", "minimum": 0, "type": "integer", "description": "How many result pages (50 listings each) to walk per city/search URL. 0 (default) means unlimited - the walk stops naturally once a page comes back empty or repeats listings already collected, or sooner once Max listings is reached. Set a number only for an explicit page cap below that natural stop.", "default": 0 }, "maxListings": { "title": "Max listings (total, default 20, 0 = unlimited)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "The sole soft cap on the run: stop after this many listings across all cities/URLs. Defaults to 20 so a run stays small unless you raise it. 0 = unlimited (bounded only by the natural stop on Max pages).", "default": 20 }, "proxy": { "title": "Proxy", "type": "object", "description": "Residential US is required. Free plans do not include residential proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "resumeFromRunId": { "title": "Resume from a prior run", "type": "string", "description": "Optional. Paste a previous run ID or dataset ID to continue a large walk-all pull: listings already saved by that run are loaded before scraping starts and skipped, so this run only appends new listings. Leave empty for a normal fresh run. For recurring daily monitoring of the same search, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns all matching listings as NEW. Later runs normally return only NEW, UPDATED, and REAPPEARED listings. Turn on \"Emit unchanged\" or \"Emit expired\" only when you also want those listings returned (and billed). State is kept separately for each city/URL/filter and detail-mode setup; use State key when you want to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a prior run above. Compared: every output field of a listing (price, availability, amenities, details, photos and so on); NOT compared: scrapedAt, the guest reviews array and photo URL query strings, plus anything you list in \"Ignore fields when detecting changes\". Only a changed compared field returns the listing as UPDATED.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently-configured runs. Leave empty to let the actor derive a key automatically from the cities/URLs, filters and detail settings — different searches then never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that have not changed since the last run, marked UNCHANGED. This returns — and bills — extra rows you already have, so leave it off unless you specifically want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired listings (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search — not when Max listings capped it or when Resume was used. This returns — and bills — extra synthetic rows, so leave it off unless you need expiry tracking.", "default": false }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Field names that must NOT make a listing count as UPDATED. Use a top-level name (e.g. amenities) or a dotted path for nested fields (e.g. fees.amount, houseRules.description; arrays are searched element by element). Ignored fields stay in the output; they are only left out of the comparison and changedFields. Already excluded by default: scrapedAt, reviews, and photo URL query strings.", "default": [], "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify → Settings → Integrations, then select it here. Notion gets a page per item; other connectors receive a best-effort write/digest. Leave empty to skip — this never changes the dataset output. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "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 } } } } } } } } } }