{ "openapi": "3.0.1", "info": { "title": "Amazon Brand Revenue API - Sellers, Products, Keywords, Ad Spy", "description": "Amazon brand, seller, product and subcategory revenue estimates, keyword search volume and sponsored ad placements for 12 marketplaces, from the SmartScout Developer API. Search with filters or look up a brand, seller, ASIN or keyword. Read only. Bring your own key.", "version": "0.1", "x-build-id": "a7HBYaSP7xqv8kYck" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~amazon-brand-seller-revenue-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-amazon-brand-seller-revenue-api", "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/nabeelbaghoor~amazon-brand-seller-revenue-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-amazon-brand-seller-revenue-api", "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/nabeelbaghoor~amazon-brand-seller-revenue-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-amazon-brand-seller-revenue-api", "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": { "mode": { "title": "What to read", "enum": [ "brands", "products", "sellers", "subcategories", "searchTerms", "adSpyTerms", "brandSellers", "sellerBrands", "sellerProducts", "productSellers", "productKeywords", "subcategoryBrands", "keywordAdBrands", "sponsoredProducts" ], "type": "string", "description": "Brand search reads brands with estimated monthly revenue, units, price, reviews, sellers and growth, and needs nothing else, so it is the default. The other search modes read products, sellers, subcategories and keywords with the filters below. Lookup modes read what sits under one brand, seller, ASIN, subcategory or keyword, and need that value set.", "default": "brands" }, "marketplace": { "title": "Amazon marketplace", "enum": [ "US", "UK", "IT", "DE", "CA", "MX", "FR", "ES", "IN", "AU", "JP", "AE" ], "type": "string", "description": "The Amazon marketplace to read.", "default": "US" }, "searchText": { "title": "Search text", "type": "string", "description": "Search modes: matched against the brand name, product title, seller name, subcategory name or keyword, using the text match below. Keywords of a product: keep keywords containing this. Brands advertising on a keyword and sponsored products: the exact keyword, such as wireless earbuds." }, "textMatch": { "title": "Text match", "enum": [ "contains", "startsWith", "equals", "endsWith", "notContains", "notEquals" ], "type": "string", "description": "Search modes: how the search text is matched.", "default": "contains" }, "brandName": { "title": "Brand name", "type": "string", "description": "Sellers of a brand: the brand to read (required). Brand and product search: only this exact brand. Brands in a subcategory: only this brand. Sponsored products: the ads of this brand." }, "asins": { "title": "ASINs", "type": "array", "description": "Sellers of a product and keywords of a product: the ASINs to read, one per line (required). Product search: only these ASINs.", "items": { "type": "string" } }, "sellerIds": { "title": "Seller IDs", "type": "array", "description": "Brands of a seller and products of a seller: the Amazon seller IDs to read, one per line (required). Seller search: only these sellers.", "items": { "type": "string" } }, "subcategoryId": { "title": "Subcategory ID", "minimum": 1, "type": "integer", "description": "Brands in a subcategory: the subcategory to read (required), as the id the subcategory search lists. Brand and product search: only this subcategory. Subcategory search: the children of this subcategory." }, "categoryName": { "title": "Category name", "type": "string", "description": "Brand, product and seller search: only rows whose category contains this, such as Home & Kitchen." }, "minMonthlyRevenue": { "title": "Minimum monthly revenue", "minimum": 0, "type": "integer", "description": "Brand, product, seller and subcategory search: the lowest estimated monthly revenue, in the marketplace currency." }, "maxMonthlyRevenue": { "title": "Maximum monthly revenue", "minimum": 0, "type": "integer", "description": "Brand, product, seller and subcategory search: the highest estimated monthly revenue." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Brand and subcategory search: the lowest average price. Product search: the lowest buy box price." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Brand and subcategory search: the highest average price. Product search: the highest buy box price." }, "minReviewRating": { "title": "Minimum review rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Brand, product and subcategory search: the lowest star rating, from 1 to 5." }, "minEstimatedSearches": { "title": "Minimum estimated searches", "minimum": 0, "type": "integer", "description": "Keyword search, advertised keyword search and keywords of a product: the lowest estimated monthly searches." }, "maxEstimatedSearches": { "title": "Maximum estimated searches", "minimum": 0, "type": "integer", "description": "Keyword search, advertised keyword search and keywords of a product: the highest estimated monthly searches." }, "extraFilters": { "title": "Extra filters", "type": "object", "description": "Search modes, keywords of a product and brands in a subcategory: any further filters the provider documents for that mode, as a JSON object, such as {\"totalReviews\": {\"min\": 100}, \"hasStorefront\": true} for brands. Text filters take {\"type\": \"contains\", \"filter\": \"...\"}, ranges take min and max. These override the fields above." }, "sortBy": { "title": "Sort by", "type": "string", "description": "A field this mode returns, such as monthlyRevenue for brands, monthlyRevenueEstimate for products, estimateSales for sellers, totalMonthlyRevenue for subcategories or estimateSearches for keywords. Leave empty for the provider order." }, "sortOrder": { "title": "Sort order", "enum": [ "desc", "asc" ], "type": "string", "description": "Direction for the sort field.", "default": "desc" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows, across all lookups.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 300, "type": "integer", "description": "Pacing ceiling for calls to the provider. Rate limited answers are retried after the wait the provider asks for.", "default": 60 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key, sent as the X-Api-Key header. This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret instead. It is never written to a row or the log." } } }, "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 } } } } } } } } } }