{
  "openapi": "3.0.1",
  "info": {
    "title": "Japan Real Estate Brokers Register (MLIT 宅建業者)",
    "description": "Licensed real-estate brokers (宅地建物取引業者) from MLIT's official register: license number, authority, renewals, validity dates, head-office city, guarantee and trade associations, office and staff counts. Corporations only; no personal names or phone numbers. Unofficial; not affiliated with MLIT.",
    "version": "0.1",
    "x-build-id": "F64mpeANqYqubq0wg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/jpopendata~japan-real-estate-brokers/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-jpopendata-japan-real-estate-brokers",
        "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-real-estate-brokers/runs": {
      "post": {
        "operationId": "runs-sync-jpopendata-japan-real-estate-brokers",
        "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-real-estate-brokers/run-sync": {
      "post": {
        "operationId": "run-sync-jpopendata-japan-real-estate-brokers",
        "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": {
          "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": "Default Tokyo. The prefecture to list licensed real-estate brokers (宅地建物取引業者) for, by English name (\"Tokyo\", \"Osaka\", \"Fukuoka\"). Via API pass the English name exactly as listed — the platform checks the list before the run starts. Cities are not prefectures: use \"Kanagawa\" for Yokohama, \"Aichi\" for Nagoya. Choose \"(all of Japan)\" (an empty value) only together with a companyName or licenseType \"minister\" — unfiltered national lists are not supported by design; without either the run falls back to Tokyo.",
            "default": "Tokyo"
          },
          "companyName": {
            "title": "Company name contains (optional)",
            "type": "string",
            "description": "Optional. A fragment of the trade name, WITHOUT 株式会社 / 有限会社 (the register asks for the name without the corporate designator; a leading or trailing one is removed automatically). At least 2 characters. Kanji/kana as written (\"三谷\", \"不動産\", \"ハウス\") searches the written name; katakana only (\"ミタニ\") searches the registered reading. Latin letters and digits are converted to the fullwidth form the register uses (\"KOEI\" finds 「ＫＯＥＩ」). Leave empty to list the whole prefecture."
          },
          "licenseType": {
            "title": "License type",
            "enum": [
              "any",
              "minister",
              "governor"
            ],
            "type": "string",
            "description": "Default any. \"minister\" = licensed by the Minister of Land, Infrastructure, Transport and Tourism (国土交通大臣免許 — brokers with offices in two or more prefectures); \"governor\" = licensed by a prefectural governor (都道府県知事免許 — offices in one prefecture only); \"any\" = both.",
            "default": "any"
          },
          "officeScope": {
            "title": "Which office must be in the prefecture",
            "enum": [
              "headOffice",
              "anyOffice"
            ],
            "type": "string",
            "description": "Default headOffice. \"headOffice\" = brokers whose head office (主たる事務所) is in the prefecture — one row per company. \"anyOffice\" = brokers with ANY office there, including branches of nationwide companies (each company appears once; matchedOfficeName tells which office matched).",
            "default": "headOffice"
          },
          "includeDetails": {
            "title": "Read each company page",
            "type": "boolean",
            "description": "Default true. Reads the register's company summary (業者概要) for each broker: the authoritative corporate/individual flag (individual brokers are excluded with it), license validity period, first license date, guarantee association, trade associations, side businesses, staff counts and capital. false = cheap list mode (50 brokers per request, no details): only names carrying an explicit corporate designator (株式会社 etc.) are emitted, all others are excluded as unverifiable.",
            "default": true
          },
          "includeOfficeCount": {
            "title": "Count offices",
            "type": "boolean",
            "description": "Default true. Also reads each broker's office list (one more request per broker) and returns officeCount — the number of licensed offices (head office + branches). Only the count is kept: office names, addresses and phone numbers are not stored. Needs includeDetails.",
            "default": true
          },
          "maxItems": {
            "title": "Max brokers",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Default 20. Stop after this many broker records (1-1000 per run). With company pages and office counts each broker takes about 3 seconds (two polite requests); 1000 brokers take roughly 50 minutes. Larger lists: split the search by companyName fragment or licenseType over several runs.",
            "default": 20
          },
          "maxApiRequests": {
            "title": "Max upstream requests (0 = automatic)",
            "minimum": 0,
            "maximum": 2500,
            "type": "integer",
            "description": "Default 0 = sized automatically from maxItems (result pages + one company page + one office list per broker, with headroom for excluded individual brokers). Hard budget of requests to etsuran2.mlit.go.jp for this run (at most 2500; strictly one at a time, at least 1.5 s apart). If it runs out, the run still SUCCEEDS with the records collected so far and complete=false in RUN_SUMMARY.",
            "default": 0
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Default: no proxy — the register answers direct requests. Optional Apify Proxy settings; one sticky session (one exit IP) is used for the whole run, never rotated.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}