{ "openapi": "3.0.1", "info": { "title": "Furnished Finder Listings and Host Contact Info", "description": "Return Furnished Finder listings, optional property-page details, host profiles, and host phone numbers from the published US dataset.", "version": "1.0", "x-build-id": "ie8LFmWebhcl7jqt4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datascrapers~furnishedfinder-listings-and-host-contact-info/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datascrapers-furnishedfinder-listings-and-host-contact-info", "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/datascrapers~furnishedfinder-listings-and-host-contact-info/runs": { "post": { "operationId": "runs-sync-datascrapers-furnishedfinder-listings-and-host-contact-info", "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/datascrapers~furnishedfinder-listings-and-host-contact-info/run-sync": { "post": { "operationId": "run-sync-datascrapers-furnishedfinder-listings-and-host-contact-info", "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": { "urls": { "title": "Furnished Finder URLs", "type": "array", "description": "Housing search URLs or property URLs (e.g. 'https://www.furnishedfinder.com/housing/us--ga--atlanta'). Optional if states, searchQueries, or listingIds is provided.", "items": { "type": "string" } }, "states": { "title": "States", "uniqueItems": true, "type": "array", "description": "One or more US states. Each selected state returns every listing in that state.", "items": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DC", "DE", "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", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "enumTitles": [ "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "District of Columbia", "Delaware", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Puerto Rico", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" ] } }, "searchQuery": { "title": "Search query", "type": "string", "description": "One location such as Austin or Atlanta, GA. City-only names are resolved automatically." }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Additional locations (e.g. ['Austin', 'Atlanta, GA']). City-only names are resolved automatically. Stored matches are returned first, then new listings from a live search.", "items": { "type": "string" } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Furnished Finder listing ids such as '1046391_1'. Optional.", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum number of listings to return (0 = unlimited).", "default": 0 }, "listingDetails": { "title": "Listing details", "type": "boolean", "description": "Add property-page fields (fees, house rules, reviews, coordinates, and the full description). Charged as listing-details. Off by default.", "default": false }, "hostInfo": { "title": "Host info", "type": "boolean", "description": "Add the host profile for each listing. Charged as host-info. Off by default.", "default": false }, "hostPhoneNumber": { "title": "Host phone number", "type": "boolean", "description": "Add the host phone number for paying customers. Free users receive 'Phone number is only available for paid users.' Charged as host-phone-number only when a real number is returned. Off by default.", "default": false }, "moveInDate": { "title": "Move-in date", "type": "string", "description": "Keep listings available on or before this date (YYYY-MM-DD). Optional." }, "moveOutDate": { "title": "Move-out date", "type": "string", "description": "Desired move-out date (YYYY-MM-DD). Optional." }, "minPrice": { "title": "Min monthly rent", "minimum": 0, "type": "integer", "description": "Minimum monthly rent in USD. Optional." }, "maxPrice": { "title": "Max monthly rent", "minimum": 0, "type": "integer", "description": "Maximum monthly rent in USD. Optional." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Optional.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }