zyte_web_extract

Zyte-API-compatible web scraping and structured data extraction supporting automatic product, article, job posting, SERP, and pageContent schemas, custom CSS selectors, raw HTML/headers, and optional Zyte API browser rendering/screenshots.

When to use

Use when an agent needs structured e-commerce product, news article, job posting, SERP, or custom CSS-selector extraction from a webpage, with optional Zyte API headless browser rendering and anti-bot handling when ZYTE_API_KEY is configured.

Selection guidance

Role: supporting. Use when an agent needs structured e-commerce product, news article, job posting, SERP, or custom CSS-selector extraction from a webpage, with optional Zyte API headless browser rendering and anti-bot handling when ZYTE_API_KEY is configured.

Use cases

Access

Price: $0.10 USD per call. Payment options are deployment-configured; inspect /api/v1/payment-methods. Prices and payment semantics are unchanged from the canonical registry.

Get the full result

0.10 USD per call

Save with Monthly Plans & API Key Billing: Pay $0.10 per call, or get an instant API key at https://api.rafidsystem.com/get-started and save with monthly plans starting at $10/mo (1,000 calls) and Growth $50/mo (10,000 calls). See https://api.rafidsystem.com/api/v1/subscription-plans. View monthly plans · Payment methods
Try free preview · limited information, no charge
curl -X POST 'https://api.rafidsystem.com/api/v1/preview/zyte_web_extract' -H 'Content-Type: application/json' --data '{"url":"https://example.com","extractType":"auto","includeMarkdown":true}'
Pay with USDC · request an x402 challenge
curl -X POST 'https://api.rafidsystem.com/api/v1/x402/websites/zyte-extract' -H 'Content-Type: application/json' --data '{"url":"https://example.com","extractType":"auto","includeMarkdown":true}'
Authorized x402 client · signed retry request
curl -X POST 'https://api.rafidsystem.com/api/v1/x402/websites/zyte-extract' -H 'Content-Type: application/json' -H 'PAYMENT-SIGNATURE: <PAYMENT_SIGNATURE_FROM_AUTHORIZED_CLIENT>' -H 'X-Rafid-Payment-Journey: <PAYMENT_JOURNEY_FROM_CHALLENGE>' -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' --data '{"url":"https://example.com","extractType":"auto","includeMarkdown":true}'

Use an x402-compatible client to parse PAYMENT-REQUIRED and authorize payment before retrying the same input with PAYMENT-SIGNATURE. Copying a request does not pay.

No crypto wallet? Use Rafid Credits
curl -X POST 'https://api.rafidsystem.com/api/v1/websites/zyte-extract' -H 'Content-Type: application/json' -H 'Authorization: Bearer <RAFID_API_KEY>' -H 'X-Rafid-Payment-Method: credits' -H 'Idempotency-Key: <UNIQUE_REQUEST_ID>' -H 'X-Rafid-Payment-Journey: <PAYMENT_JOURNEY_FROM_CHALLENGE>' --data '{"url":"https://example.com","extractType":"auto","includeMarkdown":true}'

Create an API key instantly via POST https://api.rafidsystem.com/api/v1/account/signup or at https://api.rafidsystem.com/get-started, then fund by card (Stripe) or USDC and save with monthly plans ($10–$500/mo).

Existing account balance: GET https://api.rafidsystem.com/api/v1/account/balance.

MCP Credits integration
POST https://api.rafidsystem.com/mcp/credits
Authorization: Bearer <OAUTH_ACCESS_TOKEN>
Idempotency-Key: <UNIQUE_REQUEST_ID>
Content-Type: application/json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "zyte_web_extract",
    "arguments": {
      "url": "https://example.com",
      "extractType": "auto",
      "includeMarkdown": true
    }
  }
}

OAuth metadata: authorization server · protected resource. Operator authorization and an existing funded account are required; OAuth does not grant credits.

Payment instructions and onboarding · API docs and schemas

These are copyable API integration requests. They do not open a checkout or execute a paid tool.

Related tools

Example input

{
  "url": "https://example.com",
  "extractType": "auto",
  "includeMarkdown": true
}

Example output

{
  "url": "https://example.com",
  "finalUrl": "https://example.com/",
  "statusCode": 200,
  "provider": "native_http",
  "extractType": "auto",
  "detectedPageType": "pageContent",
  "title": "Example Domain",
  "description": null,
  "language": "en",
  "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples in documents.",
  "httpResponseBody": null,
  "httpResponseHeaders": null,
  "browserHtml": null,
  "screenshotBase64": null,
  "product": null,
  "article": null,
  "jobPosting": null,
  "serp": null,
  "pageContent": {
    "headings": [
      "Example Domain"
    ],
    "images": [],
    "contacts": {
      "emails": [],
      "phones": []
    },
    "wordCount": 12
  },
  "selectors": null,
  "links": [],
  "warnings": []
}

Input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "format": "uri"
    },
    "extractType": {
      "type": "string",
      "enum": [
        "auto",
        "product",
        "article",
        "jobPosting",
        "serp",
        "pageContent"
      ]
    },
    "httpResponseBody": {
      "type": "boolean"
    },
    "httpResponseHeaders": {
      "type": "boolean"
    },
    "browserHtml": {
      "type": "boolean"
    },
    "screenshot": {
      "type": "boolean"
    },
    "geolocation": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$"
    },
    "customHttpRequestHeaders": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64
          },
          "value": {
            "type": "string",
            "maxLength": 512
          }
        },
        "required": [
          "name",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "selectors": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "additionalProperties": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "includeMarkdown": {
      "type": "boolean"
    },
    "includeLinks": {
      "type": "boolean"
    },
    "maxLinks": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "fields": {
      "minItems": 1,
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    },
    "outputSchema": {
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 1,
        "maxLength": 80
      },
      "additionalProperties": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      }
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false
}

Output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "url": {
      "type": "string"
    },
    "finalUrl": {
      "type": "string"
    },
    "statusCode": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "provider": {
      "type": "string",
      "enum": [
        "zyte_api",
        "native_http"
      ]
    },
    "extractType": {
      "type": "string",
      "enum": [
        "auto",
        "product",
        "article",
        "jobPosting",
        "serp",
        "pageContent"
      ]
    },
    "detectedPageType": {
      "type": "string",
      "enum": [
        "product",
        "article",
        "jobPosting",
        "serp",
        "pageContent"
      ]
    },
    "title": {
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "language": {
      "type": [
        "string",
        "null"
      ]
    },
    "markdown": {
      "type": "string"
    },
    "httpResponseBody": {
      "type": [
        "string",
        "null"
      ]
    },
    "httpResponseHeaders": {
      "anyOf": [
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "string"
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "browserHtml": {
      "type": [
        "string",
        "null"
      ]
    },
    "screenshotBase64": {
      "type": [
        "string",
        "null"
      ]
    },
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "type": [
                "string",
                "null"
              ]
            },
            "price": {
              "type": [
                "string",
                "null"
              ]
            },
            "currency": {
              "type": [
                "string",
                "null"
              ]
            },
            "availability": {
              "type": [
                "string",
                "null"
              ]
            },
            "sku": {
              "type": [
                "string",
                "null"
              ]
            },
            "brand": {
              "type": [
                "string",
                "null"
              ]
            },
            "description": {
              "type": [
                "string",
                "null"
              ]
            },
            "images": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "ratingValue": {
              "type": [
                "number",
                "null"
              ]
            },
            "reviewCount": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "name",
            "price",
            "currency",
            "availability",
            "sku",
            "brand",
            "description",
            "images",
            "ratingValue",
            "reviewCount"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "article": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "headline": {
              "type": [
                "string",
                "null"
              ]
            },
            "author": {
              "type": [
                "string",
                "null"
              ]
            },
            "datePublished": {
              "type": [
                "string",
                "null"
              ]
            },
            "dateModified": {
              "type": [
                "string",
                "null"
              ]
            },
            "articleBody": {
              "type": [
                "string",
                "null"
              ]
            },
            "images": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "headline",
            "author",
            "datePublished",
            "dateModified",
            "articleBody",
            "images"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "jobPosting": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "title": {
              "type": [
                "string",
                "null"
              ]
            },
            "hiringOrganization": {
              "type": [
                "string",
                "null"
              ]
            },
            "jobLocation": {
              "type": [
                "string",
                "null"
              ]
            },
            "salary": {
              "type": [
                "string",
                "null"
              ]
            },
            "employmentType": {
              "type": [
                "string",
                "null"
              ]
            },
            "datePosted": {
              "type": [
                "string",
                "null"
              ]
            },
            "validThrough": {
              "type": [
                "string",
                "null"
              ]
            },
            "description": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "title",
            "hiringOrganization",
            "jobLocation",
            "salary",
            "employmentType",
            "datePosted",
            "validThrough",
            "description"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "serp": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "query": {
              "type": [
                "string",
                "null"
              ]
            },
            "organicResults": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "rank": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 9007199254740991
                  },
                  "name": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  },
                  "description": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "rank",
                  "name",
                  "url",
                  "description"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "query",
            "organicResults"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "pageContent": {
      "type": "object",
      "properties": {
        "headings": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "images": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "contacts": {
          "type": "object",
          "properties": {
            "emails": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "phones": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "emails",
            "phones"
          ],
          "additionalProperties": false
        },
        "wordCount": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "headings",
        "images",
        "contacts",
        "wordCount"
      ],
      "additionalProperties": false
    },
    "selectors": {
      "anyOf": [
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string"
          },
          "href": {
            "type": "string"
          }
        },
        "required": [
          "text",
          "href"
        ],
        "additionalProperties": false
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tableRow": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "url",
    "finalUrl",
    "statusCode",
    "provider",
    "extractType",
    "detectedPageType",
    "title",
    "description",
    "language",
    "markdown",
    "httpResponseBody",
    "httpResponseHeaders",
    "browserHtml",
    "screenshotBase64",
    "product",
    "article",
    "jobPosting",
    "serp",
    "pageContent",
    "selectors",
    "links",
    "warnings"
  ],
  "additionalProperties": false
}

Category: Website Intelligence · hierarchy: supporting · idempotent: yes · side effects: no