{ "openapi": "3.0.1", "info": { "title": "Reddit Ads Scraper", "description": "Find and scrape top ads on Reddit. Get ad copy, ad shown date, ad type, industry, budget, and more. Download and track data from the Reddit Ads for competitive analysis.", "version": "1.0", "x-build-id": "Hwl7Rqgpie5UAWtws" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lexis-solutions~reddit-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lexis-solutions-reddit-ads-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/lexis-solutions~reddit-ads-scraper/runs": { "post": { "operationId": "runs-sync-lexis-solutions-reddit-ads-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/lexis-solutions~reddit-ads-scraper/run-sync": { "post": { "operationId": "run-sync-lexis-solutions-reddit-ads-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": [ "query" ], "properties": { "query": { "title": "Search Query", "type": "string", "description": "Enter keywords to search for specific ads. Leave empty to scrape all ads." }, "industry": { "title": "Industry Filter", "enum": [ "", "TECH_B2C", "TECH_B2B", "EDUCATION", "ENTERTAINMENT", "HEALTH_AND_BEAUTY", "GAMING", "EMPLOYMENT", "RETAIL_AND_ECOMMERCE", "AUTO", "FINANCIAL_SERVICES", "TRAVEL", "REAL_ESTATE", "GAMBLING_AND_FANTASY_SPORTS", "POLITICS_AND_GOVERNMENT", "CONSUMER_PACKAGED_GOODS", "OTHER" ], "type": "string", "description": "Filter ads by industry (e.g., TECH_B2C, FINANCE, etc.). Leave empty for all industries." }, "budgetCategory": { "title": "Budget Category", "enum": [ "", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Filter ads by budget category (e.g., LOW, MEDIUM, HIGH). Leave empty for all categories." }, "postType": { "title": "Post Type", "enum": [ "", "IMAGE", "VIDEO", "CAROUSEL", "FREE_FORM" ], "type": "string", "description": "Filter ads by post type (e.g., IMAGE, VIDEO, TEXT). Leave empty for all types." }, "placements": { "title": "Placements", "enum": [ "", "FEED", "CONVERSATION" ], "type": "string", "description": "Filter ads by placement (e.g., FEED, CONVERSATION). Leave empty for all placements." }, "objectiveType": { "title": "Objective Type", "enum": [ "", "AWARENESS", "CONVERSIONS", "APP_INSTALLS", "TRAFFIC", "VIDEO_VIEWABLE_IMPRESSIONS" ], "type": "string", "description": "Filter ads by objective type (e.g., AWARENESS, CONVERSIONS). Leave empty for all types." }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of ads to return. The API returns up to 30 ads per query.", "default": 5 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Your proxy configuration from Apify.", "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 } } }, "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 } } } } } } } } } }