{ "openapi": "3.0.1", "info": { "title": "Substack Scraper - Newsletters, Subscribers, Posts", "description": "Scrape Substack newsletters and posts: subscribers, paid prices, author socials, posts with likes, restacks, full text or HTML and comments. Search posts by topic across Substack, find top newsletters by category, filter by date and type. No login. From $0.50 per 1,000 posts.", "version": "0.1", "x-build-id": "M4GhU1VnmVyRYMLbW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/om_kh~substack-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-om_kh-substack-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/om_kh~substack-scraper/runs": { "post": { "operationId": "runs-sync-om_kh-substack-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/om_kh~substack-scraper/run-sync": { "post": { "operationId": "run-sync-om_kh-substack-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": { "newsletters": { "title": "Newsletters", "type": "array", "description": "Substack newsletters: links (any page of the newsletter, custom domains work), name.substack.com, or just the subdomain (e.g. lenny).", "items": { "type": "string" } }, "categories": { "title": "Categories (find newsletters)", "type": "array", "description": "Substack leaderboard categories to discover top newsletters, e.g. Technology, Business, Finance, Culture, Politics, Health & Wellness, Food & Drink, Sports, Science, Crypto.", "items": { "type": "string" } }, "maxNewslettersPerCategory": { "title": "Max newsletters per category", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Top-ranked first, 1 to 1,000. Default 25.", "default": 25 }, "paidOnly": { "title": "Paid leaderboard only", "type": "boolean", "description": "Use the leaderboard of paid newsletters (ranked by paid subscribers).", "default": false }, "keywords": { "title": "Topics to search (optional)", "type": "array", "description": "Find public posts across all of Substack for these topics, e.g. artificial intelligence, climate policy (up to 50).", "items": { "type": "string" } }, "maxPostsPerKeyword": { "title": "Max posts per topic", "minimum": 1, "maximum": 500, "type": "integer", "description": "1 to 500. Default 20.", "default": 20 }, "maxPostsPerNewsletter": { "title": "Max posts per newsletter", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Newest first, 0 to 5,000. 0 = newsletter info only. Default 20.", "default": 20 }, "includeText": { "title": "Include full post text", "type": "boolean", "description": "Full text of free posts (and the public preview of paid posts). One extra request per post.", "default": false }, "includeHtml": { "title": "Include the post HTML", "type": "boolean", "description": "Add the full HTML body next to the plain text (same price as the text).", "default": false }, "includeComments": { "title": "Include comments", "type": "boolean", "description": "Add each post's comments and replies in a commentsList field. No extra charge.", "default": false }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 1, "maximum": 2000, "type": "integer", "description": "1 to 2,000, replies included. Default 20.", "default": 20 }, "postedAfter": { "title": "Posted after (optional)", "type": "string", "description": "Only posts on or after this date (YYYY-MM-DD)." }, "postedBefore": { "title": "Posted before (optional)", "type": "string", "description": "YYYY-MM-DD. Keep only posts published on or before this day." }, "contentType": { "title": "Post type", "enum": [ "all", "newsletter", "podcast", "thread" ], "type": "string", "description": "Keep only this kind of post.", "default": "all" }, "onlyFree": { "title": "Free posts only", "type": "boolean", "description": "Skip paywalled posts.", "default": false }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "type": "number", "description": "Optional hard cost cap for this run." } } }, "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 } } } } } } } } } }