{ "openapi": "3.0.1", "info": { "title": "Substack Scraper - Posts, Substack Notes & Newsletter Archive", "description": "Substack scraper for posts and Substack Notes: paste publication URLs or profile handles and get every post with title, date, paywall flag, likes, restacks, comments, tags, authors and the full text of free posts, plus Notes with text, likes, restacks and replies. No login, no API key.", "version": "1.0", "x-build-id": "Q4weVXGQ6bzToyF6D" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~substack-scraper-posts-notes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-substack-scraper-posts-notes", "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/kamerozkan~substack-scraper-posts-notes/runs": { "post": { "operationId": "runs-sync-kamerozkan-substack-scraper-posts-notes", "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/kamerozkan~substack-scraper-posts-notes/run-sync": { "post": { "operationId": "run-sync-kamerozkan-substack-scraper-posts-notes", "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 (posts)", "type": "array", "description": "Newsletters whose posts you want, one per line: a publication URL (https://www.lennysnewsletter.com/), a subdomain (noahpinion = noahpinion.substack.com), any post URL of the publication, or a profile URL (https://substack.com/@lenny, resolved to the author's main publication).", "default": [ "https://www.lennysnewsletter.com/" ], "items": { "type": "string" } }, "profiles": { "title": "Profiles (Substack Notes)", "type": "array", "description": "Substack profiles whose Notes you want, one per line: a handle (lenny), @handle or a profile URL (https://substack.com/@lenny).", "default": [ "lenny" ], "items": { "type": "string" } }, "maxPostsPerPublication": { "title": "Max posts per publication", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Newest first. 50 posts are one request; the whole archive of a large newsletter is a few hundred posts.", "default": 50 }, "maxNotesPerProfile": { "title": "Max Notes per profile", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Newest first. Restacks (a Note that only shares a post or publication) count too and are flagged with isRestack.", "default": 50 }, "includeFullText": { "title": "Include the full text of free posts", "type": "boolean", "description": "One extra request per free post adds bodyText (the whole article as plain text). Paywalled posts get the public preview only and bodyTruncated = true; the scraper never bypasses a paywall.", "default": false }, "onlyFreePosts": { "title": "Only free posts", "type": "boolean", "description": "Skip paywalled posts (audience 'only_paid' or 'founding'). Skipped posts are not charged.", "default": false }, "sortPosts": { "title": "Post order", "enum": [ "new", "top" ], "type": "string", "description": "new = newest first (the archive order), top = most liked first.", "default": "new" }, "publishedAfter": { "title": "Published after (YYYY-MM-DD)", "type": "string", "description": "Return only posts and Notes published on or after this date, for example 2026-01-01. With 'Newest first' the scraper stops reading as soon as it reaches older posts, so scheduled runs stay cheap." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many posts and Notes in total. You are charged per item, so this also caps the cost of the run.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: Substack's public JSON endpoints answer plain requests. Enable Apify Proxy only if a run reports 403 or 429 errors." } } }, "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 } } } } } } } } } }