{ "openapi": "3.0.1", "info": { "title": "Reddit Historical Archive Scraper — RAG & Comment Search", "description": "Archive historical Reddit posts and comments for RAG and research. Search by date, subreddit, author, post, or comment body beyond live listings. Use a live sibling for hot/new feeds. Returns RAG-ready rows with documentId, chunkText, sourceUrl, createdAt, and provenance. $0.005 per item plus usage.", "version": "0.2", "x-build-id": "XJZGPp2dJ0ln4aOF9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~reddit-archive-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-reddit-archive-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/khadinakbar~reddit-archive-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-reddit-archive-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/khadinakbar~reddit-archive-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-reddit-archive-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": { "subreddits": { "title": "Subreddits", "type": "array", "description": "Subreddit names to archive historically (e.g. MachineLearning). Accepts with or without r/ prefix. Defaults empty. NOT live Reddit hot listings — this pages the public archive by date.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Post search queries", "type": "array", "description": "Keywords matched against archived post titles and self-text (e.g. retrieval augmented generation). Combine with subreddits and date bounds. Defaults empty. NOT comment-body search — use commentSearchQueries for that.", "default": [], "items": { "type": "string" } }, "commentSearchQueries": { "title": "Comment body search queries", "type": "array", "description": "Full-text search inside archived comment bodies (e.g. embeddings). Reddit native search cannot do this. Defaults empty. NOT post-title search — use searchQueries for posts.", "default": [], "items": { "type": "string" } }, "postIds": { "title": "Post IDs", "type": "array", "description": "Reddit post base36 IDs from /comments/{id}/ (e.g. 1hqoku0). Fetches each archived post and, when includeComments is on, its comment tree. Defaults empty.", "default": [], "items": { "type": "string" } }, "usernames": { "title": "Usernames", "type": "array", "description": "Reddit usernames whose archived posts and/or comments to pull (e.g. spez). Accepts with or without u/ prefix. Defaults empty. Controlled by userContent.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Reddit URLs", "type": "array", "description": "Reddit URLs auto-classified as subreddit, post, or user (e.g. https://www.reddit.com/r/MachineLearning/). Mix types in one run. Defaults empty.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "afterDate": { "title": "After date", "type": "string", "description": "Only return items created on or after this date. Format YYYY-MM-DD or ISO timestamp (e.g. 2024-01-01). Leave empty for no lower bound. NOT a Reddit sort timeframe like week/month." }, "beforeDate": { "title": "Before date", "type": "string", "description": "Only return items created on or before this date. Format YYYY-MM-DD or ISO timestamp (e.g. 2024-06-30). Leave empty for no upper bound." }, "sortOrder": { "title": "Sort order", "enum": [ "newest", "oldest" ], "type": "string", "description": "Archive sort by created time. newest returns recent archived items first; oldest pages forward from the start of the window. Default newest.", "default": "newest" }, "minScore": { "title": "Minimum score", "minimum": 0, "type": "integer", "description": "Keep only posts/comments with Reddit score at or above this value. Leave empty for no filter. Useful to drop low-engagement noise from a RAG corpus." }, "includeComments": { "title": "Include comments for posts", "type": "boolean", "description": "When scraping subreddit listings, keyword posts, or post IDs, also fetch archived comments for each post. Increases row count and cost. Default false for lean RAG post packs.", "default": false }, "maxCommentsPerPost": { "title": "Max comments per post", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap archived comments fetched per post when includeComments is true. Default 50. Set higher for deep thread dumps.", "default": 50 }, "userContent": { "title": "User content type", "enum": [ "both", "posts", "comments" ], "type": "string", "description": "When usernames are set, choose posts only, comments only, or both. Default both. Ignored when no usernames are provided.", "default": "both" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on billed dataset rows across all targets for this run. Example: 3 for an agent-quality sample or 500 for a bounded corpus. Prefill 3; maximum 50000. This controls returned records, not a date filter.", "default": 100 }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Milliseconds to wait between archive HTTP requests. Default 800 keeps polite rate limits. Lower only if you accept more 429s.", "default": 800 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Archives often block datacenter IPs — Residential US is recommended. Default uses Apify Proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "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 } } } } } } } } } }