{ "openapi": "3.0.1", "info": { "title": "Portugal Housing & Interest Rates Feed", "description": "Portugal Housing & Interest Rates Feed", "version": "0.0", "x-build-id": "HdxPl1n3wW4bH0LjC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pearlink~portugal-housing-interest-rates-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pearlink-portugal-housing-interest-rates-feed", "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/pearlink~portugal-housing-interest-rates-feed/runs": { "post": { "operationId": "runs-sync-pearlink-portugal-housing-interest-rates-feed", "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/pearlink~portugal-housing-interest-rates-feed/run-sync": { "post": { "operationId": "run-sync-pearlink-portugal-housing-interest-rates-feed", "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": { "series": { "title": "Series", "type": "array", "description": "Ready-made series. ECB: ecb_deposit_rate (daily), ea_yield_curve_10y and ea_yield_curve_2y (euro area AAA, business days), pt_10y_bond_yield (monthly). Banco de Portugal: pt_mortgage_new_rate (rate on new housing loans), pt_mortgage_new_volume, pt_mortgage_stock (monthly). INE: pt_house_price_index (quarterly, 2025 = 100), pt_rent_new_contracts_m2 (median rent of new leases over the last 12 months, quarterly), pt_bank_appraisal_m2 (monthly).", "items": { "type": "string", "enum": [ "ecb_deposit_rate", "ea_yield_curve_10y", "ea_yield_curve_2y", "pt_10y_bond_yield", "pt_mortgage_new_rate", "pt_mortgage_new_volume", "pt_mortgage_stock", "pt_house_price_index", "pt_rent_new_contracts_m2", "pt_bank_appraisal_m2" ], "enumTitles": [ "ECB deposit facility rate", "Euro area 10-year AAA yield", "Euro area 2-year AAA yield", "Portugal 10-year bond yield", "Portugal rate on new housing loans", "Portugal new housing loans (amount)", "Portugal housing loans (stock)", "Portugal house price index", "Portugal median rent of new leases (EUR/m²)", "Portugal bank appraisal value (EUR/m²)" ] } }, "customSeries": { "title": "Custom series", "type": "array", "description": "Any other series by its official code. ECB: {\"source\": \"ecb\", \"key\": \"IRS.M.PT.L.L40.CI.0000.EUR.N.Z\"}. Banco de Portugal: {\"source\": \"bpstat\", \"id\": \"12533735\"}. INE: {\"source\": \"ine\", \"varcd\": \"0014765\", \"dims\": {\"Dim2\": \"PT\", \"Dim3\": \"H1\"}} (dims must narrow the indicator to one value per period). Euribor and EONIA are not available. Maximum 50." }, "dateFrom": { "title": "From date", "type": "string", "description": "First period to include, YYYY-MM-DD. Defaults to 1 January three years ago. Dates are the first day of each period (a Q2 value is dated YYYY-04-01)." }, "dateTo": { "title": "To date", "type": "string", "description": "Last period to include, YYYY-MM-DD. Defaults to today." } } }, "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 } } } } } } } } } }