{ "openapi": "3.0.1", "info": { "title": "Crypto Order Book Depth: Liquidity and Slippage by Exchange", "description": "Live spot order books from OKX, Gate, Bitget and KuCoin turned into the numbers a desk trades on: resting depth within 0.5, 1 and 2 per cent of mid, the slippage a given order size would pay, and which venue fills that size cheapest. Keyless, no browser.", "version": "0.1", "x-build-id": "NQofnyp6AruhPfty2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~crypto-order-book-depth/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-crypto-order-book-depth", "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/scrapemint~crypto-order-book-depth/runs": { "post": { "operationId": "runs-sync-scrapemint-crypto-order-book-depth", "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/scrapemint~crypto-order-book-depth/run-sync": { "post": { "operationId": "run-sync-scrapemint-crypto-order-book-depth", "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": { "mode": { "title": "Mode", "enum": [ "depth", "slippage", "compare" ], "type": "string", "description": "depth = resting liquidity within 0.5, 1 and 2 per cent of mid on each venue. slippage = what a market order of a given size would actually pay. compare = which venue fills that size cheapest.", "default": "depth" }, "symbols": { "title": "Coins", "type": "array", "description": "BTC, ETH, SOL, or a full pair such as BTC-USDT. Coins are matched against the quote asset below.", "default": [ "BTC", "ETH", "SOL" ], "items": { "type": "string" } }, "venues": { "title": "Exchanges", "type": "array", "description": "okx, gate, bitget, kucoin. Empty returns all four. Binance and Bybit block datacentre addresses and cannot be covered.", "default": [ "okx", "gate", "bitget", "kucoin" ], "items": { "type": "string" } }, "quoteAsset": { "title": "Quote asset", "type": "string", "description": "The asset the coin is priced in. USDT is listed on all four venues; other quotes exist on some venues only.", "default": "USDT" }, "orderSizesUsd": { "title": "Order sizes", "type": "array", "description": "Slippage and compare modes. Order sizes in quote currency, for example 10000, 100000, 1000000.", "default": [ 10000, 100000, 1000000 ], "items": { "type": "string" } }, "side": { "title": "Side", "enum": [ "both", "buy", "sell" ], "type": "string", "description": "Slippage and compare modes. Buy walks the ask side, sell walks the bid side.", "default": "both" }, "maxRows": { "title": "Max rows per run", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Cap on rows returned. Controls total cost.", "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 } } } } } } } } } }