{ "openapi": "3.0.1", "info": { "title": "OKX Copytrading Scraper", "description": "Unleash the power of OKX Copy Trading Scraper! Gather and analyze top user positions on the largest copy trading platform. Optimize your coin trading with advanced filtering and sorting features. Gain valuable insights for informed decisions.", "version": "0.0", "x-build-id": "GdOZqusVloJoKsGYo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epctex~okx-copytrading-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epctex-okx-copytrading-scraper", "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/epctex~okx-copytrading-scraper/runs": { "post": { "operationId": "runs-sync-epctex-okx-copytrading-scraper", "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/epctex~okx-copytrading-scraper/run-sync": { "post": { "operationId": "run-sync-epctex-okx-copytrading-scraper", "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": [ "proxy" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to start with. Account URLs can be futures or personal trading URLs.", "items": { "type": "string" } }, "includeHistoricalPositions": { "title": "Include historical positions", "type": "boolean", "description": "If you want the history of the user's open positions to be scraped as well, you can set `true`. Default setting is `false`", "default": false }, "onlyUserInformation": { "title": "Only user information", "type": "boolean", "description": "If you want only user account information to be scraped with performance stats(both of futures and personal), you can set `true`. Default setting is `false`", "default": false }, "endPage": { "title": "List end page", "type": "integer", "description": "The page number that you want to end with. By default there is no end page. This is applies to all search request and startUrls individually." }, "maxItems": { "title": "Maximum number of listing entries", "type": "integer", "description": "Maximum number of listing entries that you want as output. Default is all" }, "searchType": { "title": "Search type", "enum": [ "overview", "yieldRatio", "pnl", "winRatio", "aum", "traderFollowerLimit", "followTotalPnl" ], "type": "string", "description": "Keyword by which type you want to filter and search users in the futures section of OKX Copy Trading", "default": "overview" }, "leaderHasVacancies": { "title": "Leader has vacancies", "type": "boolean", "description": "If you want to search users with vacancies, you can set `true`. Default setting is `false`", "default": false }, "allowApiTraders": { "title": "Allow API traders", "type": "boolean", "description": "If you want to search API traders, you can set `true`. Default setting is `false`", "default": false }, "timeAsLeader": { "title": "Time as leader", "enum": [ "7", "30", "90", "180" ], "type": "string", "description": "Search by filtering by how long a leader has been a leader" }, "winRate": { "title": "Win rate", "enum": [ "0.5", "0.6", "0.7", "0.8", "0.9" ], "type": "string", "description": "Search by filtering by a leader's win rate" }, "minLeaderAssets": { "title": "Minimum leader assets", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Search by filtering by a leader's minimum assets" }, "maxLeaderAssets": { "title": "Maximum leader assets", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Search by filtering by a leader's maximum assets" }, "minLeaderAum": { "title": "Minimum leader AUM", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Search by filtering by a leader's minimum AUM" }, "maxLeaderAum": { "title": "Maximum leader AUM", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Search by filtering by a leader's maximum AUM" }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." }, "extendOutputFunction": { "title": "Extend output function", "type": "string", "description": "Function that takes a JQuery handle ($) as argument and returns data that will be merged with the default output" }, "customMapFunction": { "title": "Custom map function", "type": "string", "description": "Function that takes each of the objects as argument and returns data that will be mapped by the function itself." } } }, "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 } } } } } } } } } }