{ "openapi": "3.0.1", "info": { "title": "Substack Scraper: Newsletter Posts & Stats", "description": "Export a Substack newsletter's full archive with engagement data. Returns title, subtitle, publish date, audience tier, reactions, comments, restacks, word count, tags, bylines and canonical URL per post, plus optional full post text. Accepts subdomains and custom domains.", "version": "0.1", "x-build-id": "g5oa7l1D7jHu5khSg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiorasolutions~substack-archive-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiorasolutions-substack-archive-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/axiorasolutions~substack-archive-scraper/runs": { "post": { "operationId": "runs-sync-axiorasolutions-substack-archive-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/axiorasolutions~substack-archive-scraper/run-sync": { "post": { "operationId": "run-sync-axiorasolutions-substack-archive-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", "required": [ "publications" ], "properties": { "publications": { "title": "Publications", "minItems": 1, "uniqueItems": true, "type": "array", "description": "One publication per entry. Substack subdomain or custom domain both work: astralcodexten.substack.com, www.noahpinion.blog, www.slowboring.com. Bare domains, full URLs and subpaths are all accepted.", "items": { "type": "string" } }, "maxPostsPerPublication": { "title": "Max posts per publication", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many posts from each publication, newest first.", "default": 100 }, "maxPostsTotal": { "title": "Max posts for the whole run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard ceiling across all publications.", "default": 500 }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Keep only posts published on or after this date. Accepts 2026-01-01 or a relative value such as 6 months." }, "includePostText": { "title": "Fetch full post text", "type": "boolean", "description": "Fetch each post page and extract the main body as clean plain text. Adds one request per free post. Paywalled posts return truncated text from the API, the same as a non-subscriber sees.", "default": false }, "postTextMaxChars": { "title": "Post text limit", "minimum": 500, "maximum": 80000, "type": "integer", "description": "Truncate extracted post text at this many characters.", "default": 8000 }, "audienceFilter": { "title": "Audience filter", "enum": [ "all", "free", "paid", "podcast" ], "type": "string", "description": "all keeps every post. free keeps only posts visible without a subscription. paid keeps only subscriber-only posts. podcast keeps only audio posts.", "default": "all" }, "tags": { "title": "Tags", "type": "array", "description": "Keep only posts carrying at least one of these tags, case-insensitive.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only posts whose title, subtitle or truncated preview contains one of these words, case-insensitive.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The Substack API normally answers direct requests.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }