{ "openapi": "3.0.1", "info": { "title": "EDINET Scraper — Japanese Securities Filings (Japan's EDGAR)", "description": "Daily feed of Japanese corporate disclosures from EDINET (FSA): annual reports, extraordinary reports, and 5% large-shareholding filings — with English company names, document types, and industries.", "version": "0.3", "x-build-id": "y6cSWl1yTlmER8Jye" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/magoemu~edinet-japan-filings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-magoemu-edinet-japan-filings", "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/magoemu~edinet-japan-filings/runs": { "post": { "operationId": "runs-sync-magoemu-edinet-japan-filings", "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/magoemu~edinet-japan-filings/run-sync": { "post": { "operationId": "run-sync-magoemu-edinet-japan-filings", "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": [ "edinetApiKey" ], "properties": { "edinetApiKey": { "title": "EDINET API key", "type": "string", "description": "Free key from https://disclosure2dl.edinet-fsa.go.jp/ (create account > API key). Takes ~5 minutes." }, "lastNDays": { "title": "Last N days", "minimum": 1, "maximum": 366, "type": "integer", "description": "Fetch filings from the last N days (use 3 for daily scheduled runs so Monday still catches Friday). Overrides dateFrom/dateTo." }, "dateFrom": { "title": "Date from (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Start date for filings to fetch, in YYYY-MM-DD format. Multi-year historical backfills are supported (progress is checkpointed — resurrect an interrupted run to continue). Ignored when lastNDays is set." }, "dateTo": { "title": "Date to (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "End date for filings to fetch, in YYYY-MM-DD format. Ignored when lastNDays is set." }, "docCategories": { "title": "Document categories", "type": "array", "description": "Document categories to include in the results.", "items": { "type": "string", "enum": [ "all", "annual", "semiannual", "extraordinary", "large_shareholding", "registration", "buyback" ], "enumTitles": [ "All documents", "Annual Securities Reports", "Semi-Annual Reports", "Extraordinary Reports", "Large Shareholding Reports (5% rule)", "Registration Statements", "Share Buyback Reports" ] }, "default": [ "all" ] }, "tickers": { "title": "Tickers (securities codes)", "type": "array", "description": "Filter by 4-digit securities codes (e.g. 7203 for Toyota).", "items": { "type": "string" } }, "edinetCodes": { "title": "EDINET codes", "type": "array", "description": "Filter by filer EDINET codes (e.g. E02144).", "items": { "type": "string" } }, "listedOnly": { "title": "Listed companies only", "type": "boolean", "description": "When enabled, return filings only for listed companies.", "default": false }, "excludeAmendments": { "title": "Exclude amendment filings", "type": "boolean", "description": "When enabled, omit amendment and correction filings from the results.", "default": false }, "parseLargeShareholding": { "title": "Parse large-shareholding reports into signals", "type": "boolean", "description": "For each Large Shareholding Report (5% rule), download the filing CSV and add holding ratio (current/previous/change), event type (initial crossing, increase, decrease, exit), purpose of holding (activist detection), and joint-holder info. Adds one extra EDINET API call per such filing.", "default": true }, "skipSuperseded": { "title": "Skip filings superseded by amendments", "type": "boolean", "description": "When a filing is amended (訂正報告書) later within the fetched range, skip the outdated original and keep only the latest version. Recommended for backfills: you are not charged for documents whose data was corrected. When off, originals are still pushed and marked with superseded_by.", "default": false }, "includeFunds": { "title": "Include investment funds", "type": "boolean", "description": "Investment trust filings are excluded by default (they dominate daily volume).", "default": 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 } } } } } } } } } }