{ "openapi": "3.0.1", "info": { "title": "Reddit Users V1 — Profile, Lookup, Follow, Block, Friend (13)", "description": "Full Reddit user toolkit — 8 anonymous lookups (profile, trophies, posts, comments, overview, browse, bulk-by-IDs, username) + 5 auth ops (my content, user actions, add/remove friend, friends list, show-my-flair). Use Reddit Vault or paste Token V2 + proxy.", "version": "0.13", "x-build-id": "Stn6xQkBNmRCnIaub" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/red_crawler~reddit-users/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-red_crawler-reddit-users", "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/red_crawler~reddit-users/runs": { "post": { "operationId": "runs-sync-red_crawler-reddit-users", "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/red_crawler~reddit-users/run-sync": { "post": { "operationId": "run-sync-red_crawler-reddit-users", "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": [ "endpoint" ], "properties": { "endpoint": { "title": "What to fetch", "enum": [ "about", "trophies", "overview", "posts", "comments", "browse_users", "lookup", "username_available", "my_content", "user_action", "friend_action", "friends_list", "show_my_flair" ], "type": "string", "description": "Choose which user operation to run. Anonymous endpoints don't need any auth. Auth-required endpoints (marked) need a Token V2 + proxy (or a saved Reddit Vault account).", "default": "about" }, "about_username": { "title": "Username", "type": "string", "description": "Reddit username, u/name, or profile URL. Used by: About." }, "trophies_username": { "title": "Username", "type": "string", "description": "Reddit username, u/name, or profile URL. Used by: Trophies." }, "overview_username": { "title": "Username", "type": "string", "description": "Reddit username, u/name, or profile URL. Used by: Overview." }, "overview_sort": { "title": "Sort", "enum": [ "new", "hot", "top", "controversial" ], "type": "string", "description": "Sort order. Used by: Overview.", "default": "new" }, "overview_time_filter": { "title": "Time filter (only for sort = top or controversial)", "enum": [ "", "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window — IGNORED unless sort is 'top' or 'controversial'. Leave as '—' for other sort orders.", "default": "" }, "overview_limit": { "title": "Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max items (1–100). Used by: Overview.", "default": 25 }, "posts_username": { "title": "Username", "type": "string", "description": "Reddit username, u/name, or profile URL. Used by: Posts." }, "posts_sort": { "title": "Sort", "enum": [ "new", "hot", "top", "controversial" ], "type": "string", "description": "Sort order. Used by: Posts.", "default": "new" }, "posts_time_filter": { "title": "Time filter (only for sort = top or controversial)", "enum": [ "", "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window — IGNORED unless sort is 'top' or 'controversial'. Leave as '—' for other sort orders.", "default": "" }, "posts_limit": { "title": "Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max posts (1–100). Used by: Posts.", "default": 25 }, "comments_username": { "title": "Username", "type": "string", "description": "Reddit username, u/name, or profile URL. Used by: Comments." }, "comments_sort": { "title": "Sort", "enum": [ "new", "hot", "top", "controversial" ], "type": "string", "description": "Sort order. Used by: Comments.", "default": "new" }, "comments_time_filter": { "title": "Time filter (only for sort = top or controversial)", "enum": [ "", "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window — IGNORED unless sort is 'top' or 'controversial'. Leave as '—' for other sort orders.", "default": "" }, "comments_limit": { "title": "Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max comments (1–100). Used by: Comments.", "default": 25 }, "browse_directory": { "title": "Directory", "enum": [ "popular", "new" ], "type": "string", "description": "Which directory to browse. Used by: Browse Users.", "default": "popular" }, "browse_limit": { "title": "Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max users to return (1–100). Used by: Browse Users.", "default": 25 }, "lookup_ids": { "title": "Account IDs", "type": "array", "description": "List of Reddit account IDs. Accepts both raw IDs (`abcd12`) and t2_-prefixed (`t2_abcd12`). One per row, or paste a comma-separated list — the actor will split it. Used by: Users by IDs.", "items": { "type": "string" } }, "available_username": { "title": "Username to check", "pattern": "^[A-Za-z0-9_\\-]{1,50}$", "type": "string", "description": "Username to check for availability. Letters, digits, underscore, hyphen — 1 to 50 characters. Used by: Username Available." }, "my_content_type": { "title": "Content type", "enum": [ "overview", "submitted", "comments", "upvoted", "downvoted", "hidden", "saved", "gilded" ], "type": "string", "description": "Which of your own listings to pull. Requires bearer + proxy (or a saved vault account). Used by: My Content.", "default": "overview" }, "my_content_sort": { "title": "Sort", "enum": [ "new", "hot", "top", "controversial" ], "type": "string", "description": "Sort order. Used by: My Content.", "default": "new" }, "my_content_time_filter": { "title": "Time filter (only for sort = top or controversial)", "enum": [ "", "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Time window — IGNORED unless sort is 'top' or 'controversial'. Leave as '—' for other sort orders.", "default": "" }, "my_content_limit": { "title": "Limit", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max items (1–100). Used by: My Content.", "default": 25 }, "user_action": { "title": "Action", "enum": [ "follow", "unfollow", "block", "unblock", "report" ], "type": "string", "description": "Which action to perform on the target user. Used by: User Action.", "default": "follow" }, "user_action_target": { "title": "Target user", "type": "string", "description": "Who to act on. Accepts username, u/name, profile URL, raw ID, or t2_ prefixed ID. Used by: User Action." }, "user_action_site_rule": { "title": "Site rule (only used when Action = report)", "type": "string", "description": "Reddit site rule key the user violated (e.g. `harassment`, `spam`). Optional. Ignored for follow / unfollow / block / unblock." }, "user_action_my_account_id": { "title": "Your account ID (only used when Action = unblock and auto-resolve fails)", "type": "string", "description": "Your own t2_ ID (e.g. `t2_1w72`). Optional — the actor auto-resolves this from your bearer for unblock. Fill in only if auto-resolve fails. Ignored for follow / unfollow / block / report." }, "friend_action": { "title": "Action", "enum": [ "add", "remove" ], "type": "string", "description": "Whether to add or remove the target user as a friend. Used by: Add / Remove Friend.", "default": "add" }, "friend_username": { "title": "Username", "type": "string", "description": "Reddit username to add or remove from your friends list. Used by: Add / Remove Friend." }, "friends_list_max": { "title": "Max friends to return (0 = all)", "minimum": 0, "type": "integer", "description": "Cap the number of friends returned (client-side trim). 0 or empty = return all. Used by: Friends List.", "default": 0 }, "show_my_flair_subreddit": { "title": "Subreddit", "type": "string", "description": "Subreddit name where you want to show or hide your flair (with or without `r/`). Used by: Show My Flair." }, "show_my_flair_enabled": { "title": "Show flair?", "type": "boolean", "description": "True = show your flair to other users in this subreddit. False = hide it. Used by: Show My Flair.", "default": true }, "credentialSource": { "title": "Credential source", "enum": [ "vault", "manual" ], "type": "string", "description": "Used by all auth-required endpoints (My Content, User Action, Add/Remove Friend, Friends List, Show My Flair). Anonymous endpoints ignore this section. **Use saved account (vault)** loads your stored Token V2 + proxy from the **reddit-vault** actor (auto-refreshed if you saved a Reddit Session) — only the 'Saved account name' field below is used. **Paste Token V2 + proxy** uses the values you paste below — the 'Saved account name' field is ignored.", "default": "vault" }, "accountName": { "title": "Saved account name (used when source = vault)", "pattern": "^[A-Za-z0-9_-]{1,32}$", "maxLength": 32, "type": "string", "description": "The name you used in the **reddit-vault** actor when you stored this account. Your Token V2 + proxy load automatically from the vault. Ignored when 'Credential source' = manual." }, "bearer": { "title": "Token V2 (used when source = manual)", "type": "string", "description": "Your Reddit `token_v2` cookie value (`eyJ...`). Lifetime ~24 h. Encrypted at rest by Apify. Ignored when 'Credential source' = vault." }, "proxy": { "title": "Proxy (used when source = manual)", "type": "string", "description": "Proxy in `ip:port:user:pass` format. MUST be the same IP that originally minted the Token V2. Ignored when 'Credential source' = vault." } } }, "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 } } } } } } } } } }