AdsCrawl · Schema

SpaRequest

CompanyBrowser AutomationWebDataExtractionPlaywrightPuppeteerChrome DevTools Protocol

Properties

Name Type Description
viewport object
locale string
timezoneId string
geolocation object
proxy object
countryCode string GLOBAL or a two-letter region code; cannot be combined with proxy.
userAgent string
userAgentMode string
userAgentOs string
fingerprint object
cookies array
url string Public HTTP(S) URL on port 80 or 443; template-specific rules may apply.
waitUntil string Navigation readiness. networkidle may time out on long-polling pages.
timeoutMs number Positive timeout up to 3600000 ms; invalid values use the server default.
keyword string For google-trends-explore, 1-5 unique comma-separated keywords, each at most 100 Unicode characters.
mode string
template string
parameters object
waitFor object
actions array
fields object
schema object Legacy field mapping (string selectors or field objects), optionally wrapped in properties. Used only if fields is absent.
View JSON Schema on GitHub

JSON Schema

adscrawl-spa-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adscrawl/main/json-schema/adscrawl-spa-request-schema.json",
  "title": "SpaRequest",
  "x-generated": "2026-10-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adscrawl-openapi.yaml#/components/schemas/SpaRequest",
  "allOf": [
    {
      "$ref": "#/$defs/TaskOptions"
    },
    {
      "type": "object",
      "properties": {
        "keyword": {
          "type": "string",
          "description": "For google-trends-explore, 1-5 unique comma-separated keywords, each at most 100 Unicode characters."
        },
        "mode": {
          "type": "string",
          "enum": [
            "inspect",
            "extract"
          ]
        },
        "template": {
          "type": "string"
        },
        "parameters": {
          "type": "object",
          "additionalProperties": true
        },
        "waitFor": {
          "$ref": "#/$defs/WaitFor"
        },
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Action"
          }
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/ExtractionField"
          }
        },
        "schema": {
          "type": "object",
          "description": "Legacy field mapping (string selectors or field objects), optionally wrapped in properties. Used only if fields is absent.",
          "additionalProperties": true
        }
      }
    }
  ],
  "$defs": {
    "Action": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "type",
            "milliseconds"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "wait"
              ]
            },
            "milliseconds": {
              "type": "number"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "type",
            "selector"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "waitForSelector"
              ]
            },
            "selector": {
              "type": "string"
            },
            "timeoutMs": {
              "type": "number"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "type",
            "selector"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "click"
              ]
            },
            "selector": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "type",
            "selector",
            "value"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "fill"
              ]
            },
            "selector": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "type",
            "selector",
            "key"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "press"
              ]
            },
            "selector": {
              "type": "string"
            },
            "key": {
              "type": "string"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "type"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "scroll"
              ]
            },
            "selector": {
              "type": "string"
            },
            "x": {
              "type": "number"
            },
            "y": {
              "type": "number"
            }
          }
        }
      ]
    },
    "BrowserSettings": {
      "type": "object",
      "description": "Reusable browser options. proxy and countryCode cannot be supplied together. Browser tasks and temporary CDP sessions use a managed proxy when selection is omitted. Cloud browser API-key starts have stricter top-level custom proxy requirements described on their operations.",
      "properties": {
        "viewport": {
          "$ref": "#/$defs/Viewport"
        },
        "locale": {
          "type": "string"
        },
        "timezoneId": {
          "type": "string"
        },
        "geolocation": {
          "$ref": "#/$defs/Geolocation"
        },
        "proxy": {
          "$ref": "#/$defs/Proxy"
        },
        "countryCode": {
          "type": "string",
          "description": "GLOBAL or a two-letter region code; cannot be combined with proxy."
        },
        "userAgent": {
          "type": "string"
        },
        "userAgentMode": {
          "type": "string",
          "enum": [
            "custom",
            "random"
          ]
        },
        "userAgentOs": {
          "type": "string",
          "enum": [
            "windows",
            "macos"
          ]
        },
        "fingerprint": {
          "$ref": "#/$defs/Fingerprint"
        },
        "cookies": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Cookie"
          }
        }
      }
    },
    "Cookie": {
      "type": "object",
      "required": [
        "name",
        "domain"
      ],
      "description": "Preset browser cookie. Use native JSON booleans. Legacy browser-task inputs also accept compatibility forms for some flags. Launch defaults an omitted value to an empty string. Expiry aliases are Unix seconds.",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "value": {
          "type": "string",
          "default": ""
        },
        "domain": {
          "type": "string",
          "minLength": 1
        },
        "path": {
          "type": "string",
          "default": "/"
        },
        "secure": {
          "type": "boolean"
        },
        "httpOnly": {
          "type": "boolean"
        },
        "hostOnly": {
          "type": "boolean"
        },
        "sameSite": {
          "type": "string",
          "enum": [
            "Strict",
            "Lax",
            "None"
          ]
        },
        "session": {
          "type": "boolean"
        },
        "expires": {
          "type": "number"
        },
        "expirationDate": {
          "type": "number"
        },
        "expiry": {
          "type": "number"
        }
      }
    },
    "ExtractionField": {
      "type": "object",
      "required": [
        "source"
      ],
      "properties": {
        "source": {
          "type": "string",
          "enum": [
            "dom",
            "network"
          ]
        },
        "selector": {
          "type": "string"
        },
        "value": {
          "type": "string",
          "enum": [
            "text",
            "html",
            "attribute"
          ],
          "default": "text"
        },
        "attribute": {
          "type": "string"
        },
        "urlIncludes": {
          "type": "string"
        },
        "path": {
          "type": "string",
          "description": "JSON path for a matching network response."
        },
        "multiple": {
          "type": "boolean"
        },
        "parse": {
          "type": "string",
          "enum": [
            "string",
            "number",
            "integer",
            "boolean",
            "json"
          ]
        },
        "regex": {
          "type": "string"
        },
        "required": {
          "type": "boolean"
        }
      }
    },
    "Fingerprint": {
      "type": "object",
      "description": "Browser fingerprint modes. Defaults and supported combinations depend on the workflow; the server maintains a coherent identity and seed.",
      "properties": {
        "webRtc": {
          "type": "string",
          "enum": [
            "forward",
            "real",
            "disabled"
          ]
        },
        "webGl": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "webGpu": {
          "type": "string",
          "enum": [
            "random",
            "real",
            "disabled"
          ]
        },
        "webGlImage": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "canvas": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "audioContext": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "clientRects": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "speechVoices": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "fonts": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "hardware": {
          "type": "string",
          "enum": [
            "random",
            "real"
          ]
        },
        "doNotTrack": {
          "type": "string",
          "enum": [
            "random",
            "enabled",
            "disabled"
          ]
        },
        "hardwareConcurrency": {
          "type": "integer",
          "minimum": 1,
          "maximum": 64
        },
        "deviceMemory": {
          "type": "integer",
          "minimum": 1,
          "maximum": 64
        }
      }
    },
    "Geolocation": {
      "type": "object",
      "required": [
        "latitude",
        "longitude"
      ],
      "properties": {
        "latitude": {
          "type": "number"
        },
        "longitude": {
          "type": "number"
        }
      }
    },
    "Proxy": {
      "type": "object",
      "description": "Use server OR protocol/host/port. server must be an http:// or socks5:// URL with an explicit port, without embedded credentials, query, fragment, or non-root path. Port range is 1-65535. Provide both non-empty username and password, or omit both. Custom proxy and countryCode are mutually exclusive. Proxy failures never fall back to a direct connection.",
      "properties": {
        "server": {
          "type": "string"
        },
        "protocol": {
          "type": "string",
          "enum": [
            "http",
            "socks5"
          ]
        },
        "host": {
          "type": "string"
        },
        "port": {
          "oneOf": [
            {
              "type": "integer",
              "minimum": 1,
              "maximum": 65535
            },
            {
              "type": "string",
              "pattern": "^[0-9]+$"
            }
          ]
        },
        "username": {
          "type": "string",
          "minLength": 1,
          "writeOnly": true
        },
        "password": {
          "type": "string",
          "minLength": 1,
          "writeOnly": true
        }
      },
      "oneOf": [
        {
          "required": [
            "server"
          ],
          "not": {
            "required": [
              "host"
            ]
          }
        },
        {
          "required": [
            "protocol",
            "host",
            "port"
          ],
          "not": {
            "required": [
              "server"
            ]
          }
        }
      ]
    },
    "TaskOptions": {
      "allOf": [
        {
          "$ref": "#/$defs/BrowserSettings"
        },
        {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "description": "Public HTTP(S) URL on port 80 or 443; template-specific rules may apply."
            },
            "waitUntil": {
              "type": "string",
              "enum": [
                "load",
                "domcontentloaded",
                "networkidle"
              ],
              "description": "Navigation readiness. networkidle may time out on long-polling pages."
            },
            "timeoutMs": {
              "type": "number",
              "description": "Positive timeout up to 3600000 ms; invalid values use the server default."
            }
          }
        }
      ]
    },
    "Viewport": {
      "type": "object",
      "required": [
        "width",
        "height"
      ],
      "properties": {
        "width": {
          "type": "number"
        },
        "height": {
          "type": "number"
        }
      }
    },
    "WaitFor": {
      "type": "object",
      "properties": {
        "selector": {
          "type": "string"
        },
        "text": {
          "type": "string"
        },
        "timeoutMs": {
          "type": "number",
          "default": 15000
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/adscrawl-spa-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.