{ "openapi": "3.0.1", "info": { "title": "WordPress Plugins Scraper — Bulk CSV Export API", "description": "Collect WordPress.org plugin directory records by search, tag, author or slug with bounded continuation. Bulk export: JSON, CSV, Excel and API. Pay per result: $3/1K plugins; start fee extra.", "version": "1.1", "x-build-id": "V2DdSWU4OU76fFK0Y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~wordpress-plugins-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-wordpress-plugins-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/apivault_labs~wordpress-plugins-scraper/runs": { "post": { "operationId": "runs-sync-apivault_labs-wordpress-plugins-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/apivault_labs~wordpress-plugins-scraper/run-sync": { "post": { "operationId": "run-sync-apivault_labs-wordpress-plugins-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", "properties": { "mode": { "title": "Mode", "enum": [ "search", "browse", "tag", "author", "slugs" ], "type": "string", "description": "How to query the WordPress.org directory:\n• search — free-text search\n• browse — top lists (popular, new, updated, featured)\n• tag — plugins with a specific tag (slug, e.g. 'seo', 'woocommerce')\n• author — plugins by a specific WordPress.org author\n• slugs — fetch exact plugin slugs (full detail)", "default": "browse" }, "query": { "title": "Query", "type": "string", "description": "For search mode — keyword (e.g. 'seo', 'backup', 'woocommerce').\nFor tag mode — tag slug (e.g. 'seo', 'cache').\nFor author mode — WP.org username (e.g. 'yoast', 'automattic').\nIgnored in browse/slugs modes." }, "browseBy": { "title": "Browse category", "enum": [ "popular", "new", "updated", "featured" ], "type": "string", "description": "Used only in 'browse' mode.", "default": "popular" }, "slugs": { "title": "Plugin slugs", "type": "array", "description": "Used only in 'slugs' mode. List of exact plugin slugs (e.g. 'woocommerce', 'contact-form-7').", "items": { "type": "string" } }, "maxResults": { "title": "Max plugins to fetch", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum useful rows, also in slugs mode. Default10 for a small first run. 0 follows the source until exhaustion, maxPages, time or event budget; not a guarantee of full directory coverage.", "default": 10 }, "fullDetails": { "title": "Fetch full details per plugin", "type": "boolean", "description": "Fetch plugin detail for each listing result: contributors, ratings histogram and available support fields. No screenshots. Slugs mode always fetches detail. Failed enrichment retains a listing row with detailStatus=partial.", "default": false }, "extractInstalls": { "title": "Active Installs", "type": "boolean", "description": "Include active install count (rounded).", "default": true }, "extractRating": { "title": "Rating", "type": "boolean", "description": "rating is0–5; ratingRaw is0–100. Unknown or invalid values remain null.", "default": true }, "extractAuthor": { "title": "Author", "type": "boolean", "description": "Include author name, profile URL, and homepage.", "default": true }, "extractVersion": { "title": "Version & Compatibility", "type": "boolean", "description": "Include plugin version, required WP version, tested up to, required PHP.", "default": true }, "extractDates": { "title": "Dates", "type": "boolean", "description": "Include added date and last_updated date.", "default": true }, "extractTags": { "title": "Tags", "type": "boolean", "description": "Include tag list.", "default": true }, "extractSupport": { "title": "Support Stats", "type": "boolean", "description": "Public support thread counts and available support URL. Counts are not a resolution rate or vulnerability assessment.", "default": true }, "extractDownloadLink": { "title": "Download Link & Icon", "type": "boolean", "description": "Include direct .zip download URL and plugin icon.", "default": true }, "extractContributors": { "title": "Contributors (fullDetails only)", "type": "boolean", "description": "Include all contributors with their WP.org profile URLs. Requires fullDetails=true.", "default": true }, "extractRatingsHistogram": { "title": "Ratings Histogram (fullDetails only)", "type": "boolean", "description": "Include 1-5 star breakdown. Requires fullDetails=true.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Bounded concurrent detail requests,1–20. Directory pages are processed in order. Higher values can increase source rate-limit risk.", "default": 5 }, "timeout": { "title": "Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "HTTP timeout per API request.", "default": 30 }, "startPage": { "title": "First directory page", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Listing modes only. WordPress.org source page using a fixed100-row page size.", "default": 1 }, "startOffset": { "title": "Position within the first page", "minimum": 0, "maximum": 99, "type": "integer", "description": "Zero-based source position. Use SUMMARY.nextInput to continue a bounded collection.", "default": 0 }, "maxPages": { "title": "Maximum directory pages", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many pages and preserve continuation. Slugs mode ignores this setting.", "default": 1000 }, "excludeSlugs": { "title": "Already collected plugin slugs", "maxItems": 100000, "type": "array", "description": "Skip previously delivered slugs. Filled by SUMMARY.nextInput; source lists can change between runs.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }