{ "openapi": "3.0.1", "info": { "title": "Substack Leaderboard Scraper", "description": "Top Substack newsletters in each of the 33 categories as Substack ranks them, with author, paid subscriber band, displayed subscriber count and launch date. Read the overall or the paid list to any depth Substack shows, track rank moves daily and add each newsletter's latest posts on request.", "version": "0.1", "x-build-id": "u04BATGzHSIkoB9nr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deriverge~substack-newsletter-directory/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deriverge-substack-newsletter-directory", "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/deriverge~substack-newsletter-directory/runs": { "post": { "operationId": "runs-sync-deriverge-substack-newsletter-directory", "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/deriverge~substack-newsletter-directory/run-sync": { "post": { "operationId": "run-sync-deriverge-substack-newsletter-directory", "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": { "categories": { "title": "Categories", "type": "array", "description": "Substack category names, for example Technology, Business, Finance, Culture, U.S. Politics, Science, Health & Wellness, Crypto. Leave empty for all 33.", "items": { "type": "string" } }, "ranking": { "title": "Ranking list", "enum": [ "all", "paid" ], "type": "string", "description": "Substack keeps two leaderboards per category.", "default": "all" }, "maxPerCategory": { "title": "Newsletters per category", "minimum": 1, "type": "integer", "description": "From the top of the leaderboard down, 25 per page.", "default": 100 }, "includePosts": { "title": "Include latest posts", "type": "boolean", "description": "Also return the latest posts of every listed newsletter, with likes, comments and word count. Charged per post.", "default": false }, "maxPostsPerNewsletter": { "title": "Maximum posts per newsletter", "minimum": 1, "type": "integer", "description": "Newest first. Archives go back years, so this is what keeps a broad run affordable.", "default": 3 }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Drop posts older than this date (YYYY-MM-DD). Dropped posts are never charged." }, "audience": { "title": "Audience", "enum": [ "all", "free", "paid" ], "type": "string", "description": "Substack marks each post as free for everyone or for paying subscribers.", "default": "all" }, "keywords": { "title": "Keywords (any of)", "type": "array", "description": "Keep only posts whose title, subtitle, description or preview contain at least one of these words, case-insensitive. Dropped posts are never charged.", "items": { "type": "string" } }, "newOnly": { "title": "Return only rows new since the last run", "type": "boolean", "description": "Keeps a snapshot per watch name (or per saved task) and returns only newsletters that entered the leaderboard since the last run; the CHANGES record lists rank moves and drop-outs for free.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the snapshot used by the new-only mode, for example \"my-newsletters\". Runs from a saved task get a snapshot automatically even without a name." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Hard cap on returned rows in the run.", "default": 10000 } } }, "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 } } } } } } } } } }