{ "openapi": "3.0.1", "info": { "title": "Korea 아파트 전월세 실거래가 API (Apartment Jeonse & Rent)", "description": "Official Korean apartment jeonse and monthly-rent contracts from the Ministry of Land register. Real KRW, English labels, a stable complex ID and a geocodable road address on every row. Every renewal filing carries its previous deposit and rent.", "version": "0.1", "x-build-id": "UjLz9VYZfyNkg9Vje" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/linus009400~korea-rent-transactions-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-linus009400-korea-rent-transactions-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/linus009400~korea-rent-transactions-scraper/runs": { "post": { "operationId": "runs-sync-linus009400-korea-rent-transactions-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/linus009400~korea-rent-transactions-scraper/run-sync": { "post": { "operationId": "run-sync-linus009400-korea-rent-transactions-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", "required": [ "regions" ], "properties": { "regions": { "title": "Districts", "type": "array", "description": "English name (`Gangnam-gu`), Korean name (`강남구`, `서울 강남구`), or a 5-digit 시군구 code (`11680`). Mix freely. Cities that are divided into 구 must be given at 구 level — `Seongnam Bundang-gu`, not `성남시`.", "default": [ "Gangnam-gu" ], "items": { "type": "string" } }, "monthFrom": { "title": "From month", "type": "string", "description": "`YYYY-MM`, e.g. `2026-01`. Defaults to the last completed month — rental contracts must be filed within 30 days, so the current month is always incomplete." }, "monthTo": { "title": "To month", "type": "string", "description": "`YYYY-MM`. Leave empty to fetch a single month." }, "months": { "title": "Specific months", "type": "array", "description": "Exact months to fetch, e.g. `2025-06`, `2026-06`. Overrides the range above — useful for year-on-year comparisons.", "items": { "type": "string" } }, "leaseType": { "title": "Lease type", "enum": [ "ANY", "JEONSE", "MONTHLY_RENT" ], "type": "string", "description": "`JEONSE` is the deposit-only Korean lease (no monthly rent). `MONTHLY_RENT` covers 월세 and 반전세, where a deposit and a monthly rent are both paid.", "default": "ANY" }, "contractType": { "title": "Contract type", "enum": [ "ANY", "NEW", "RENEWAL" ], "type": "string", "description": "`RENEWAL` contracts carry the previous deposit and rent, which is what makes the increase and conversion-rate fields computable.", "default": "ANY" }, "renewalRightOnly": { "title": "Only contracts using the statutory renewal right", "type": "boolean", "description": "Keeps only rows where the tenant exercised 계약갱신요구권. Blank filings are excluded, since a blank means 'not reported' rather than 'not used'.", "default": false }, "minDepositKrw": { "title": "Minimum deposit (KRW)", "type": "integer", "description": "In actual won, not 만원. Five hundred million won is `500000000`." }, "maxDepositKrw": { "title": "Maximum deposit (KRW)", "type": "integer", "description": "In actual won, not 만원." }, "minAreaSqm": { "title": "Minimum area (m²)", "type": "integer", "description": "Exclusive-use area, except for detached houses where the register reports contract area. 84 m² is the standard Korean family unit, roughly 25 pyeong." }, "maxAreaSqm": { "title": "Maximum area (m²)", "type": "integer", "description": "Upper bound on area in square metres." }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on billed rows. Rental filings are far denser than sales — Gangnam-gu alone filed 1,921 apartment rentals in June 2026, against 223 sales. Raise this deliberately: the cap is what stops a wide query from billing more than you meant.", "default": 500 }, "serviceKey": { "title": "Your data.go.kr service key (optional)", "type": "string", "description": "Leave empty to use the shared key. For scheduled or high-volume runs get your own — free and approved instantly at [data.go.kr](https://www.data.go.kr/data/15126474/openapi.do). Use the **Decoding** key, not the Encoding one. Limit is 10,000 requests per day." } } }, "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 } } } } } } } } } }