{
  "openapi": "3.0.1",
  "info": {
    "title": "WordPress Plugin & Theme Scraper - Installs, Ratings & Leads",
    "description": "Scrape WordPress.org plugins & themes: active installs, downloads, ratings, support stats, version history, changelogs, WP/PHP compatibility, business model & author contact leads. Search by keyword, tag or author. Monitor mode for new/changed items. Export JSON, CSV, Excel.",
    "version": "1.1",
    "x-build-id": "TqY6RatNfc073MMzs"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~wordpress-plugin-theme-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-wordpress-plugin-theme-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/scrapesage~wordpress-plugin-theme-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-wordpress-plugin-theme-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/scrapesage~wordpress-plugin-theme-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-wordpress-plugin-theme-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": "What to scrape",
            "enum": [
              "searchPlugins",
              "searchThemes",
              "pluginDetails",
              "themeDetails"
            ],
            "type": "string",
            "description": "Choose plugins or themes, and whether to search/browse the directory or fetch specific items by slug/URL.",
            "default": "searchPlugins"
          },
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Keywords to search the directory, e.g. <code>seo</code>, <code>woocommerce payments</code>, <code>backup</code>, <code>contact form</code>. Each keyword is scraped separately. (Search / browse modes.)",
            "items": {
              "type": "string"
            }
          },
          "browse": {
            "title": "Browse list",
            "enum": [
              "",
              "popular",
              "featured",
              "new",
              "updated",
              "top-rated"
            ],
            "type": "string",
            "description": "Browse a curated directory list instead of (or in addition to) keywords. Used when no keyword/tag/author is given.",
            "default": ""
          },
          "tags": {
            "title": "Tags",
            "type": "array",
            "description": "Directory tag slugs to browse, e.g. <code>woocommerce</code>, <code>security</code>, <code>gutenberg</code>, <code>seo</code>, <code>ecommerce</code>, <code>elementor</code>. (Search / browse modes.)",
            "items": {
              "type": "string"
            }
          },
          "authors": {
            "title": "Authors",
            "type": "array",
            "description": "WordPress.org author usernames (from <code>profiles.wordpress.org/&lt;username&gt;</code>) to list every plugin/theme they publish — great for competitor & acquisition intelligence and author leads. E.g. <code>automattic</code>, <code>wpengine</code>.",
            "items": {
              "type": "string"
            }
          },
          "slugs": {
            "title": "Plugin / theme slugs or URLs",
            "type": "array",
            "description": "For the \"Specific…\" modes: slugs (<code>woocommerce</code>, <code>astra</code>) or full URLs (<code>https://wordpress.org/plugins/woocommerce/</code>).",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Optional WordPress.org plugin/theme URLs to scrape directly, in addition to the above.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of plugin/theme records to return across all queries.",
            "default": 100
          },
          "fullDetails": {
            "title": "Fetch full details for every result",
            "type": "boolean",
            "description": "Fetch the complete record for each item (contributors, version history, changelog, screenshots, business model, support stats). Turn off for a faster, lighter run that uses only search-result fields.",
            "default": true
          },
          "minActiveInstalls": {
            "title": "Minimum active installs",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep plugins/themes with at least this many active installs (great for filtering to established products).",
            "default": 0
          },
          "minRating": {
            "title": "Minimum rating (0–100)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only keep items with a rating at or above this value (WordPress ratings are on a 0–100 scale; 80 = 4 stars).",
            "default": 0
          },
          "includeRawData": {
            "title": "Include raw API object",
            "type": "boolean",
            "description": "Attach the complete untouched WordPress.org API response under a <code>raw</code> field for power users. Increases item size.",
            "default": false
          },
          "enrichContacts": {
            "title": "Enrich author contacts from their website",
            "type": "boolean",
            "description": "Crawl each item's author/homepage (up to 3 pages: home + contact/about) for contact emails, phone numbers and social links (LinkedIn, X/Twitter, Facebook, Instagram, YouTube, GitHub). WordPress.org never exposes emails — this turns plugin/theme authors into ready-to-contact leads.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitor mode (only new / changed items)",
            "type": "boolean",
            "description": "Remember items across runs and only output ones that are NEW or whose version / active installs / last-updated date CHANGED since the previous run. Perfect for tracking competitor plugins. Works with Apify Schedules — schedule a run, get only the deltas.",
            "default": false
          },
          "monitorField": {
            "title": "Change to watch",
            "enum": [
              "any",
              "version",
              "active_installs",
              "last_updated"
            ],
            "type": "string",
            "description": "Which field defines a \"change\" in monitor mode.",
            "default": "any"
          },
          "onlyNew": {
            "title": "Only brand-new items",
            "type": "boolean",
            "description": "In monitor mode, output only items never seen in a previous run (ignore updates to known items).",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "Namespace for the monitor memory. Use a stable, unique value per monitoring job (e.g. <code>seo-plugins-watch</code>) so different watches don't share state.",
            "default": "default"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many detail requests to run in parallel.",
            "default": 10
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. The WordPress.org API is open and clean; the default Apify Proxy is more than enough and helps spread any per-IP rate limiting.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}