{ "openapi": "3.0.1", "info": { "title": "Risk & Volatility (Sharpe, Sortino, Drawdowns, Recovery & VaR)", "description": "Institutional quantitative risk analytics for Stocks, ETFs, Crypto, Forex, and Indices: Annualized Sharpe & Sortino ratios, Maximum Drawdown depth and recovery timelines, 1-year rolling Sharpe series, return skewness/kurtosis, and Value at Risk (VaR / CVaR).", "version": "0.0", "x-build-id": "0kVlWzxZUw9U3GNeO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khnaami~risk-volatility-sharpe-sortino-drawdowns-recovery-var/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khnaami-risk-volatility-sharpe-sortino-drawdowns-recovery-var", "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/khnaami~risk-volatility-sharpe-sortino-drawdowns-recovery-var/runs": { "post": { "operationId": "runs-sync-khnaami-risk-volatility-sharpe-sortino-drawdowns-recovery-var", "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/khnaami~risk-volatility-sharpe-sortino-drawdowns-recovery-var/run-sync": { "post": { "operationId": "run-sync-khnaami-risk-volatility-sharpe-sortino-drawdowns-recovery-var", "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": [ "symbols" ], "properties": { "symbols": { "title": "Symbols / Tickers", "type": "array", "description": "List of tickers or symbols to analyze (e.g. SPY, QQQ, AAPL, NVDA, TSLA, BTC-USD, EURUSD=X, GC=F).", "default": [ "SPY", "QQQ", "AAPL", "NVDA" ], "items": { "type": "string" } }, "yearsBack": { "title": "Years of Historical Data", "minimum": 1, "maximum": 50, "type": "integer", "description": "Historical time horizon in years for drawdown analysis and risk calculation (e.g., 5, 10, 20).", "default": 5 }, "startDate": { "title": "Custom Start Date (Optional)", "type": "string", "description": "Optional explicit start date (YYYY-MM-DD). If provided, overrides yearsBack." }, "endDate": { "title": "Custom End Date (Optional)", "type": "string", "description": "Optional explicit end date (YYYY-MM-DD). Defaults to current date." }, "riskFreeRate": { "title": "Annual Risk-Free Rate (%)", "minimum": 0, "maximum": 20, "type": "number", "description": "Benchmark risk-free rate percentage used for Sharpe and Sortino calculations (e.g. 4.0 for 4%).", "default": 4 }, "rollingWindow": { "title": "Rolling Window for Sharpe (Trading Days)", "minimum": 20, "maximum": 504, "type": "integer", "description": "Window size for rolling Sharpe ratio calculation (default 252 trading days / 1 year).", "default": 252 }, "includeTimeSeries": { "title": "Include Full Time-Series (Drawdowns & Rolling Sharpe)", "type": "boolean", "description": "Include day-by-day drawdown series and rolling Sharpe time series arrays in the output.", "default": true }, "includeReturnDistribution": { "title": "Include Return Distribution (Histogram & Gaussian Fit)", "type": "boolean", "description": "Include 50-bin return frequency distribution, Gaussian PDF curve, and Value at Risk (VaR / CVaR).", "default": true } } }, "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 } } } } } } } } } }