{ "openapi": "3.0.1", "info": { "title": "Flatfox Scraper — Swiss Rental & Property Listings", "description": "Scrape rental and property listings from Flatfox.ch — Switzerland's rental and flatshare marketplace. Extract apartments and houses with CHF prices, rooms, living space, addresses, coordinates, and photos across every Swiss city and canton.", "version": "0.1", "x-build-id": "rrr6m30JmfICGLVr8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studio-amba~flatfox-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studio-amba-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/studio-amba~flatfox-scraper/runs": { "post": { "operationId": "runs-sync-studio-amba-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/studio-amba~flatfox-scraper/run-sync": { "post": { "operationId": "run-sync-studio-amba-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": { "location": { "title": "Location (Swiss city)", "type": "string", "description": "A major Swiss city name (e.g. 'zurich', 'geneva', 'basel', 'lausanne', 'lugano'). Flatfox has no server-side city filter, so this is resolved to a search area via a built-in city lookup table. Ignored when boundingBox or latitude/longitude are provided.", "default": "zurich" }, "radiusKm": { "title": "Search radius (km)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Half-width of the search box around the resolved city center (or latitude/longitude), in kilometers. Larger values cover more of the surrounding area/canton.", "default": 6 }, "latitude": { "title": "Latitude (advanced)", "type": "number", "description": "Explicit search center latitude. Used with longitude + radiusKm instead of location. Overrides location." }, "longitude": { "title": "Longitude (advanced)", "type": "number", "description": "Explicit search center longitude. Used with latitude + radiusKm instead of location." }, "boundingBox": { "title": "Bounding box (advanced)", "type": "object", "description": "Explicit { north, south, east, west } lat/lon bounding box. Overrides location and latitude/longitude entirely — copy these values from a flatfox.ch map search URL/network request if you need an exact area." }, "listingType": { "title": "Listing Type", "enum": [ "rent", "sale", "any" ], "type": "string", "description": "Filter by rent or sale. Flatfox is a rental-first marketplace — most listings are for rent, sale listings are a small minority.", "default": "rent" }, "objectCategory": { "title": "Property Category", "enum": [ "residential", "all" ], "type": "string", "description": "'residential' keeps apartments, houses and shared flats only, filtering out parking slots, storage/cellar compartments, offices and industrial units that also appear on Flatfox. 'all' returns every category.", "default": "residential" }, "priceMin": { "title": "Minimum price (CHF)", "minimum": 0, "type": "integer", "description": "Only return listings at or above this price (CHF, applied client-side after fetching)." }, "priceMax": { "title": "Maximum price (CHF)", "minimum": 0, "type": "integer", "description": "Only return listings at or below this price (CHF, applied client-side after fetching)." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of listings to return.", "default": 50 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Flatfox.ch runs Cloudflare — plain requests currently pass without a challenge, but Swiss residential proxies are kept as the default for resilience if that changes.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CH" } } } }, "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 } } } } } } } } } }