{ "openapi": "3.0.1", "info": { "title": "Furnished Finder Scraper", "description": "Extract US mid-term rental listings from Furnished Finder by city. Rows include monthly rent, bedrooms, bathrooms, minimum stay, amenities, photos, and approximate coordinates. Schedule the same search to save only new listings.", "version": "0.1", "x-build-id": "fbPbtgrVd5CSzl6X1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~furnished-finder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-furnished-finder-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/crawloop~furnished-finder-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-furnished-finder-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/crawloop~furnished-finder-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-furnished-finder-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Housing search URLs. A city path uses the city fields below only when this list is empty. Map bounds on the URL replace the radius.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "city": { "title": "City", "type": "string", "description": "US city, for example Austin. Used when Start URLs is empty and no map box is set.", "default": "Austin" }, "state": { "title": "State", "type": "string", "description": "US state name or two-letter code, for example TX.", "default": "TX" }, "radiusMiles": { "title": "Radius (miles)", "minimum": 1, "maximum": 40, "type": "integer", "description": "Search radius around the city center. Ignored when a map box or a URL with map bounds is set.", "default": 15 }, "minLatitude": { "title": "Min latitude", "type": "number", "description": "South edge of a map box. Set all four edges to skip the city lookup." }, "minLongitude": { "title": "Min longitude", "type": "number", "description": "West edge of a map box." }, "maxLatitude": { "title": "Max latitude", "type": "number", "description": "North edge of a map box." }, "maxLongitude": { "title": "Max longitude", "type": "number", "description": "East edge of a map box." }, "minPrice": { "title": "Minimum monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Keep listings at or above this monthly rent." }, "maxPrice": { "title": "Maximum monthly rent (USD)", "minimum": 0, "type": "integer", "description": "Keep listings at or below this monthly rent." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Minimum bedroom count." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Minimum bathroom count." }, "propertyType": { "title": "Property type", "type": "string", "description": "Optional type match, for example House or Apartment. Leave empty for every type." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum dataset rows for this run. A city search splits the map when one view returns 50 listings and this cap is still open.", "default": 25 }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Save only listing ids that were not stored for this same search on the previous run. A quiet tick writes zero rows.", "default": false }, "monitorStateStore": { "title": "Monitor state store", "type": "string", "description": "Named key-value store that keeps seen listing ids across scheduled runs.", "default": "furnished-finder-monitor" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave proxy off. The public search endpoint answers without a proxy. Enable Apify Proxy only if a run is blocked, and try datacenter before residential.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }