# Zyte Api

Zyte API is a web scraping solution that automates data extraction from websites, handling challenges like bans and dynamic content.

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `ZYTE_API`
- **Version:** 20260211_00

## Tools

### Fetch Active Scheduled Maintenances

**Slug:** `ZYTE_API_ACTIVE_SCHEDULED_MAINTENANCES`

Retrieves currently active scheduled maintenances that are in 'In Progress' or 'Verifying' state. Use this to check for ongoing maintenance events that may affect Zyte API availability. Returns an empty list if no maintenances are currently active.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zyte API Components

**Slug:** `ZYTE_API_COMPONENTS`

Retrieves all Zyte service components with their current operational status. Returns component details including status (operational, degraded_performance, partial_outage, major_outage), descriptions, groupings, and metadata. Useful for monitoring service health and identifying issues. No parameters required - provides a real-time snapshot of all Zyte infrastructure components.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Data from URL

**Slug:** `ZYTE_API_EXTRACT_ZYTE_API`

Tool to extract data from URLs using Zyte API's HTTP, browser, and AI-powered extraction capabilities. Use when you need to scrape web pages, extract structured data (products, articles, jobs, etc.), capture screenshots, or perform browser automation. Supports geolocation targeting and custom extraction schemas.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Absolute URL to extract data from. Max 8192 characters. Host must be a domain name, not IP address. |
| `serp` | boolean | No | Set to true to extract search engine results page data. Cannot combine with other extraction types. |
| `tags` | object | No | Arbitrary key-value pairs for filtering in Stats API |
| `jobId` | string | No | Scrapy Cloud job ID |
| `ipType` | string ("datacenter" | "residential") | No | Type of IP address to use for the request |
| `actions` | array | No | Browser actions to execute before extraction (click, scroll, type, wait, etc.) |
| `article` | boolean | No | Set to true to extract structured article data using AI |
| `product` | boolean | No | Set to true to extract structured product data using AI |
| `echoData` | object | No | Arbitrary data to be echoed back in response |
| `javascript` | boolean | No | Enable JavaScript execution for browser requests |
| `jobPosting` | boolean | No | Set to true to extract structured job posting data |
| `screenshot` | boolean | No | Set to true to get a screenshot of the page. Can combine with browserHtml or AI extraction. |
| `articleList` | boolean | No | Set to true to extract list of articles |
| `browserHtml` | boolean | No | Set to true to get browser-rendered HTML. Not compatible with httpResponseBody. |
| `forumThread` | boolean | No | Set to true to extract structured forum thread data |
| `geolocation` | string | No | Two-letter country code for geolocation targeting (e.g. US, GB) |
| `pageContent` | boolean | No | Set to true to extract general page content text |
| `productList` | boolean | No | Set to true to extract list of products from category page |
| `serpOptions` | object | No | Options for SERP extraction |
| `articleOptions` | object | No | Common options for data extraction |
| `networkCapture` | array | No | Capture network requests matching URL patterns. Each item has url and optional filterHeaders. |
| `productOptions` | object | No | Common options for data extraction |
| `requestCookies` | array | No | Cookies to send with the request |
| `requestHeaders` | object | No | Browser request headers |
| `sessionContext` | array | No | Session context for maintaining state across requests |
| `httpRequestBody` | string | No | Base64-encoded data to send as request body. Max 400000 characters. |
| `httpRequestText` | string | No | UTF-8 text to send as request body. Alternative to httpRequestBody. |
| `customAttributes` | object | No | Define custom attributes to extract using natural language descriptions |
| `httpResponseBody` | boolean | No | Set to true to get HTTP response body (base64-encoded). Not compatible with browser automation. |
| `articleNavigation` | boolean | No | Set to true to extract article navigation links |
| `httpRequestMethod` | string ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "TRACE" | "PATCH" | "HEAD") | No | HTTP methods for the target request |
| `productNavigation` | boolean | No | Set to true to extract product navigation links |
| `screenshotOptions` | object | No | Options for screenshot capture |
| `productListOptions` | object | No | Common options for data extraction |
| `httpResponseHeaders` | boolean | No | Set to true to get HTTP response headers |
| `jobPostingNavigation` | boolean | No | Set to true to extract job posting navigation links |
| `customAttributesOptions` | object | No | Options for custom attributes extraction |
| `customHttpRequestHeaders` | array | No | Custom HTTP request headers |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get scheduled maintenances

**Slug:** `ZYTE_API_GET_SCHEDULED_MAINTENANCES`

Tool to get the 50 most recent scheduled maintenances (upcoming and completed) from Zyte status API. Use after confirming you need the latest maintenance schedule for monitoring.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Zyte API: Get Unresolved Incidents

**Slug:** `ZYTE_API_GET_UNRESOLVED_INCIDENTS`

Tool to retrieve unresolved incidents from Zyte status API. Use when you need to check currently open incidents.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Zyte API status incidents

**Slug:** `ZYTE_API_LIST_INCIDENTS`

Retrieves the 50 most recent incidents from the Zyte API status page, including both resolved and unresolved incidents. Use this tool to check current API health, review incident history, or get detailed information about service disruptions affecting Zyte services.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zyte API Status Rollup

**Slug:** `ZYTE_API_STATUS`

Retrieves comprehensive operational status for all Zyte services. Returns current status of components (Zyte API, Smart Proxy Manager, Scrapy Cloud, etc.), active incidents, and scheduled maintenance windows. Use this to check service health before making API calls or to diagnose issues.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |