{ "openapi": "3.0.1", "info": { "title": "Substack Newsletter Finder & Scraper", "description": "Find Substack newsletters by keyword or category with subscriber counts, author social links (X, LinkedIn, website, YouTube) and posting activity. Export posts with full text.", "version": "1.0", "x-build-id": "KhhkFlRp20AOY8pkI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/watershowdigital~substack-newsletter-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-watershowdigital-substack-newsletter-finder", "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/watershowdigital~substack-newsletter-finder/runs": { "post": { "operationId": "runs-sync-watershowdigital-substack-newsletter-finder", "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/watershowdigital~substack-newsletter-finder/run-sync": { "post": { "operationId": "run-sync-watershowdigital-substack-newsletter-finder", "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": "What to collect", "enum": [ "newsletters", "posts" ], "type": "string", "description": "Find newsletters (audience, author, social links, activity) or export posts from newsletters you already know.", "default": "newsletters" }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Topics to search, e.g. \"saas\", \"ai agents\", \"real estate investing\". Each keyword is searched separately and usually finds 50 to 300 newsletters.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Browse whole Substack categories. Each category goes up to about 500 of its most popular newsletters.", "items": { "type": "string", "enum": [ "Technology", "Business", "Finance", "Crypto", "Science", "Health & Wellness", "Culture", "News", "U.S. Politics", "World Politics", "Health Politics", "International", "Education", "Design", "Art & Illustration", "Music", "Film & TV", "Literature", "Fiction", "Comics", "History", "Philosophy", "Faith & Spirituality", "Climate & Environment", "Food & Drink", "Travel", "Fashion & Beauty", "Home & Garden", "Parenting", "Sports", "Games", "Humor", "Podcasts" ] } }, "minSubscribers": { "title": "Minimum subscribers", "minimum": 0, "type": "integer", "description": "Keep only newsletters with at least this many subscribers. Newsletters that hide their audience are skipped when this is set.", "default": 0 }, "language": { "title": "Language", "pattern": "^([a-zA-Z]{2})?$", "type": "string", "description": "Two-letter language code, e.g. en, es, de, fr. Empty means any language." }, "includeAuthorProfile": { "title": "Add author social links", "type": "boolean", "description": "Adds the author's X/Twitter, LinkedIn, website, YouTube, Bluesky and other links, plus a more exact subscriber count and Substack follower count. One extra request per newsletter.", "default": true }, "checkActivity": { "title": "Check posting activity", "type": "boolean", "description": "Adds the date of the last post and the number of posts in the last 30 days. One extra request per newsletter.", "default": true }, "activeWithinDays": { "title": "Only active within (days)", "minimum": 1, "type": "integer", "description": "Skip newsletters with no new post in this many days. Works with \"Check posting activity\"." }, "maxResults": { "title": "Max newsletters", "minimum": 1, "type": "integer", "description": "Stop after this many newsletters.", "default": 100 }, "newsletterUrls": { "title": "Newsletter URLs", "type": "array", "description": "Newsletters to export posts from: https://name.substack.com, a custom domain like https://www.lennysnewsletter.com, or any post link from the newsletter.", "items": { "type": "string" } }, "maxPostsPerNewsletter": { "title": "Max posts per newsletter", "minimum": 1, "type": "integer", "description": "Newest posts first.", "default": 50 }, "includeContent": { "title": "Include post text", "type": "boolean", "description": "Adds the full text of free posts and the public preview of paid ones. One extra request per post.", "default": true }, "onlyFree": { "title": "Only free posts", "type": "boolean", "description": "Skip paid posts and export only posts that everyone can read.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy spreads requests over several IPs so Substack does not slow the run down. Recommended for runs over a few hundred results.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }