{ "openapi": "3.0.1", "info": { "title": "Chrome Web Store & Firefox Add-ons Scraper: Reviews & Ranks", "description": "Scrape Chrome Web Store, Firefox Add-ons and Edge Add-ons extensions: users, rating, version, last updated, developer, permissions with a risk score, reviews (Chrome + Firefox) and category / keyword rank snapshots. onlyNew review monitoring.", "version": "1.0", "x-build-id": "3ZEPfe58hlgjacj2m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aria-data~browser-extension-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aria-data-browser-extension-intelligence", "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/aria-data~browser-extension-intelligence/runs": { "post": { "operationId": "runs-sync-aria-data-browser-extension-intelligence", "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/aria-data~browser-extension-intelligence/run-sync": { "post": { "operationId": "run-sync-aria-data-browser-extension-intelligence", "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": { "extensions": { "title": "Extensions (URLs or IDs)", "type": "array", "description": "Chrome Web Store, Firefox Add-ons or Edge Add-ons URLs. Bare 32-letter IDs are treated as Chrome (see Default store); other bare values as Firefox slugs. Prefixes also work: 'firefox:darkreader', 'edge:', 'chrome:'.", "items": { "type": "string" } }, "defaultStore": { "title": "Default store for bare 32-letter IDs", "enum": [ "chrome", "edge" ], "type": "string", "description": "Chrome and Edge both use 32-letter IDs; pick which store a bare ID refers to.", "default": "chrome" }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also return reviews (Chrome Web Store and Firefox Add-ons; Edge reviews are not supported yet).", "default": false }, "maxReviewsPerExtension": { "title": "Max reviews per extension", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many reviews per extension (newest first).", "default": 20 }, "reviewSort": { "title": "Chrome review order", "enum": [ "recent", "helpful" ], "type": "string", "description": "Firefox reviews are always newest first. Date filtering stops early only with newest first.", "default": "recent" }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Only reviews on or after this date: YYYY-MM-DD, or a period like '30 days' / '2 weeks'." }, "reviewRatings": { "title": "Only these star ratings", "type": "array", "description": "e.g. [\"1\", \"2\"] for complaints only. Empty = all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "onlyNewReviews": { "title": "Only new reviews (monitoring)", "type": "boolean", "description": "Return (and charge) only reviews not returned by an earlier run with the same Monitor ID. Ideal for scheduled runs.", "default": false }, "monitorChanges": { "title": "Monitor listing changes", "type": "boolean", "description": "Compare each profile with the last run that used the same Monitor ID and add a `changes` list (new version, permissions added or removed, owner or contact change, risk level change, description rewrite, users down or up 10%+, rating moves 0.1+). The first run saves the baseline (isFirstSnapshot = true).", "default": false }, "onlyChanged": { "title": "Only return changed extensions", "type": "boolean", "description": "With change monitoring on, return (and charge) a profile only when something changed since the last run. Unchanged extensions cost nothing. Ideal for daily security or competitor watches.", "default": false }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Separate 'seen reviews' memory per monitor, so different schedules don't interfere.", "default": "default" }, "rankStore": { "title": "Rank snapshot store", "enum": [ "chrome", "firefox" ], "type": "string", "description": "Which store the category / keyword lists below are taken from.", "default": "chrome" }, "rankCategories": { "title": "Categories to rank", "type": "array", "description": "Chrome: category slugs like 'productivity/workflow', 'productivity/developer', 'make_chrome_yours/privacy', 'lifestyle/shopping' (or the category URL). Firefox: slugs like 'privacy-security', 'tabs', 'appearance', 'shopping'.", "items": { "type": "string" } }, "rankSearchKeywords": { "title": "Search keywords to rank", "type": "array", "description": "Store search results in order, e.g. 'password manager', 'ad blocker'.", "items": { "type": "string" } }, "rankMaxItems": { "title": "Max extensions per list", "minimum": 1, "maximum": 500, "type": "integer", "description": "Firefox lists page up to 500. Chrome returns the first results page (about 32 for categories, about 10 for searches).", "default": 50 }, "rankSortFirefox": { "title": "Firefox category order", "enum": [ "users", "rating", "updated", "created", "hotness", "downloads", "recommended" ], "type": "string", "description": "Sort order for Firefox category lists.", "default": "users" }, "requestIntervalSecs": { "title": "Seconds between requests", "minimum": 0.5, "maximum": 10, "type": "number", "description": "Politeness delay per store.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not needed for normal volumes; use it for very large Chrome runs." } } }, "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 } } } } } } } } } }