{ "openapi": "3.0.1", "info": { "title": "Flatfox Property Scraper", "description": "Scrape Flatfox.ch property listings for rent or sale: price, rooms, living space, address, coordinates, photos, agency, and dates. Search by city, postal code, filters, or paste Flatfox search URLs. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "BjFruIz73dyht0NC5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~flatfox-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-flatfox-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/parsebird~flatfox-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-flatfox-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/parsebird~flatfox-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-flatfox-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": "Search URLs", "type": "array", "description": "Flatfox search-result URLs (e.g. https://flatfox.ch/en/search/?offer_type=RENT&north=47.43&south=47.32&east=8.63&west=8.45). The scraper reads the filters and map area straight from each URL. Leave empty to build a search below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "offerType": { "title": "Offer type", "enum": [ "RENT", "SALE" ], "type": "string", "description": "Search properties for rent or for sale. Used only when no Search URLs are provided.", "default": "RENT" }, "location": { "title": "Location", "type": "string", "description": "City, region, or postal code to search (for example \"Zurich\", \"Geneva\", or \"8005\"). Leave empty to search all of Switzerland." }, "objectCategories": { "title": "Property categories", "type": "array", "description": "Limit results to these categories. Leave empty for all.", "items": { "type": "string", "enum": [ "APARTMENT", "HOUSE", "SECONDARY", "SHARED", "INDUSTRY", "PARK" ], "enumTitles": [ "Apartment", "House", "Secondary rooms (storage, hobby)", "Shared / room in flat", "Commercial / industrial", "Parking / garage" ] }, "default": [] }, "priceMin": { "title": "Min price (CHF)", "minimum": 0, "type": "integer", "description": "Only include listings at or above this price. For rentals this is the monthly rent." }, "priceMax": { "title": "Max price (CHF)", "minimum": 0, "type": "integer", "description": "Only include listings at or below this price." }, "roomsMin": { "title": "Min rooms", "type": "string", "description": "Minimum number of rooms. Half rooms are allowed (for example 2.5)." }, "roomsMax": { "title": "Max rooms", "type": "string", "description": "Maximum number of rooms (for example 4.5)." }, "spaceMin": { "title": "Min living space (m²)", "minimum": 0, "type": "integer", "description": "Minimum living space in square meters." }, "spaceMax": { "title": "Max living space (m²)", "minimum": 0, "type": "integer", "description": "Maximum living space in square meters." }, "sortBy": { "title": "Sort by", "enum": [ "newest", "price_asc", "price_desc", "rooms_asc", "rooms_desc", "space_desc" ], "type": "string", "description": "Result order.", "default": "newest" }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Total number of listings to collect across all searches and URLs. Set to 0 to collect as many as available.", "default": 100 }, "maxResultsPerUrl": { "title": "Max results per URL", "minimum": 0, "type": "integer", "description": "Maximum listings to collect from each individual search or URL. Set to 0 for no per-URL limit.", "default": 0 }, "ignoreUrlFailures": { "title": "Ignore URL failures", "type": "boolean", "description": "When enabled, the scraper skips any search or URL that fails and continues with the rest. When disabled, the run stops on the first failure.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 12, "type": "integer", "description": "Maximum parallel requests to Flatfox.", "default": 6 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy routing. Datacenter proxy is enough for Flatfox.", "default": { "useApifyProxy": true } } } }, "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 } } }, "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 } } } } } } } } } }