{ "openapi": "3.0.1", "info": { "title": "Reddit Posts Search Scraper", "version": "0.1", "x-build-id": "E9vexKah5g1L8sDma" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapapi~reddit-posts-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapapi-reddit-posts-search-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/scrapapi~reddit-posts-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapapi-reddit-posts-search-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/scrapapi~reddit-posts-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapapi-reddit-posts-search-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": [ "startUrls" ], "properties": { "startUrls": { "title": "πŸ”— Reddit URLs / Subreddits / Keywords", "type": "array", "description": "πŸ“₯ Drop in any mix of:\n 🌐 Full Reddit URLs (e.g., https://www.reddit.com/r/news/)\n πŸ“‚ Subreddit names (e.g., news, r/news)\n πŸ” Search keywords (e.g., artificial intelligence)\n\nπŸ’‘ Tip: One entry per line β€” the actor scrapes each source independently. πŸš€", "items": { "type": "string" } }, "sortOrder": { "title": "πŸ”„ Sort Order", "enum": [ "hot", "new", "top", "rising" ], "type": "string", "description": "🎯 How posts should be sorted on Reddit:\n πŸ”₯ hot β€” trending right now\n πŸ†• new β€” most recent\n πŸ† top β€” highest scoring (uses Time Filter)\n πŸ“ˆ rising β€” gaining traction fast", "default": "top" }, "maxPosts": { "title": "πŸ“Š Maximum Posts (total)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "🎯 Hard cap on the total number of posts the run will output across ALL sources combined (1–10000).\nπŸ’‘ The actor stops as soon as this many posts have been collected. Higher numbers = more data, but slower runs. ⏳", "default": 10 }, "maxComments": { "title": "πŸ’¬ Maximum Comments per Post", "minimum": 0, "maximum": 10000, "type": "integer", "description": "🧡 How many comments to fetch per post (0–1000).\n0️⃣ Set to 0 to skip comments and scrape post metadata only β€” ⚑ much faster.", "default": 10 }, "timeFilter": { "title": "⏰ Time Filter", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "πŸ“… Time window for the top/rising sort modes (ignored for hot/new):\n ⏱️ hour | πŸ“† day | πŸ—“οΈ week | πŸ“… month | πŸŽ‰ year | ♾️ all", "default": "week" }, "proxyConfiguration": { "title": "πŸ” Proxy Configuration", "type": "object", "description": "🌐 Pick which proxies to use.\nπŸ›‘οΈ Smart fallback: if Reddit blocks the current proxy, the actor automatically escalates β†’ πŸ†“ No Proxy β†’ 🏒 Datacenter β†’ 🏠 Residential." } } }, "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 } } } } } } } } } }