Zyte API
A single POST /extract operation that retrieves any public URL through Zyte's automatic ban-avoidance network and returns any combination of raw HTTP body, browser-rendered HTML, screenshots, network captures and AI-extracted structured data (product, productList, article, articleList, jobPosting, forumThread, pageContent, serp and LLM-driven custom attributes). Authenticated with HTTP Basic using a Zyte API key as the username and an empty password. Errors are RFC 9457 problem+json; rate-limiting and failed responses are not charged.
Zyte API is one of 3 APIs that Zyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Crawling, Data Extraction, Scraping, Browser Automation, and Anti-Ban. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes
1 operation
across 1 path,
and defines 102 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.zyte.com/v1.
The identity and technical contract details declared by the specification.
HTTPHeader
object
A header name and value.
2 properties
2 required
ExtractRequest
object
55 properties
1 required
Response200
object
24 properties
1 required
Problem
object
4 properties
ForbiddenDomainProblem
object
1 property
SessionContext
array
User-defined name-value pairs to [request a server-managed session](/zyte-api/usage/features.md) initialized with sessionContextParameters). For every subseque…
SessionContextParameters
object
Parameters to create a server-managed session for a given sessionContext). [See an example](/zyte-api/usage/features.md). See also: actions.
1 property
ActionResult
object
Returns detailed information about the elapsed time and errors for a particular action.
5 properties
3 required
InteractionLogEntry
object
Interaction log entry
3 properties
ActionTimeout
number
Maximum wait time in seconds.
UrlPattern
string
A string to compare with a URL according to urlMatchingOptions.
PatternMatchingOptions
string
How to compare a user-defined string with a target string: - contains matches if the user-defined string is a substring of the target string. - exact matches i…
ActionSelector
object
A CSS or XPath selector to search for an element.
3 properties
2 required
onError
string
Handle errors encountered while executing a particular action. continue - When a particular action fails, the action sequence continues, executing the next act…
ActionSequence
array
Sequence of browser actions to execute. Select an action below to see its API reference. When using actions, you get the actions response field with debug info…
Action
object
Action to perform.
1 property
GoToOptions
object
Used to customise navigation options
2 properties
ScreenshotOptions
object
Options for the screenshot taken when the screenshot request field is true.
2 properties
ExtractionOptions
object
Options for automatic extraction.
2 properties
ExtractFrom
string
[Extraction source](/zyte-api/usage/extract/index.md). httpResponseBody extracts from httpResponseBody. It is usually faster and cheaper. browserHtml extracts…
RequestHeaders
object
HTTP request headers. Can only be used in a [browser request](/zyte-api/usage/browser.md). For [HTTP requests](/zyte-api/usage/http.md), see customHttpRequestH…
1 property
CustomHttpRequestHeader
object
2 properties
Session
object
Parameters to create or reuse a [client-managed session](/zyte-api/usage/features.md). If id does not match one of your running sessions, a new session is crea…
1 property
Cookie
object
8 properties
3 required
PostalAddress
object
Postal address to be set
4 properties
NetworkCaptureFilterSequence
array
Filters to capture browser network responses. HTTP responses received during browser rendering (including action execution) will be returned in the networkCapt…
NetworkCaptureFilter
object
Filter defined in the networkCapture request field that matched the captured response.
2 properties
1 required
UrlFilter
An object specifying how to capture responses by matching URL
ResourceTypeFilter
An object specifying how to capture responses by resource type
CapturedResponse
object
7 properties
Viewport
object
[Browser viewport](https://developer.mozilla.org/en-US/docs/Glossary/Viewport).
2 properties
CountryCode
string
[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2) code of a country from which the request should be sent, i.e. the request [geolocation](/z…
OrganicResult
object
5 properties
Metadata
object
Metadata.
4 properties
OrganicResultURL
string
Result URL.
SearchURL
string
Search URL. Should match url.
SerpOptions
object
Options for SERP extraction.
2 properties
SessionContextActionSequence
array
Actions to run to initialize a server-managed session for a given sessionContext).
CustomAttribute
object
2 properties
CustomAttributeBoolean
object
1 required
CustomAttributeString
1 required
CustomAttributeNumber
object
1 required
CustomAttributeInteger
object
1 required
CustomAttributeArray
object
1 property
2 required
CustomAttributeObject
object
1 property
2 required
Article
object
18 properties
2 required
Author
object
Author of the article.
2 properties
1 required
Breadcrumb
object
Breadcrumb item (a specific navigation element) with optional name and url.
2 properties
Image
object
Image.
1 property
1 required
Metadata__metadata
object
Extracted item metadata for single-item data types.
2 properties
2 required
DateDownloaded
string
The timestamp at which the data was downloaded. Timezone: UTC. Format: ISO 8601 format: "YYYY-MM-DDThh:mm:ssZ"
ArticleList
object
3 properties
2 required
MetadataListItem
object
Item-level metadata for list data types.
1 property
1 required
MetadataList
object
Top-level metadata for list data types.
1 property
1 required
ArticleNavigation
object
5 properties
2 required
PaginationNext
object
A link to the next page in the list.
2 properties
1 required
PageNumber
integer
Integer describing the current page number. Starts at 1.
ForumThread
object
4 properties
2 required
JobPosting
object
12 properties
2 required
JobPostingNavigation
object
5 properties
2 required
PageContent
object
13 properties
2 required
Product
object
27 properties
2 required
Name
string
The name of the product.
Price
string
The price at which the product is being offered. If there is only one price associated with the offer, it is returned in this field.
Currency
string
The ISO 4217 standard of the currency in which the price is in.
CurrencyRaw
string
The currency as given on the website, without extra normalization (for example, both "$" and "USD" are possible currencies).
RegularPrice
string
The price before any discount or special offer.
Availability
string
Availability, as a string. Allowed values: "InStock" - includes limited availability, presale, preorder, and in-store only. "OutOfStock" - includes discontinue…
Sku
string
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for the product - identifier assigned by the seller.  of the product. It is issued by the manufacturer, and is the same across different e-commerce websites.
Gtin
object
Standardized GTIN product identifier which is unique for a product across different sellers.
2 properties
2 required
Color
string
Color of the product.
Size
string
A standardized size of a product, specified through a simple textual string (for example "XL", "32Wx34L"). A single product dimension (height, width) is not co…
Weight
object
3 properties
Style
string
Style of the product. It can also be referred as pattern/finish on the product page. Example values: "Polka dots", "Striped", "Nickel finish with Translucent g…
AdditionalProperty
object
Additional propertiy or characteristics. name field contains the property name, value field contains the property value. 