{ "openapi": "3.0.1", "info": { "title": "Substack Notes Scraper", "description": "Collect public Substack Notes from topic phrases or public source URLs. Save note text, stable IDs, public links, author details, times, engagement, media, and discovery data.", "version": "0.0", "x-build-id": "FOeiy9uFedYuphQVd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~substack-notes/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-substack-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/maximedupre~substack-notes/runs": { "post": { "operationId": "runs-sync-maximedupre-substack-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/maximedupre~substack-notes/run-sync": { "post": { "operationId": "run-sync-maximedupre-substack-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", "required": [ "target" ], "properties": { "target": { "title": "Collection target", "enum": [ "topicSearch", "sourceUrls" ], "type": "string", "description": "Choose where to collect public Substack Notes." }, "topicPhrases": { "title": "Topic phrases", "minItems": 1, "type": "array", "description": "Enter one or more phrases for a public Substack Notes search. Use this only with Topic search. It is ignored for Public source URLs.", "items": { "type": "string" } }, "searchOrder": { "title": "Search order", "enum": [ "relevance", "recent" ], "type": "string", "description": "Choose how Topic search results are ordered. Use this only with Topic search. It is ignored for Public source URLs." }, "sourceUrls": { "title": "Public source URLs", "minItems": 1, "type": "array", "description": "Enter one or more public Substack profile, feed, or Note URLs. The Actor collects Notes from these sources. Use this only with Public source URLs. It is ignored for Topic search.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "A public Substack profile, feed, or Note URL." } }, "required": [ "url" ] } }, "dateField": { "title": "Date field", "enum": [ "published", "changed" ], "type": "string", "description": "Choose which Note time the date range checks: publication time or change time." }, "startDate": { "title": "Start date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional inclusive start date in YYYY-MM-DD. Dates use UTC. Leave it empty to start at the first available result." }, "endDate": { "title": "End date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional inclusive end date in YYYY-MM-DD. Dates use UTC. Leave it empty to end at the last available result." }, "excludeNoteIds": { "title": "Note IDs to exclude", "minItems": 1, "type": "array", "description": "Optional stable Note IDs to skip. Enter one or more IDs to exclude them from this run.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum unique Notes", "minimum": 1, "type": "integer", "description": "Optional positive number of unique Notes to collect. If you leave it empty, the Actor collects all available results until the public sources are exhausted." } } }, "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 } } } } } } } } } }