{ "openapi": "3.0.1", "info": { "title": "Substack Scraper: Newsletter Finder, Subscribers & Prices", "description": "Find Substack newsletters by category, bestseller list or search, and get one report each: subscriber tier, paid prices, posting pace, likes and comments per post, top posts and leaderboard rank. Built for sponsors and writers. No login, no proxy.", "version": "0.1", "x-build-id": "zVKM5NWJhDmQLfv99" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/precious_bathmat~substack-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-precious_bathmat-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/precious_bathmat~substack-scraper/runs": { "post": { "operationId": "runs-sync-precious_bathmat-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/precious_bathmat~substack-scraper/run-sync": { "post": { "operationId": "run-sync-precious_bathmat-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": { "categories": { "title": "Categories", "type": "array", "description": "Substack categories to pull newsletters from. Bestseller and rising lists come with subscriber tiers.", "items": { "type": "string", "enum": [ "technology", "business", "finance", "culture", "news", "us-politics", "world-politics", "health-politics", "science", "health", "food", "sports", "music", "art", "design", "fashionandbeauty", "travel", "parenting", "faith", "philosophy", "literature", "fiction", "comics", "climate", "crypto", "international" ], "enumTitles": [ "Technology", "Business", "Finance", "Culture", "News", "U.S. Politics", "World Politics", "Health Politics", "Science", "Health & Wellness", "Food & Drink", "Sports", "Music", "Art & Illustration", "Design", "Fashion & Beauty", "Travel", "Parenting", "Faith & Spirituality", "Philosophy", "Literature", "Fiction", "Comics", "Climate & Environment", "Crypto", "International" ] } }, "listType": { "title": "Which list", "enum": [ "bestsellers", "trending", "all" ], "type": "string", "description": "Bestsellers are Substack's top paid newsletters per category; Rising is its trending list; All is the full category directory (no subscriber tiers).", "default": "bestsellers" }, "maxPerCategory": { "title": "Newsletters per category", "minimum": 1, "maximum": 500, "type": "integer", "description": "How far down each list to go, 25 per page.", "default": 25 }, "newsletters": { "title": "Specific newsletters", "type": "array", "description": "Newsletter addresses to report on: https://name.substack.com, a custom domain like www.lennysnewsletter.com, or a profile like https://substack.com/@handle.", "items": { "type": "string" } }, "searchQueries": { "title": "Search Substack writers", "type": "array", "description": "Words to search Substack's writers for, e.g. \"AI\", \"personal finance\". Substack returns a few writers per page, so categories find more.", "items": { "type": "string" } }, "maxPerQuery": { "title": "Newsletters per search", "minimum": 1, "maximum": 60, "type": "integer", "description": "The most newsletters to take from each search.", "default": 10 }, "postsPerNewsletter": { "title": "Recent posts per newsletter", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many of each newsletter's latest posts the report is built from.", "default": 20 }, "includePosts": { "title": "Also save every post", "type": "boolean", "description": "Saves the posts behind the reports as CSV and JSON: title, link, date, likes, comments, restacks, word count and whether it is paywalled. Charged per post.", "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 }, "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 } } } } } } } } } }