{
  "openapi": "3.0.1",
  "info": {
    "title": "Scrappey Web Scraper – Managed Browser & Proxy API",
    "description": "Scrape data from modern, JavaScript-heavy web pages using the Scrappey.com API integrated with an Apify Actor. A robust solution for complex scraping scenarios — managed browser sessions, proxy rotation, and full browser automation.",
    "version": "1.0",
    "x-build-id": "mI5zqpUKTsi4lGKxU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dormic~apify-scrappey/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dormic-apify-scrappey",
        "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/dormic~apify-scrappey/runs": {
      "post": {
        "operationId": "runs-sync-dormic-apify-scrappey",
        "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/dormic~apify-scrappey/run-sync": {
      "post": {
        "operationId": "run-sync-dormic-apify-scrappey",
        "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": [
          "scrappeyApiKey",
          "url"
        ],
        "properties": {
          "scrappeyApiKey": {
            "title": "Scrappey API Key",
            "type": "string",
            "description": "Your Scrappey API key. Get one at https://scrappey.com"
          },
          "url": {
            "title": "Target URL",
            "type": "string",
            "description": "The URL of the website to scrape"
          },
          "cmd": {
            "title": "HTTP Method",
            "enum": [
              "request.get",
              "request.post",
              "request.put",
              "request.delete",
              "request.patch"
            ],
            "type": "string",
            "description": "The HTTP method to use for the request",
            "default": "request.get"
          },
          "postData": {
            "title": "Request Body (POST/PUT/PATCH)",
            "type": "object",
            "description": "Data to send with POST, PUT, or PATCH requests. Can be form data or JSON."
          },
          "requestType": {
            "title": "Request Type",
            "enum": [
              "browser",
              "request"
            ],
            "type": "string",
            "description": "Use 'browser' for full browser rendering (slower, handles JS) or 'request' for HTTP-only mode (faster, cheaper)",
            "default": "browser"
          },
          "proxyCountry": {
            "title": "Proxy Country",
            "type": "string",
            "description": "Request a proxy from a specific country (e.g., UnitedStates, Germany, UnitedKingdom)"
          },
          "proxy": {
            "title": "Custom Proxy",
            "type": "string",
            "description": "Custom proxy URL in format: http://username:password@ip:port"
          },
          "premiumProxy": {
            "title": "Use Premium Proxy",
            "type": "boolean",
            "description": "Use premium residential proxies for better success rates",
            "default": false
          },
          "mobileProxy": {
            "title": "Use Mobile Proxy",
            "type": "boolean",
            "description": "Use mobile carrier proxies",
            "default": false
          },
          "session": {
            "title": "Session ID",
            "type": "string",
            "description": "Session ID for maintaining state across requests. Leave empty for automatic session."
          },
          "browserActions": {
            "title": "Browser Actions",
            "type": "array",
            "description": "Array of browser automation actions (click, type, scroll, wait, etc.)"
          },
          "automaticallySolveCaptchas": {
            "title": "Automatically Handle Verification",
            "type": "boolean",
            "description": "Automatically work through detected verification widgets where access is permitted",
            "default": false
          },
          "alwaysLoad": {
            "title": "Always Load Verification Types",
            "type": "array",
            "description": "Verification widget types to always load handlers for",
            "items": {
              "type": "string"
            }
          },
          "cloudflareBypass": {
            "title": "Challenge Handling Mode A",
            "type": "boolean",
            "description": "Enable additional optimizations for sites with interstitial challenge pages",
            "default": false
          },
          "datadomeBypass": {
            "title": "Challenge Handling Mode B",
            "type": "boolean",
            "description": "Enable additional optimizations for sites with advanced verification flows",
            "default": false
          },
          "kasadaBypass": {
            "title": "Challenge Handling Mode C",
            "type": "boolean",
            "description": "Enable additional optimizations for sites with client-side verification",
            "default": false
          },
          "screenshot": {
            "title": "Capture Screenshot",
            "type": "boolean",
            "description": "Capture a screenshot of the page",
            "default": false
          },
          "screenshotUpload": {
            "title": "Upload Screenshot",
            "type": "boolean",
            "description": "Upload screenshot to storage and return URL",
            "default": false
          },
          "video": {
            "title": "Record Video",
            "type": "boolean",
            "description": "Record browser session as video",
            "default": false
          },
          "cssSelector": {
            "title": "CSS Selector",
            "type": "string",
            "description": "Extract content matching this CSS selector"
          },
          "innerText": {
            "title": "Include Inner Text",
            "type": "boolean",
            "description": "Include the inner text content of the page",
            "default": false
          },
          "includeImages": {
            "title": "Include Images",
            "type": "boolean",
            "description": "Include all image URLs found on the page",
            "default": false
          },
          "includeLinks": {
            "title": "Include Links",
            "type": "boolean",
            "description": "Include all link URLs found on the page",
            "default": false
          },
          "customHeaders": {
            "title": "Custom Headers",
            "type": "object",
            "description": "Custom HTTP headers to send with the request"
          },
          "cookiejar": {
            "title": "Cookie Jar",
            "type": "array",
            "description": "Array of cookies to set before making the request"
          },
          "localStorage": {
            "title": "Local Storage",
            "type": "object",
            "description": "Local storage data to set in the browser"
          },
          "interceptFetchRequest": {
            "title": "Intercept Fetch Request",
            "type": "string",
            "description": "URL pattern(s) to intercept and return (comma-separated for multiple)"
          },
          "fullPageLoad": {
            "title": "Full Page Load",
            "type": "boolean",
            "description": "Wait for full page load including all resources",
            "default": false
          },
          "timeout": {
            "title": "Timeout (ms)",
            "minimum": 1000,
            "maximum": 600000,
            "type": "integer",
            "description": "Request timeout in milliseconds",
            "default": 300000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}