{ "openapi": "3.0.1", "info": { "title": "Stock, Options & Crypto Screener - Dividend & DeFi Yield Data", "description": "Stock options screener (RSI, ATR%, relative volume, VWAP distance, ATM IV), crypto screener with a Fear & Greed overlay, municipal income funds with tax-equivalent yields and dividend streaks, and crypto staking and stablecoin yields with APY and TVL. Ranked rows as JSON/CSV. Not investment advice", "version": "0.1", "x-build-id": "ZpLmEEdaTXwz0gIAi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rolescout~tradescout-stock-crypto-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rolescout-tradescout-stock-crypto-screener", "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/rolescout~tradescout-stock-crypto-screener/runs": { "post": { "operationId": "runs-sync-rolescout-tradescout-stock-crypto-screener", "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/rolescout~tradescout-stock-crypto-screener/run-sync": { "post": { "operationId": "run-sync-rolescout-tradescout-stock-crypto-screener", "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": [ "attestNotSanctioned" ], "properties": { "boards": { "title": "Boards", "type": "array", "description": "Which ranked screening boards to fetch: the stock options screener, the municipal income fund (dividend) board, the crypto screener and the crypto yields board. Leave all four selected for the full set; each board is one billable event.", "items": { "type": "string", "enum": [ "picks", "dividends", "crypto", "yields" ], "enumTitles": [ "Options - short-dated US equity options candidates (RSI, ATR%, relative volume, VWAP distance, ATM IV)", "Dividends - municipal income funds: yield, tax-equivalent yield, dividend CAGR, streak years", "Crypto - technical screener with a Fear & Greed overlay", "Yields - crypto staking and stablecoin yields with APY and TVL" ] }, "default": [ "picks", "dividends", "crypto", "yields" ] }, "maxRowsPerBoard": { "title": "Maximum rows per board", "minimum": 0, "type": "integer", "description": "Boards are ranked, so this keeps the top N of each. 0 means every row the board serves (the crypto screener can run to several hundred pairs). It changes the dataset size, not the price.", "default": 50 }, "minGrade": { "title": "Minimum grade", "enum": [ "A", "B", "C", "any" ], "type": "string", "description": "Keep only rows graded at least this well. Rows without a letter grade are kept whatever you choose.", "default": "any" }, "attestNotSanctioned": { "title": "I attest I am not a sanctioned party", "type": "boolean", "description": "Required. The run refuses to fetch anything until this is ticked. Your attestation is forwarded to the data provider with the request, as the provider requires it from the party receiving the data.", "default": false }, "includeHeadlines": { "title": "Include headlines", "type": "boolean", "description": "Add the news headlines each options and crypto row was scored against (the news_sentiment inputs). Off by default to keep rows small.", "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 }, "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 } } } } } } } } } }