{ "openapi": "3.0.1", "info": { "title": "Apify Store Scraper (Incl Inputs & Outputs)", "description": "Discover and compare actors across the Apify Store in one run. This actor fetches the public catalog and can also scrape actor input and output schemas so you know exactly what each actor expects and returns. No browser required.", "version": "0.3", "x-build-id": "E0QEng4EW1JFBLhPK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/assmblr~apify-store-scraper-incl-inputs-outputs/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-assmblr-apify-store-scraper-incl-inputs-outputs", "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/assmblr~apify-store-scraper-incl-inputs-outputs/runs": { "post": { "operationId": "runs-sync-assmblr-apify-store-scraper-incl-inputs-outputs", "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/assmblr~apify-store-scraper-incl-inputs-outputs/run-sync": { "post": { "operationId": "run-sync-assmblr-apify-store-scraper-incl-inputs-outputs", "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": [ "operation" ], "properties": { "operation": { "title": "Operation", "enum": [ "search", "counts" ], "type": "string", "description": "Choose whether to return actor records or just counts (aggregations).", "default": "search" }, "query": { "title": "Query", "type": "array", "description": "Search keywords. Each item is OR'ed together. Multiple words in one item are treated as AND. Wrap words in quotes to match an exact phrase, e.g. \"apify store\".", "default": [], "items": { "type": "string" } }, "search_on": { "title": "Search on fields", "type": "array", "description": "Fields to search in. Leave empty to use the engine default.", "items": { "type": "string", "enum": [ "name", "title", "description", "username", "readme" ] }, "default": [] }, "username": { "title": "Developer username(s)", "type": "array", "description": "Only return actors by these developer usernames.", "default": [], "items": { "type": "string" } }, "manager": { "title": "Managed by", "enum": [ "ALL", "APIFY", "COMMUNITY" ], "type": "string", "description": "APIFY = managed/official, COMMUNITY = community actors, ALL disables this filter.", "default": "ALL" }, "limit": { "title": "Limit", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of actor records to return (free plan capped at 100).", "default": 1000 }, "sort": { "title": "Sort", "enum": [ "relevance", "popular", "newest", "update" ], "type": "string", "description": "Sorting preset.", "default": "popular" }, "category": { "title": "Category", "type": "array", "description": "Filter by categories. Leave empty for all categories.", "default": [], "items": { "type": "string" } }, "modified_hours": { "title": "Modified in past hours", "minimum": 0, "maximum": 8760, "type": "integer", "description": "Only include actors modified within the last N hours. 0 disables this filter.", "default": 0 }, "featured": { "title": "Featured", "type": "boolean", "description": "Only include featured/boosted actors (if supported by the backend).", "default": false }, "rating": { "title": "Minimum rating", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Minimum average rating threshold.", "default": "0" }, "reviews": { "title": "Minimum reviews", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum number of reviews.", "default": 0 }, "bookmarks": { "title": "Minimum bookmarks", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum number of bookmarks.", "default": 0 }, "users_count": { "title": "Users count period", "enum": [ "total", "week", "month", "threemonth" ], "type": "string", "description": "Which period to apply users_min/users_max to.", "default": "month" }, "users_min": { "title": "Users min", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Minimum users in the selected period.", "default": 0 }, "users_max": { "title": "Users max", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Maximum users in the selected period. 0 disables the max bound.", "default": 0 }, "price_model": { "title": "Price model", "type": "array", "description": "Filter by pricing model(s). Leave empty for any.", "default": [], "items": { "type": "string" } }, "price_min": { "title": "Price min (monthly)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum monthly pricing (USD). 0 disables.", "default": 0 }, "price_max": { "title": "Price max (monthly)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum monthly pricing (USD). 0 disables.", "default": 0 }, "manual": { "title": "README format", "enum": [ "TEXT", "HTML" ], "type": "string", "description": "If the backend supports returning README content, pick the format.", "default": "TEXT" }, "fields": { "title": "Customize fields", "type": "array", "description": "Whitelist output fields to return. Leave empty to return the default fieldset. Common fields: id, actorId, title, name, username, userFullName, description, categories, stats, currentPricingInfo, pricingModel, pricePerUnitUsd, minimalMaxTotalChargeUsd, badge, managedBy, storePosition, createdAt, modifiedAt, totalUsers, totalUsers7Days, totalUsers30Days, totalUsers90Days, bookmarkCount, actorReviewRating, actorReviewCount, notice, pictureUrl, userPictureUrl, isWhiteListedForAgenticPayments, sourceUrl.", "default": [], "items": { "type": "string" } }, "select_fields": { "title": "Select fields (paths)", "type": "array", "description": "Project output items to only these paths (dot notation + array indexes, e.g. currentPricingInfo.pricingModel, categories.0). Leave empty for default output. Common paths: id, title, username, stats.totalUsers, currentPricingInfo.pricingModel, currentPricingInfo.pricePerUnitUsd, categories.0, actorReviewRating, actorReviewCount, bookmarkCount.", "default": [], "items": { "type": "string" } }, "rename_fields": { "title": "Rename fields (paths)", "type": "object", "description": "Optional map of select_fields paths to output key names.", "default": {}, "additionalProperties": true }, "include_schemas": { "title": "Include input/output schemas", "type": "boolean", "description": "Fetch and attach input/output schema metadata for each actor (adds extra requests and triggers the incl-schemas event when monetized).", "default": false }, "hitsPerPage": { "title": "Hits per page", "minimum": 1, "maximum": 200, "type": "integer", "description": "Pagination size for the underlying search API. Keep low to avoid throttling.", "default": 100 }, "maxChargedResults": { "title": "Max charged results (soft cap)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Soft cap enforced in code to prevent runaway output. Set <= limit. 0 disables.", "default": 1000 } } }, "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 } } } } } } } } } }