{ "openapi": "3.0.1", "info": { "title": "Substack Scraper – Posts, Newsletters & Stats", "description": "Scrape posts from any Substack newsletter: title, date, free or paid, authors, likes, comments, restacks, word count and the full text of free posts. Custom domains, keyword search for publications and an only-new mode for monitoring. Pay per post.", "version": "0.1", "x-build-id": "fRLBdhvbNcXWc5o4s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/anxuanng~substack-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-anxuanng-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/anxuanng~substack-scraper/runs": { "post": { "operationId": "runs-sync-anxuanng-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/anxuanng~substack-scraper/run-sync": { "post": { "operationId": "run-sync-anxuanng-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": { "publications": { "title": "Publications", "type": "array", "description": "Substack newsletters to scrape, one per line: a name ('lenny'), a subdomain ('noahpinion.substack.com'), a custom domain ('www.lennysnewsletter.com') or any post URL.", "items": { "type": "string" } }, "searchQuery": { "title": "Find publications by keyword", "type": "string", "description": "Optional. Search Substack for publications about this topic (e.g. 'product management', 'AI agents') and scrape their posts too." }, "maxPublications": { "title": "Max publications from search", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many publications to take from the keyword search.", "default": 10 }, "maxPostsPerPublication": { "title": "Max posts per publication", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Newest posts first. Stops earlier if 'Posted after' is reached.", "default": 50 }, "postedAfter": { "title": "Posted after", "type": "string", "description": "Only posts published on or after this date (YYYY-MM-DD). Leave empty for no limit." }, "audience": { "title": "Free or paid", "enum": [ "all", "free", "paid" ], "type": "string", "description": "Keep all posts, only free posts, or only paid (subscriber-only) posts.", "default": "all" }, "includeBody": { "title": "Include post text", "type": "boolean", "description": "Add the full text of free posts as plain text (paid posts get the public preview, marked bodyTruncated). Turn off for metadata only; it is faster.", "default": true }, "onlyNewPosts": { "title": "Only new posts", "type": "boolean", "description": "Return only posts you have not received in earlier runs of this Actor. Turn on for scheduled monitoring so you never pay twice for the same post.", "default": false }, "maxItems": { "title": "Max posts in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many posts across all publications. You are only charged per post delivered.", "default": 1000 } } }, "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 } } }, "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 } } } } } } } } } }