{ "openapi": "3.0.1", "info": { "title": "FINN.no Scraper - Norway Property Listings", "description": "Extract FINN.no property listings in Norway, including prices, sizes, locations, photos and available agent contacts. Search categories or collect specific ads. Billed per delivered row plus a start event.", "version": "0.1", "x-build-id": "wa25jzFBnn7cc3V6W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~finn-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-finn-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/lentic_clockss~finn-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-finn-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/lentic_clockss~finn-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-finn-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", "maxLength": 160, "type": "string", "description": "Enter a Norwegian place name, such as Oslo or Bergen, or a FINN location code such as 0.20061. With no target supplied, the Actor requests a small Oslo example." }, "channel": { "title": "Channel", "enum": [ "sale", "rent", "projects", "leisure", "leisure_plots", "plot", "commercial", "abroad", "planned", "office", "torget", "car", "mc", "boat", "caravan", "job", "nybrukt" ], "type": "string", "description": "Choose the FINN category to collect. Office profiles require officeUrl or profile URLs in detailUrls; Nybrukt collects refurbished electronics.", "default": "sale" }, "q": { "title": "Search query", "type": "string", "description": "Search words for the selected FINN category. A keyword without a location uses Oslo." }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "Collect specific FINN ad URLs instead of running the usual search. Enter one URL per line, such as https://www.finn.no/realestate/homes/ad.html?finnkode=123456789.", "items": { "type": "string" } }, "officeUrl": { "title": "Office URL", "pattern": "^(https?://)?([A-Za-z0-9-]+\\.)*finn\\.no(/.*)?$", "type": "string", "description": "FINN broker or company profile URL. Set channel to office; officeUrl or profile URLs in detailUrls are required for that channel." }, "maxResults": { "title": "Max results per location, URL, or ID", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum delivered rows per location search, detail URL or service ID. Default 70; larger requests are collected in parts of 70, within the run charge limit and the free-plan limit of 200 rows per run and 10 runs.", "default": 70 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Search-page setting from 1 to 100. Collection may expand this setting to reach maxResults, so it is not a strict one-page limit.", "default": 1 }, "fetchAllPages": { "title": "Fetch all pages", "type": "boolean", "description": "Continue through available search pages while staying within maxResults. This does not guarantee that every matching ad is available.", "default": false }, "feed": { "title": "Feed enumeration", "type": "boolean", "description": "Read recent feed entries for the torget or job channel instead of a regular search.", "default": false }, "enumerateMode": { "title": "Discover listing URLs", "enum": [ "sitemap", "seed_pool", "bare_id", "map", "mapBbox", "mapLayers" ], "type": "string", "description": "Discover ads from a sitemap, a saved collection of URLs or a map area. The bare_id option is not available as a dedicated collection path; use detailUrls for known ads." }, "revealPhones": { "title": "Include available vehicle phone numbers", "type": "boolean", "description": "Request available phone numbers for vehicle ads. Numbers that are not publicly provided remain unavailable.", "default": false }, "appsgwService": { "title": "FINN data service", "type": "string", "description": "Choose a FINN data service, such as location_autocomplete, company_profile or messaging_ad_store. Supply the matching term or identifier in the fields below." }, "appsgwTerm": { "title": "Service search term", "type": "string", "description": "Search term for suggestion services, or job-title text for supported occupation services." }, "appsgwId": { "title": "Service identifier", "type": "string", "description": "One identifier for the selected service: an ad, organization, postal area, occupation or agent identifier." }, "appsgwIds": { "title": "Service identifiers", "type": "array", "description": "List of ad identifiers for messaging_ad_store. All returned rows count toward the run charge limit.", "items": { "type": "string" } }, "appsgwLimit": { "title": "Suggestion limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum suggestions requested from a suggestion service, from 1 to 100. Leave empty to use its default; maxResults still limits delivered rows." }, "nybruktCategory": { "title": "Nybrukt category", "type": "string", "description": "Refurbished-electronics category with channel set to nybrukt: mobil, nettbrett, smartklokke, lyd or laptop. These mean phones, tablets, smartwatches, audio and laptops." }, "nybruktProduct": { "title": "Nybrukt product slug", "type": "string", "description": "Product slug with channel set to nybrukt, for example apple,iphone-14. Returns available reseller or product-variant rows." }, "nybruktExpandVariants": { "title": "Expand Nybrukt variants", "type": "boolean", "description": "For a Nybrukt category, expand products into available reseller-variant rows. Off by default; each delivered variant counts as one billed row.", "default": false }, "mapBbox": { "title": "Map area coordinates", "type": "string", "description": "Map area as min_lon,min_lat,max_lon,max_lat. If omitted for map discovery, the default covers southern Norway." }, "mapZoom": { "title": "Map zoom", "minimum": 3, "maximum": 16, "type": "integer", "description": "Map zoom level from 3 to 16. The default is 10.", "default": 10 }, "mapLayers": { "title": "Map layers", "type": "array", "description": "FINN map-layer identifiers to include. Leave empty to use the available public-search layers.", "items": { "type": "string" } }, "priceFrom": { "title": "Price from (NOK)", "minimum": 0, "type": "integer", "description": "Minimum price in Norwegian kroner for supported search channels." }, "priceTo": { "title": "Price to (NOK)", "minimum": 0, "type": "integer", "description": "Maximum price in Norwegian kroner for supported search channels." }, "priceCollectiveFrom": { "title": "Collective price from", "minimum": 0, "type": "integer", "description": "Minimum collective price in Norwegian kroner, where this property filter is supported." }, "priceCollectiveTo": { "title": "Collective price to", "minimum": 0, "type": "integer", "description": "Maximum collective price in Norwegian kroner, where this property filter is supported." }, "areaFrom": { "title": "Area from (m²)", "minimum": 0, "type": "integer", "description": "Minimum property area in square metres." }, "areaTo": { "title": "Area to (m²)", "minimum": 0, "type": "integer", "description": "Maximum property area in square metres." }, "plotAreaFrom": { "title": "Plot area from (m²)", "minimum": 0, "type": "integer", "description": "Minimum plot area in square metres." }, "plotAreaTo": { "title": "Plot area to (m²)", "minimum": 0, "type": "integer", "description": "Maximum plot area in square metres." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms, from 0 to 20." }, "propertyType": { "title": "Property type", "type": "string", "description": "FINN property category ID or label, such as 3 or leilighet for apartments." }, "ownershipType": { "title": "Ownership type", "type": "string", "description": "FINN ownership category ID or label, such as 3 or selveier for freehold ownership." }, "constructionYearFrom": { "title": "Construction year from", "type": "integer", "description": "Earliest construction year to include, from 1800 to 2100." }, "constructionYearTo": { "title": "Construction year to", "type": "integer", "description": "Latest construction year to include, from 1800 to 2100." }, "published": { "title": "Published filter", "type": "string", "description": "FINN recency-filter value. This is not an automatically advancing date range." }, "videoType": { "title": "Video type", "type": "string", "description": "FINN video-filter value, where supported by the selected property category." }, "sort": { "title": "Sort", "enum": [ "PUBLISHED_DESC", "PRICE_ASC", "PRICE_DESC", "PRICE_ASKING_ASC", "PRICE_ASKING_DESC", "PRICE_SQM_ASC", "PRICE_SQM_DESC", "AREA_PROM_ASC", "AREA_PROM_DESC" ], "type": "string", "description": "Choose the ordering of search results. Unrecognized values are ignored rather than failing the run." }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Add available listing details, including viewing information, facilities, photos and contact fields. Enabled by default; field availability varies by ad.", "default": true }, "enrichOffice": { "title": "Enrich office", "type": "boolean", "description": "Add available office information to a listing row. Off by default; a published office link is required for additional profile details.", "default": false }, "enrichAreaProfile": { "title": "Enrich area profile", "type": "boolean", "description": "Add available area-profile information to enrichment.areaProfile. Off by default; unavailable information may include an error description.", "default": false }, "enrichOwnershipHistory": { "title": "Enrich ownership history", "type": "boolean", "description": "Add available property ownership-history information to enrichment.ownershipHistory. Off by default; coverage varies by ad.", "default": false }, "enrichNeighborhood": { "title": "Enrich neighborhood", "type": "boolean", "description": "Add available neighborhood information to enrichment.neighborhood. Off by default; coverage varies by ad.", "default": false }, "incremental": { "title": "Skip previously seen ads", "type": "boolean", "description": "Skip listing IDs remembered from previous runs. This does not detect price changes; a run with only previously seen listings can succeed with no new rows.", "default": false }, "includeRaw": { "title": "Include extra source fields", "type": "boolean", "description": "Include additional source fields on rows where supported. Off by default.", "default": false }, "fields": { "title": "Output field selection", "type": "array", "description": "Optional list of output field names to keep. Leave empty for full rows; selecting fields can omit useful listing details.", "items": { "type": "string" } }, "webhookUrl": { "title": "Webhook URL", "pattern": "^https://.+", "type": "string", "description": "Optional HTTPS address for a result notification. Notification failures are reported as warnings." }, "workerBaseUrl": { "title": "Developer testing", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }