{ "openapi": "3.0.1", "info": { "title": "Binance NFT Collection Scraper", "description": "🌐 Unlock the world of Binance NFT marketplace with our all-in-one scraper 💹 Extract rankings, explore individual collections, and access asset metadata easily. Get key metrics in your preferred cryptocurrency and fine-tune your results with extensive filtering, sorting and exporting options!!", "version": "1.0", "x-build-id": "dBOLr7JNyMlOKwXDg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gabrielm~binance-nft-collection-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gabrielm-binance-nft-collection-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/gabrielm~binance-nft-collection-scraper/runs": { "post": { "operationId": "runs-sync-gabrielm-binance-nft-collection-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/gabrielm~binance-nft-collection-scraper/run-sync": { "post": { "operationId": "run-sync-gabrielm-binance-nft-collection-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": [ "scraping_mode" ], "properties": { "scraping_mode": { "title": "Scraping mode", "enum": [ "scraping_mode_specific", "scraping_mode_rankings", "scraping_mode_assets" ], "type": "string", "description": "Select what type of information you want to collect", "default": "scraping_mode_rankings" }, "currency": { "title": "Currency", "enum": [ "currency_usd", "currency_network", "currency_bnb", "currency_eth", "currency_matic", "currency_btc" ], "type": "string", "description": "This is the coin/currency you want your results be converted to", "default": "currency_usd" }, "specific_id_list": { "title": "Collection id(s)", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Enter one or many (up to 100) collection ids", "items": { "type": "string" } }, "specific_period": { "title": "Period", "enum": [ "specific_period_1h", "specific_period_6h", "specific_period_24h", "specific_period_7d", "specific_period_30d", "specific_period_all" ], "type": "string", "description": "Select which period you want to collect data from", "default": "specific_period_24h" }, "specific_include_properties": { "title": "Include properties", "type": "boolean", "description": "Include collection properties/attributes/traits in the results?", "default": false }, "ranking_type": { "title": "Ranking type", "enum": [ "ranking_type_all", "ranking_type_trending" ], "type": "string", "description": "Select what type of ranking list you want to collect", "default": "ranking_type_all" }, "ranking_network": { "title": "Network", "enum": [ "ranking_network_all", "ranking_network_bsc", "ranking_network_eth", "ranking_network_polygon", "ranking_network_btc" ], "type": "string", "description": "Narrow the results to a specific network", "default": "ranking_network_all" }, "ranking_max_rows": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "How many collections to gather\n(Trending lists are not longer than 100 rows)", "default": 100 }, "ranking_include_properties": { "title": "Include properties", "type": "boolean", "description": "Include collection properties/attributes/traits in the results?", "default": false }, "ranking_include_additional_details": { "title": "Include additional details", "type": "boolean", "description": "Include contract address? Total listed assets? Royalty fees?", "default": false }, "ranking_type_all_period": { "title": "Period", "enum": [ "ranking_type_all_period_1h", "ranking_type_all_period_6h", "ranking_type_all_period_24h", "ranking_type_all_period_7d", "ranking_type_all_period_30d", "ranking_type_all_period_all" ], "type": "string", "description": "Select which period you want to collect data from", "default": "ranking_type_all_period_24h" }, "ranking_type_all_sort_metric": { "title": "Sort metric", "enum": [ "ranking_type_all_sort_metric_volume", "ranking_type_all_sort_metric_volume_rate", "ranking_type_all_sort_metric_floor_price", "ranking_type_all_sort_metric_floor_price_rate" ], "type": "string", "description": "Order results by this column", "default": "ranking_type_all_sort_metric_volume" }, "ranking_type_all_sort_direction": { "title": "Sort direction", "enum": [ "ranking_type_all_sort_direction_ascending", "ranking_type_all_sort_direction_descending" ], "type": "string", "description": "", "default": "ranking_type_all_sort_direction_descending" }, "ranking_type_trending_period": { "title": "Period", "enum": [ "ranking_type_trending_period_1h", "ranking_type_trending_period_6h", "ranking_type_trending_period_24h", "ranking_type_trending_period_7d" ], "type": "string", "description": "Select which period you want to collect data from", "default": "ranking_type_trending_period_24h" }, "assets_collection_id": { "title": "Collection id", "type": "string", "description": "The id of the collection to gather the assets from\nEntering none = any collection" }, "assets_type_nft": { "title": "NFT", "type": "boolean", "description": "", "default": false }, "assets_type_mystery_box": { "title": "Mystery Box", "type": "boolean", "description": "", "default": false }, "assets_verification_verified": { "title": "Verified", "type": "boolean", "description": "", "default": false }, "assets_verification_unverified": { "title": "Unverified", "type": "boolean", "description": "", "default": false }, "assets_status_buy_now": { "title": "Buy now", "type": "boolean", "description": "", "default": false }, "assets_status_live_auction": { "title": "Live auction", "type": "boolean", "description": "", "default": false }, "assets_status_has_offers": { "title": "Has offers", "type": "boolean", "description": "", "default": false }, "assets_status_coming_soon": { "title": "Coming soon", "type": "boolean", "description": "", "default": false }, "assets_rarity_unopened": { "title": "Unopened", "type": "boolean", "description": "", "default": false }, "assets_rarity_ssr": { "title": "Super Super Rare", "type": "boolean", "description": "", "default": false }, "assets_rarity_sr": { "title": "Super Rare", "type": "boolean", "description": "", "default": false }, "assets_rarity_r": { "title": "Rare", "type": "boolean", "description": "", "default": false }, "assets_rarity_n": { "title": "Normal", "type": "boolean", "description": "", "default": false }, "assets_network_bsc": { "title": "Binance Smart Chain", "type": "boolean", "description": "", "default": false }, "assets_network_eth": { "title": "Ethereum", "type": "boolean", "description": "", "default": false }, "assets_network_polygon": { "title": "Polygon", "type": "boolean", "description": "", "default": false }, "assets_network_btc": { "title": "Bitcoin", "type": "boolean", "description": "", "default": false }, "assets_sort_metric": { "title": "Sort metric", "enum": [ "assets_sort_metric_date_of_listing", "assets_sort_metric_date_of_sale_end", "assets_sort_metric_date_of_creation", "assets_sort_metric_price", "assets_sort_metric_favorites", "assets_sort_metric_score", "assets_sort_metric_open_rarity" ], "type": "string", "description": "Order results by this column", "default": "assets_sort_metric_price" }, "assets_sort_direction": { "title": "Sort direction", "enum": [ "assets_sort_direction_ascending", "assets_sort_direction_descending" ], "type": "string", "description": "", "default": "assets_sort_direction_ascending" }, "assets_max_rows": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "How many assets to gather", "default": 30 }, "assets_include_additional_details": { "title": "Include additional details", "type": "boolean", "description": "Include Categories? Properties? Creator/Owner? Fees? Bids? Offers?", "default": false }, "adv_max_threads": { "title": "🕷️ Maximum number of threads", "minimum": 1, "maximum": 30, "type": "integer", "description": "Limits the number of simultaneous scrapers\n(1-30, 1 = minimal CPU/RAM usage)", "default": 10 }, "adv_request_timeout": { "title": "⏱️ Request timeout", "minimum": 1, "type": "integer", "description": "Individual request timeout, in seconds", "default": 30 }, "adv_request_retries": { "title": "🔄 Request retries", "minimum": 0, "maximum": 9, "type": "integer", "description": "How many times to retry a request if it fails\n(0-9, zero = never)", "default": 3 }, "adv_request_cooldown": { "title": "🔥 Request cooldown", "minimum": 0, "maximum": 10, "type": "integer", "description": "Interval before retrying a failed request,\nin seconds (0-10, zero = immediate)", "default": 1 }, "adv_proxy_usage": { "title": "🕵🏻 Proxy usage", "type": "object", "description": "Proxies used to anonymize your requests\n(⚠️ using none is discouraged ⚠️)" }, "adv_dataset_optimization": { "title": "🗜️ Dataset optimization", "type": "boolean", "description": "Simplifies elements for a better layout\n(⚠️ best for spreadsheet-like view ⚠️)", "default": true }, "adv_dataset_cleanse": { "title": "🧹 Dataset cleanse", "type": "boolean", "description": "Removes probably useless results\n(⚠️ see Information for details ⚠️)", "default": false }, "adv_show_warnings": { "title": "💬 Show warnings", "type": "boolean", "description": "Includes non-critical messages in the log\n(⚠️ for advanced users ⚠️)", "default": false }, "adv_allow_incompletion": { "title": "🧩 Allow incompletion", "type": "boolean", "description": "Keeps running on skippable errors\n(⚠️ for advanced users ⚠️)", "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 } } }, "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 } } } } } } } } } }