{ "openapi": "3.0.1", "info": { "title": "ConsumerAffairs Reviews Scraper", "description": "Scrape ConsumerAffairs reviews for any company: rating, full text, author, location, date, topics, verified badge, and company replies, plus company rating, review count, and profile. Export JSON, CSV, Excel.", "version": "1.0", "x-build-id": "gPYS6Eh9rUwpR5MDE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~consumeraffairs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-consumeraffairs-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/parsebird~consumeraffairs-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-consumeraffairs-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/parsebird~consumeraffairs-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-consumeraffairs-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": [ "companyUrls" ], "properties": { "companyUrls": { "title": "Company URLs", "type": "array", "description": "Add ConsumerAffairs company review pages, as full URLs (https://www.consumeraffairs.com/insurance/geico.htm) or paths (insurance/geico). Open a company on consumeraffairs.com and copy the address bar.", "items": { "type": "string" } }, "maxReviewsPerCompany": { "title": "Max reviews per company", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to save for each company. Set 0 for no limit.", "default": 100 }, "sortBy": { "title": "Sort reviews by", "enum": [ "recent", "top_reviews", "most_helpful", "oldest" ], "type": "string", "description": "Order in which reviews are collected, using ConsumerAffairs' own sort options.", "default": "recent" }, "ratingFilter": { "title": "Star ratings", "type": "array", "description": "Collect only reviews with these star ratings. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star" ] }, "default": [] }, "reviewsNewerThan": { "title": "Reviews newer than", "type": "string", "description": "Keep only reviews published on or after this date. With 'Most recent' sorting the Actor stops paging as soon as it reaches older reviews, which makes recurring monitoring runs cheap." }, "includeCompanyProfile": { "title": "Include company profiles", "type": "boolean", "description": "Save one company profile per company (overall rating, total reviews, rating breakdown, accreditation, address, website, social links) to the 'companies' dataset.", "default": true }, "maxPagesPerCompany": { "title": "Max pages per company", "minimum": 1, "maximum": 500, "type": "integer", "description": "Safety cap on review pages loaded per company (40+ reviews per page).", "default": 50 }, "maxRequestsPerCrawl": { "title": "Max requests per run", "minimum": 1, "type": "integer", "description": "Global safety cap on page requests for the whole run, including retries.", "default": 1000 }, "debugSaveHtml": { "title": "Save page HTML for debugging", "type": "boolean", "description": "Save the raw HTML of every loaded page to the key-value store. Leave off for normal runs.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "ConsumerAffairs uses PerimeterX bot protection. Residential proxies (US) are the default and recommended; datacenter proxies are blocked.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }