{ "openapi": "3.0.1", "info": { "title": "AKShare Financial Data", "description": "Collect bounded stock, futures, options, fund, FX, convertible-bond, index, and crypto datasets through eight approved AKShare interfaces with flattened rows and separate run audits.", "version": "0.0", "x-build-id": "2rfNq5riobyMaXymC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/research_master~akshare-financial-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-research_master-akshare-financial-data", "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/research_master~akshare-financial-data/runs": { "post": { "operationId": "runs-sync-research_master-akshare-financial-data", "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/research_master~akshare-financial-data/run-sync": { "post": { "operationId": "run-sync-research_master-akshare-financial-data", "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": { "catalogOnly": { "title": "Return the interface catalog only", "type": "boolean", "description": "Save CATALOG and skip every data request. This overrides the requests field.", "default": false }, "requests": { "title": "AKShare data requests", "minItems": 0, "maxItems": 10, "type": "array", "description": "Up to 10 sequential calls. Find exact interface names and native signatures in the CATALOG output or AKShare documentation.", "items": { "type": "object", "additionalProperties": false, "properties": { "interfaceName": { "title": "AKShare interface name", "type": "string", "description": "Exact exported function name, for example stock_financial_report_sina or macro_china_gdp.", "pattern": "^[a-z][a-z0-9_]{1,127}$", "editor": "textfield" }, "arguments": { "title": "Positional arguments", "type": "array", "description": "Optional JSON values passed positionally in this order. Prefer named parameters when the interface supports them.", "editor": "json", "maxItems": 25, "default": [] }, "parameters": { "title": "Named parameters", "type": "object", "description": "JSON object passed as keyword arguments. Names and required values must match the native AKShare signature in CATALOG.", "editor": "json", "additionalProperties": true, "default": {} }, "nativeParameters": { "title": "Bypass a curated preset adapter", "type": "boolean", "description": "For one of the eight curated presets, call its native AKShare signature instead of the simpler Actor parameters. Other interfaces always use their native signature.", "default": false }, "maxRows": { "title": "Maximum rows for this request", "type": "integer", "description": "Rows are kept in source order and truncated after collection. RUN_AUDIT records fetched and emitted counts.", "default": 1000, "minimum": 1, "maximum": 5000, "editor": "number" } }, "required": [ "interfaceName" ] }, "default": [ { "interfaceName": "stock_zh_a_hist_tx", "parameters": { "symbol": "sz000001", "start_date": "20240102", "end_date": "20240105", "adjust": "" }, "maxRows": 100 } ] }, "maxTotalRows": { "title": "Maximum rows for the run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard global cap across all requests. Later requests stop when the cap is reached.", "default": 5000 }, "requestTimeoutSecs": { "title": "Timeout per request (seconds)", "minimum": 15, "maximum": 300, "type": "integer", "description": "Maximum wait for one upstream AKShare interface call.", "default": 90 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 2, "type": "integer", "description": "Retry transient interface errors. A timed-out background call is not retried.", "default": 1 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Polite delay between separate AKShare interface calls.", "default": 500 }, "failFast": { "title": "Stop after the first failed request", "type": "boolean", "description": "When disabled, later requests continue and every failure is recorded in RUN_AUDIT.", "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 } } } } } } } } } }