{ "openapi": "3.0.1", "info": { "title": "Japan Postal Code (KEN_ALL) Lookup API", "description": "Unofficial Japan Post postal code (KEN_ALL) lookup API. by_zipcode: a 7-digit code -> address (prefecture/city/town, kanji + kana + English prefecture). by_address: a prefecture/city -> its postal codes. Downloads the official KEN_ALL once and searches it in memory. Free of copyright per Japan Post.", "version": "0.1", "x-build-id": "irp1DecNb40Y8quEI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~japan-postal-codes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-japan-postal-codes", "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/jpopendata~japan-postal-codes/runs": { "post": { "operationId": "runs-sync-jpopendata-japan-postal-codes", "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/jpopendata~japan-postal-codes/run-sync": { "post": { "operationId": "run-sync-jpopendata-japan-postal-codes", "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": [ "by_zipcode", "by_address" ], "type": "string", "description": "`by_zipcode` (default) looks up one 7-digit postal code and returns its address(es) — set `zipcode`. `by_address` returns every postal code in a prefecture and/or city — set `prefecture` and/or `city`. Example: \"by_zipcode\".", "default": "by_zipcode" }, "zipcode": { "title": "Postal code (by_zipcode)", "type": "string", "description": "by_zipcode mode (REQUIRED there): the 7-digit Japanese postal code, e.g. \"1000001\" or \"100-0001\" (hyphen, spaces, 〒 and full-width digits are tolerated). Ignored in by_address mode.", "default": "1000001" }, "prefecture": { "title": "Prefecture (by_address)", "enum": [ "Hokkaido", "Aomori", "Iwate", "Miyagi", "Akita", "Yamagata", "Fukushima", "Ibaraki", "Tochigi", "Gunma", "Saitama", "Chiba", "Tokyo", "Kanagawa", "Niigata", "Toyama", "Ishikawa", "Fukui", "Yamanashi", "Nagano", "Gifu", "Shizuoka", "Aichi", "Mie", "Shiga", "Kyoto", "Osaka", "Hyogo", "Nara", "Wakayama", "Tottori", "Shimane", "Okayama", "Hiroshima", "Yamaguchi", "Tokushima", "Kagawa", "Ehime", "Kochi", "Fukuoka", "Saga", "Nagasaki", "Kumamoto", "Oita", "Miyazaki", "Kagoshima", "Okinawa" ], "type": "string", "description": "by_address mode: prefecture to list — pick one of the 47 prefectures by English name, e.g. \"Tokyo\" (via the API the Japanese name \"東京都\" or JIS code \"13\" also work). At least one of prefecture / city is required in by_address mode. Ignored in by_zipcode mode." }, "city": { "title": "City / ward (by_address)", "type": "string", "description": "by_address mode: city / ward / county name in kanji, matched as a substring of the KEN_ALL city field, e.g. \"千代田区\", \"横浜市\", \"札幌市中央区\". Combine with prefecture to disambiguate. Ignored in by_zipcode mode." }, "edition": { "title": "KEN_ALL edition", "enum": [ "utf8", "shiftjis" ], "type": "string", "description": "Which official KEN_ALL file to download. `utf8` (default) = the one-record-per-line UTF-8 file (clean, recommended). `shiftjis` = the classic small-kana Shift_JIS KEN_ALL (decoded to UTF-8, with split-town rows merged). Aliases like \"UTF-8\" / \"Shift_JIS\" are accepted.", "default": "utf8" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of records to output (1-100000). by_zipcode returns 1 (occasionally a few) records; by_address may return thousands for a whole prefecture. Example: 1000.", "default": 1000 }, "maxApiRequests": { "title": "Max upstream requests per run", "minimum": 1, "maximum": 8, "type": "integer", "description": "Hard safety cap on upstream requests per run (1-8; only one KEN_ALL download is needed, the rest is retry headroom). Example: 5.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Default is NO proxy (direct connection) — the public KEN_ALL download rarely needs one. The Actor backs off exponentially on 429/5xx and fails visibly on a persistent block; it never attempts rate-limit evasion.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }