{ "openapi": "3.0.1", "info": { "title": "Ireland Rent and House Price Index (RTB / CSO)", "description": "Average monthly rent in Ireland (RTB rent index) by place, bedrooms, property type and quarter, plus the CSO Residential Property Price Index by area and type of home. Irish rent statistics and property price data; one row per figure, CC BY 4.0.", "version": "0.1", "x-build-id": "DYFx7k9zzIlpKNknT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yappman~ireland-rent-index/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yappman-ireland-rent-index", "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/yappman~ireland-rent-index/runs": { "post": { "operationId": "runs-sync-yappman-ireland-rent-index", "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/yappman~ireland-rent-index/run-sync": { "post": { "operationId": "run-sync-yappman-ireland-rent-index", "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": { "mode": { "title": "Mode", "enum": [ "search", "lookup" ], "type": "string", "description": "search: rows for the places, bedrooms, property types and quarters you filter. lookup: for each place (give locations), the latest average rent and the change on the same quarter a year earlier, one row per place, bedrooms group and property type: up to 42 rows ($0.042) per place unless you filter bedrooms and propertyTypes (\"All bedrooms\" and \"All property types\" give one row per place). For HPM09: search returns one row per month, category and statistic; lookup returns the latest index, the index a year earlier and the CSO's published changes.", "default": "search" }, "table": { "title": "Table", "enum": [ "RIQ02", "HPM09" ], "type": "string", "description": "The CSO table. RIQ02 is the quarterly average monthly rent report. HPM09 is the monthly Residential Property Price Index (for HPM09, locations are the table's category names such as \"Dublin - houses\"; bedrooms, propertyTypes and the quarter fields do not apply).", "default": "RIQ02" }, "locations": { "title": "Locations", "maxItems": 50, "type": "array", "description": "Place names exactly as the table spells them (any capitals). Search: optional, up to 50. Lookup: required, 1 to 20.", "items": { "type": "string" } }, "bedrooms": { "title": "Number of bedrooms", "maxItems": 50, "type": "array", "description": "Values of the table's bedrooms dimension, as spelled there. Optional.", "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "maxItems": 50, "type": "array", "description": "Values of the table's property type dimension, as spelled there. Optional.", "items": { "type": "string" } }, "quarterFrom": { "title": "From quarter (search)", "type": "string", "description": "A quarter such as 2024Q1. Search mode only." }, "quarterTo": { "title": "To quarter (search)", "type": "string", "description": "A quarter such as 2025Q4. Search mode only." }, "maxItems": { "title": "Max rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most rows returned, and so the most you can be charged for ($0.001 a row). The Console form starts at 10; through the API the default is 100. Search: at most 100,000. Lookup: at most 2,000. Cells the source marks as insufficient data are not returned and not charged.", "default": 100 }, "statistics": { "title": "Statistics (HPM09 search)", "maxItems": 4, "type": "array", "description": "HPM09 search only. Any of: index, change1m, change3m, change12m (the index and the CSO's own 1-, 3- and 12-month percentage changes). Default: index. Each statistic is a separate row.", "items": { "type": "string" } }, "monthFrom": { "title": "From month (HPM09 search)", "type": "string", "description": "A month such as 2024-01. HPM09 search only." }, "monthTo": { "title": "To month (HPM09 search)", "type": "string", "description": "A month such as 2026-08. HPM09 search only." } } }, "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 } } } } } } } } } }