{ "openapi": "3.0.1", "info": { "title": "SocialBlade Scraper - Creator Stats and History", "description": "Returns SocialBlade statistics for YouTube, TikTok, Instagram and Twitch creators: audience size, platform statistics, SocialBlade grade and ranks, profile data and up to 15 days of daily history. Paste profile links and export one row per creator for vetting, benchmarking and tracking growth.", "version": "1.0", "x-build-id": "iLLCM61aXBJojbgoN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/benthepythondev~socialblade-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-benthepythondev-socialblade-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/benthepythondev~socialblade-scraper/runs": { "post": { "operationId": "runs-sync-benthepythondev-socialblade-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/benthepythondev~socialblade-scraper/run-sync": { "post": { "operationId": "run-sync-benthepythondev-socialblade-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", "properties": { "mode": { "title": "Mode", "enum": [ "profiles", "ranking" ], "type": "string", "description": "profiles: read the creators you list below. ranking: return SocialBlade's top list for the chosen platform (YouTube lists can be narrowed by category and country), one row per creator with its rank.", "default": "profiles" }, "profileUrls": { "title": "Profile URLs", "type": "array", "description": "Creator profile URLs from SocialBlade, YouTube, TikTok, Instagram or Twitch, for example https://www.youtube.com/@mkbhd or https://socialblade.com/tiktok/user/khaby.lame. For bare @handles use the Handles field.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "handles": { "title": "Handles", "type": "array", "description": "Bare creator handles such as @mkbhd or khaby.lame, read on the platform chosen below. A YouTube channel ID (UC...) also works. Full links are accepted here too. Leave empty if you use Profile URLs.", "items": { "type": "string" } }, "platform": { "title": "Platform for handles", "enum": [ "youtube", "tiktok", "instagram", "twitch" ], "type": "string", "description": "Platform the bare handles belong to. Links carry their own platform and ignore this.", "default": "youtube" }, "maxProfiles": { "title": "Maximum profiles", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of profiles processed in one run. In ranking mode: how many creators from the top of the list to return (default 10 here, up to 100).", "default": 10 }, "sortBy": { "title": "Ranking: sort by", "type": "string", "description": "Ranking mode only. YouTube: subscribers, views or videos. TikTok: followers or likes. Instagram and Twitch: followers. Empty means the first one for the platform." }, "category": { "title": "Ranking: category (YouTube only)", "type": "string", "description": "Ranking mode, YouTube only. One of comedy, education, entertainment, film, games, howto, music, news, nonprofit, people, sports, tech. Empty means all categories." }, "country": { "title": "Ranking: country (YouTube only)", "type": "string", "description": "Ranking mode, YouTube only. Two-letter country code such as US, DE or BR. Empty means worldwide." }, "includeHistory": { "title": "Include history", "enum": [ "yes", "no" ], "type": "string", "description": "Profiles mode. Leave empty or yes to get the daily history, the 7, 30 and 90 day gains and the spike dates. Set no for the profile numbers alone.", "default": "yes" }, "trackHistory": { "title": "Keep history across runs", "type": "boolean", "description": "Saves each profile's daily history in the key-value store 'socialblade-history' of your account and adds it to the 15 days SocialBlade shows, so a weekly schedule builds a history of months and years. The 30- and 90-day gains fill in once the kept history reaches that far.", "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 } } } } } } } } } }