{ "openapi": "3.0.1", "info": { "title": "Japan JPX Short Selling — 空売り残高 API", "description": "Track Japan JPX short-selling balances by stock. Clean JSON for analysts, quants and AI agents.", "version": "0.0", "x-build-id": "5RLpZPnGRQMHmJ3V6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~japan-jpx-short-selling-balances/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-japan-jpx-short-selling-balances", "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/nexgendata~japan-jpx-short-selling-balances/runs": { "post": { "operationId": "runs-sync-nexgendata-japan-jpx-short-selling-balances", "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/nexgendata~japan-jpx-short-selling-balances/run-sync": { "post": { "operationId": "run-sync-nexgendata-japan-jpx-short-selling-balances", "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": { "ticker_filter": { "title": "Ticker filter (4-digit JP securities code)", "type": "string", "description": "Optional. 4-digit Japanese securities code (e.g. '7203' for Toyota). Leave blank to return all tickers." }, "short_holder_filter": { "title": "Short holder filter", "type": "string", "description": "Optional. Filter to short positions held by a specific fund / firm (substring match, case-insensitive). E.g. 'Goldman', 'Citadel', 'Barclays'. Leave blank for all holders." }, "min_short_position_pct": { "title": "Minimum short position % of shares outstanding", "minimum": 0, "maximum": 100, "type": "integer", "description": "Minimum short position ratio (percent) to include. JPX only discloses positions >=0.5%, so this is the lower bound. Use 1.0 for >=1% disclosures, 5.0 for high-conviction shorts.", "default": 1 }, "date_from": { "title": "Date from (ISO YYYY-MM-DD, optional)", "type": "string", "description": "Start of date window (inclusive). Leave BLANK (recommended) to fetch the latest available daily file. JPX keeps the current month on its landing page plus one archive page per month for roughly the previous 12 months; dates older than that are not retrievable." }, "date_to": { "title": "Date to (ISO YYYY-MM-DD, optional)", "type": "string", "description": "End of date window (inclusive). Leave blank for 'up to the latest file'. If date_from is set and date_to is blank, every daily file from date_from to the latest is used (each business day is ~700-900 rows — raise max_records for backfills)." }, "max_records": { "title": "Maximum records to return", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on records pushed to the dataset. JPX publishes ~700-900 positions per business day; widen this for multi-day backfills.", "default": 200 } } }, "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 } } } } } } } } } }