{ "openapi": "3.0.1", "info": { "title": "Japan Medical Facilities (MHLW Open Data)", "description": "All Japanese hospitals, clinics, dental clinics, maternity homes and pharmacies from the official MHLW 医療情報ネット nationwide open data (e-Gov data portal). English field schema, medical departments included, prefecture filter, source attribution embedded in every record.", "version": "0.1", "x-build-id": "yBvCJFpiNBIz6Ba4z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpopendata~japan-medical-facilities/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpopendata-japan-medical-facilities", "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-medical-facilities/runs": { "post": { "operationId": "runs-sync-jpopendata-japan-medical-facilities", "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-medical-facilities/run-sync": { "post": { "operationId": "run-sync-jpopendata-japan-medical-facilities", "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": { "facilityTypes": { "title": "Facility types", "type": "array", "description": "Optional, default [\"hospital\"]. Which facility registers to output (multi-select). The archive covers all of Japan: ~7,600 hospitals, ~105,000 medical clinics, ~68,000 dental clinics, ~2,000 maternity homes, ~62,000 pharmacies. Via API a single string or comma-separated string (\"hospital, clinic\") and Japanese names (病院, 薬局) are accepted too.", "items": { "type": "string", "enum": [ "hospital", "clinic", "dental_clinic", "maternity_home", "pharmacy" ], "enumTitles": [ "Hospitals (病院)", "Medical clinics (診療所)", "Dental clinics (歯科診療所)", "Maternity homes (助産所)", "Pharmacies (薬局)" ] }, "default": [ "hospital" ] }, "prefecture": { "title": "Prefecture", "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": "Optional. Choose one of the 47 prefectures by its English name (e.g. \"Tokyo\", \"Osaka\", \"Kyoto\"). Via API/CLI pass the English name exactly as listed (e.g. \"Tokyo\", not \"東京都\" / \"13\" / \"tokyo-to\" — the platform validates the list before the run starts and rejects anything else with the list of valid values). Cities are NOT prefectures: use \"Kanagawa\" for Yokohama, \"Aichi\" for Nagoya, \"Osaka\" for Osaka-shi. Leave empty (the default) for all of Japan — the whole archive is downloaded either way; this only filters the output.", "default": "" }, "includeDepartments": { "title": "Include medical departments", "type": "boolean", "description": "Optional, default true. If enabled, each hospital/clinic/dental record carries its deduplicated 診療科目 list (department code + Japanese name) joined from the paired speciality table in the SAME archive — no extra network requests.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Optional, default 100. Maximum number of records to output across all selected facility types, in the order given (1..200000 — a full nationwide clinic pull is ~105k).", "default": 100 }, "datasetZipUrl": { "title": "Dataset ZIP URL override", "type": "string", "description": "Advanced, normally EMPTY. The actor reads the e-Gov dataset page and picks the latest snapshot ZIP automatically. Pass an https URL here only to pin a specific snapshot (e.g. an older resource from https://data.e-gov.go.jp/data/dataset/iryou_teikyouseido_mhlw) — this also skips the dataset-page request." }, "maxApiRequests": { "title": "Max upstream requests per run", "minimum": 1, "maximum": 10, "type": "integer", "description": "Optional, default 5. Hard safety cap on upstream HTTP requests (politeness). A normal run needs at most 2: the dataset page + the ZIP download; the headroom only covers polite retries.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Apify proxy settings. Default: NO proxy (direct connection works). 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 }, "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 } } } } } } } } } }