{ "openapi": "3.0.1", "info": { "title": "Japan Company Data API - gBizINFO Corporate Lookup", "description": "Look up Japanese companies by corporate number (法人番号) or name in METI's official gBizINFO (Gビズインフォ) database: English name, address, capital, employees, industry, subsidies, patents and more. Free demo for up to 3 companies; add your own free gBizINFO API token for bulk lookups and name search.", "version": "0.1", "x-build-id": "17uNBozDQvyHqo7Di" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/1rrock~japan-gbizinfo-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-1rrock-japan-gbizinfo-lookup", "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/1rrock~japan-gbizinfo-lookup/runs": { "post": { "operationId": "runs-sync-1rrock-japan-gbizinfo-lookup", "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/1rrock~japan-gbizinfo-lookup/run-sync": { "post": { "operationId": "run-sync-1rrock-japan-gbizinfo-lookup", "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": { "corporateNumbers": { "title": "Corporate numbers (法人番号)", "type": "array", "description": "Enter 13-digit Japanese corporate numbers (法人番号), one per line. Hyphens and spaces are ignored. Each number produces one result. If both this and Company name search are empty, NEC and Toyota are looked up as a demo.", "items": { "type": "string" } }, "name": { "title": "Company name search", "type": "string", "description": "Partial-match company name search, e.g. トヨタ自動車 or ソニー. Can be combined with the prefecture / city / corporate type filters below. Name search needs your own apiToken." }, "prefecture": { "title": "Prefecture code (search filter)", "type": "string", "description": "JIS X 0401 2-digit prefecture code, e.g. 13 = 東京都, 23 = 愛知県, 27 = 大阪府." }, "city": { "title": "City code (search filter)", "type": "string", "description": "JIS X 0402 3-digit city code (requires prefecture)." }, "corporateType": { "title": "Corporate type (search filter)", "type": "string", "description": "gBizINFO corporate_type code, e.g. 301 = 株式会社, 302 = 有限会社, 305 = 合同会社." }, "mode": { "title": "Lookup mode", "enum": [ "auto", "number", "name" ], "type": "string", "description": "auto = look up the given corporate numbers and also run the name search if a name is given.", "default": "auto" }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of company records per run (up to 5000). Without your own apiToken the free demo looks up at most 3 corporate numbers.", "default": 100 }, "limit": { "title": "Search page size", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Number of records requested from the name search (also limited by Max results).", "default": 10 }, "page": { "title": "Search page", "minimum": 1, "maximum": 10, "type": "integer", "description": "Search result page number (API allows 1–10).", "default": 1 }, "enrichment": { "title": "Enrichment categories", "type": "array", "description": "Optional extra data per company (one extra API call each, still one result per company): procurement, subsidy, certification, commendation, corporation, finance, patent, workplace.", "default": [], "items": { "type": "string" } }, "metadata": { "title": "Include metadata", "type": "boolean", "description": "Pass metadata_flg=true (source and last-update info per field).", "default": false }, "apiToken": { "title": "gBizINFO API token", "type": "string", "description": "Your own free gBizINFO API token (https://info.gbiz.go.jp/hojin/various_registration/form). Without it the Actor runs as a free demo: at most 3 corporate numbers per run and no name search. Skipped inputs are not charged." }, "delaySeconds": { "title": "Delay between requests (seconds)", "minimum": 0.25, "maximum": 30, "type": "number", "description": "Polite throttle between API calls (minimum 0.25 s).", "default": 0.5 } } }, "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 } } } } } } } } } }