{ "openapi": "3.0.1", "info": { "title": "Substack Posts API: Newsletter Posts, Likes, Comments", "description": "Get posts from any Substack newsletter (substack.com or custom domain): title, date, free or paid, likes, comments, word count, authors and optional full text of free posts. Public API, no login.", "version": "0.1", "x-build-id": "ERpVsJHgtyRNpA4Y0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ailu_studio~substack-posts-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ailu_studio-substack-posts-api", "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/ailu_studio~substack-posts-api/runs": { "post": { "operationId": "runs-sync-ailu_studio-substack-posts-api", "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/ailu_studio~substack-posts-api/run-sync": { "post": { "operationId": "run-sync-ailu_studio-substack-posts-api", "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 as a subdomain (\"astralcodexten\"), a substack.com address (\"platformer.substack.com\"), a custom domain (\"newsletter.pragmaticengineer.com\") or any post URL. Profile links like substack.com/@name are not supported.", "default": [ "newsletter.pragmaticengineer.com", "astralcodexten.substack.com" ], "items": { "type": "string" } }, "sinceDays": { "title": "Only posts from the last N days", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Only return posts published within the last N days. 0 (default) means no date limit, so the newest posts up to the per-publication cap are returned.", "default": 0 }, "audience": { "title": "Free or paid posts", "enum": [ "all", "free", "paid" ], "type": "string", "description": "Filter by audience. \"free\" keeps posts open to everyone, \"paid\" keeps posts for paying or founding members. Paid posts are listed with their metadata only.", "default": "all" }, "includeBody": { "title": "Include full text of free posts", "type": "boolean", "description": "When true, fetches the full article of free posts and returns it as plain text in bodyText (one extra request per post). Paid posts never include the body.", "default": false }, "maxBodiesPerPublication": { "title": "Max full texts per publication", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Upper limit on full-text requests per publication when \"Include full text\" is on (default 20), newest posts first. Keeps runs fast and polite.", "default": 20 }, "maxPostsPerPublication": { "title": "Max posts per publication", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Upper limit on posts returned per publication, newest first (default 50). Use a large value with sinceDays to pull a whole archive.", "default": 50 }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper limit on returned rows for the whole run (default 200). Fetching stops once it is reached.", "default": 200 } } }, "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 } } } } } } } } } }