{ "openapi": "3.0.1", "info": { "title": "Dutch Housing Figures by Municipality", "description": "Average sale price, house price index, WOZ value and rent increase for Dutch municipalities, from CBS open data. One row per municipality, measure and period, with the CBS licence on each row. $0.001 per figure.", "version": "0.1", "x-build-id": "KmaZArgHC1cADcL8R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vizellie~nl-housing-figures-cbs/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vizellie-nl-housing-figures-cbs", "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/vizellie~nl-housing-figures-cbs/runs": { "post": { "operationId": "runs-sync-vizellie-nl-housing-figures-cbs", "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/vizellie~nl-housing-figures-cbs/run-sync": { "post": { "operationId": "run-sync-vizellie-nl-housing-figures-cbs", "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": { "municipalities": { "title": "Municipalities", "type": "array", "description": "Municipality names or codes, for example Amsterdam, GM0599 or Den Haag. Den Haag and The Hague select 's-Gravenhage. Leave the list empty for every municipality.", "items": { "type": "string" } }, "measures": { "title": "Measures", "type": "array", "description": "Figures to return. The house price index and the rent increase are published for some municipalities only. The other municipalities are left out for those measures.", "items": { "type": "string", "enum": [ "averageSalePrice", "priceIndex", "wozValue", "rentIncrease", "rentIncreaseExcludingHarmonisation" ], "enumTitles": [ "Average sale price", "House price index", "WOZ value", "Rent increase, including harmonisation", "Rent increase, excluding harmonisation" ] }, "default": [ "averageSalePrice", "priceIndex", "wozValue", "rentIncrease" ] }, "startPeriod": { "title": "Start period", "type": "string", "description": "First period to keep, inclusive. Use a year such as 2024, or a quarter such as 2026-Q2. Leave empty to take the latest periods. A year keeps every quarter of the house price index in that year." }, "endPeriod": { "title": "End period", "type": "string", "description": "Last period to keep, inclusive. Same shapes as the start period. An end in the future is brought back to the current period." }, "lastPeriods": { "title": "Latest periods", "minimum": 1, "maximum": 40, "type": "integer", "description": "How many newest periods to keep for each measure, when start and end are empty. From 1 to 40. Default 1. The house price index is quarterly. The other measures are yearly.", "default": 1 }, "maxRows": { "title": "Max rows", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Most rows saved in one run, from 1 to 20000. The newest periods are kept. Default 2000.", "default": 2000 } } }, "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 } } } } } } } } } }