{ "openapi": "3.0.1", "info": { "title": "Australian Home Loan Rates (RBA)", "description": "Curated time series of Australian housing-lending rates from the RBA F5 (Indicator) and F6 (Lenders Interest Rates) tables. Filter by loan purpose, rate type, segment, and institution scope.", "version": "0.1", "x-build-id": "zU3bnPh90yoBVdXUH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrjerry~home-loan-rates/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrjerry-home-loan-rates", "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/mrjerry~home-loan-rates/runs": { "post": { "operationId": "runs-sync-mrjerry-home-loan-rates", "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/mrjerry~home-loan-rates/run-sync": { "post": { "operationId": "run-sync-mrjerry-home-loan-rates", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "rates", "latest" ], "type": "string", "description": "What the Actor should do. 'rates' (default) returns the curated time series of housing-lending rates. 'latest' returns only the most recent month's records (one per curated series).", "default": "rates" }, "loan_purpose": { "title": "Loan purpose", "enum": [ "all", "owner_occupier", "investor" ], "type": "string", "description": "Filter by who the loan is for. 'owner_occupier' = the borrower lives in the property. 'investor' = the borrower is renting it out. 'all' = both.", "default": "all" }, "rate_type": { "title": "Rate type", "enum": [ "all", "variable", "variable_discounted", "fixed_3y", "fixed_over_3y" ], "type": "string", "description": "Filter by how the rate is set. 'variable' = moves with the cash rate. 'fixed_3y' = fixed for ≤3 years (residual). 'fixed_over_3y' = fixed for >3 years. 'all' = no filter.", "default": "all" }, "segment": { "title": "Segment", "enum": [ "all", "outstanding_all", "new_loans_all", "lvr_low", "lvr_high", "size_small", "size_mid", "size_large", "io", "pi", "indicator" ], "type": "string", "description": "Filter by what the rate applies to. 'outstanding_all' = the average rate on all loans currently on the books. 'new_loans_all' = the rate on loans funded in the most recent month. 'lvr_low' = new loans with LVR <80%. 'lvr_high' = new loans with LVR ≥80%. 'size_small'/'size_mid'/'size_large' = new loans under $600k / $600k–$1m / over $1m. 'io'/'pi' = interest-only / principal-and-interest. 'indicator' = the banks' advertised rates (from F5). 'all' = no filter.", "default": "all" }, "institution_scope": { "title": "Institution scope", "enum": [ "all", "large", "banks", "mortgage_managers", "securitised" ], "type": "string", "description": "Filter by who is reporting. 'all' = all institutions (banks + non-banks). 'large' = the major banks only. 'banks' = the bank sector (F5 indicator rates). 'mortgage_managers' = non-bank lenders (F5). 'securitised' = securitised loan book (F5).", "default": "all" }, "start_date": { "title": "Start date (YYYY-MM-DD)", "type": "string", "description": "Optional. Include only records on or after this date." }, "end_date": { "title": "End date (YYYY-MM-DD)", "type": "string", "description": "Optional. Include only records on or before this date." }, "limit": { "title": "Record limit", "minimum": 1, "type": "integer", "description": "Optional. Cap the number of records pushed." }, "include_f5": { "title": "Include F5 indicator rates", "type": "boolean", "description": "Whether to include the F5 (advertised / indicator) rates in the output. Default true. Set false to only get F6 (outstanding / new loans) data.", "default": true } } }, "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 } } } } } } } } } }