{ "openapi": "3.0.1", "info": { "title": "Substack Scraper & Newsletter Revenue Estimate", "description": "Substack scraper for the bestseller and rising leaderboards of any category: rank, paid-subscriber tier, prices, and an estimated annual revenue range per newsletter with the calculation shown. Tracks rank, tier and price changes between runs. $3 per 1,000 publications.", "version": "0.0", "x-build-id": "bQmMeLgtQmWT1PNLj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadywren~substack-revenue-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadywren-substack-revenue-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/steadywren~substack-revenue-scraper/runs": { "post": { "operationId": "runs-sync-steadywren-substack-revenue-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/steadywren~substack-revenue-scraper/run-sync": { "post": { "operationId": "run-sync-steadywren-substack-revenue-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": { "categories": { "title": "Categories", "type": "array", "description": "Substack categories by slug, id or name, or \"all\" for every category. Slugs: culture, technology, business, us-politics, finance, food, podcast, sports, art, world-politics, health-politics, news, fashionandbeauty, music, faith, climate, science, literature, fiction, health, design, travel, parenting, philosophy, comics, international, crypto, history, humor, education, film-and-tv, home-garden, games. Unknown names are skipped with a warning.", "default": [ "technology" ], "items": { "type": "string" } }, "boards": { "title": "Leaderboards", "type": "array", "description": "\"paid\" = Substack's bestseller leaderboard of the category, \"rising\" = Substack's rising leaderboard. Each board lists up to 100 publications.", "items": { "type": "string", "enum": [ "paid", "rising" ], "enumTitles": [ "Bestsellers (paid)", "Rising" ] }, "default": [ "paid" ] }, "maxPerBoard": { "title": "Publications per board", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many ranks to read per category and board. Substack shows up to 100 (4 pages of 25).", "default": 25 }, "publications": { "title": "Extra publications to look up", "type": "array", "description": "Optional. Substack subdomains (lenny), custom domains (www.lennysnewsletter.com) or URLs. Each one is returned as a row with board \"lookup\".", "items": { "type": "string" } }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Compare each board with your previous run: rank change, tier upgrade or downgrade, price change, new entries and exits. Snapshots are kept in your named key-value store \"substack-board-history\".", "default": true }, "includeCadence": { "title": "Include posting cadence", "type": "boolean", "description": "Read the 20 latest posts of each publication: adds last post date, posts per week and the share of paid-only posts, and saves the posts to a second dataset at $0.001 per post. Adds about 1 s per publication (archive requests are paced to stay under Substack's rate limit). A publication whose archive could not be read keeps null cadence fields and is listed in cadenceUnavailable (RUN_SUMMARY, CATEGORY_SUMMARY).", "default": false }, "maxItems": { "title": "Max publications", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many publication rows. You are charged per row, so this also caps the cost. Only boards delivered in full are saved for change tracking: keep this above categories x boards x Publications per board.", "default": 1000 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many requests run in parallel.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Substack's public API works without a proxy; turn one on only if requests get blocked.", "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 } } } } } } } } } }