{ "openapi": "3.0.1", "info": { "title": "Substack Scraper", "description": "Scrapes posts from any Substack newsletter or custom domain, single posts, profiles and Substack search: title, authors, date, likes, comments, restacks, free or paid, word count and optional full text.", "version": "0.0", "x-build-id": "Fj1BKQD2e2npD1A0g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mina_safwat~substack-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mina_safwat-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/mina_safwat~substack-scraper/runs": { "post": { "operationId": "runs-sync-mina_safwat-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/mina_safwat~substack-scraper/run-sync": { "post": { "operationId": "run-sync-mina_safwat-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": { "start_urls": { "title": "Substack links", "type": "array", "description": "One link per line, with or without https://. A newsletter (https://example.substack.com, a custom domain such as https://www.lennysnewsletter.com, or its /archive page) gives its posts; a section link (…/s/section-name) or an archive search (…/archive?search=pricing) gives only those posts; a post link (…/p/post-name) gives that one post; an author profile (https://substack.com/@handle) gives the posts of the author's own newsletter; a search page (https://substack.com/search/ai%20agents) gives the posts Substack's search finds. Links that cannot be read, such as Substack Notes, tag or podcast pages, are listed in the FAILED_INPUTS record and never widened to the whole newsletter.", "default": [], "items": { "type": "string" } }, "search_queries": { "title": "Search Substack (optional)", "type": "array", "description": "Words or phrases, one per line, such as product management. Each one runs Substack's own post search across all newsletters and saves the posts it finds, most relevant first.", "default": [], "items": { "type": "string" } }, "max_posts_per_newsletter": { "title": "Max posts per newsletter or search", "minimum": 1, "type": "integer", "description": "Stops after this many posts for each newsletter, profile or search. Single post links always give their one post. Set a large number, such as 10000, to read a whole archive.", "default": 50 }, "sort": { "title": "Order", "enum": [ "new", "top" ], "type": "string", "description": "The order a newsletter's posts are read in, so the limit above keeps the newest or the most popular. A newsletter link that already says ?sort=top or ?sort=new keeps its own order. Searches are always ordered by relevance.", "default": "new" }, "include_full_text": { "title": "Include full text of free posts", "type": "boolean", "description": "Adds each free post's text, as plain text, in a \"text\" field. This needs one extra request per post, so runs are slower, and each row with text is billed as a full-text post on top of the row. Paid and subscriber-only posts never get text: the Actor reads only what a logged-out visitor sees and never unlocks a paywall.", "default": false }, "proxy_configuration": { "title": "Proxy", "type": "object", "description": "Leave this empty: Substack answers the Actor directly, and if it ever refuses, the Actor retries through Apify's datacenter proxy and then residential proxies on its own.", "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 } } } } } } } } } }