How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zyte

Zyte Extract API

The Extract API from Zyte — 1 operation(s) for extract.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zyte Extract API is one of 3 APIs that Zyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Extract. 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 94 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.zyte.com/v1.

1 operations 1 paths 94 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.zyte.com/v1
Authentication
HTTP Basic
Contact
Zyte (Formerly Scrapinghub)
Resource Areas
1

Authentication & Security 1

Zyte Extract API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Extract 1
POST
/extract
Process a single URL, return the result
extract body → 200400401403421422429451

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are ExtractRequest (55 properties), Product (27 properties), Response200 (24 properties), Article (18 properties). Each schema is shown below with its type and property counts.

GoToOptions
object
Used to customise navigation options
2 properties
scrollTo
OrganicResultURL
string
Result URL.
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
hide
Viewport
object
[Browser viewport](https://developer.mozilla.org/en-US/docs/Glossary/Viewport).
2 properties
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
HTTPHeader
object
A header name and value.
2 properties 2 required
Color
string
Color of the product.
waitForTimeout
SessionContext
array
User-defined name-value pairs to [request a server-managed session](/zyte-api/usage/features.md) initialized with sessionContextParameters). For every subseque…
JobPosting
object
12 properties 2 required
Action
object
Action to perform.
1 property
Availability
string
Availability, as a string. Allowed values: "InStock" - includes limited availability, presale, preorder, and in-store only. "OutOfStock" - includes discontinue…
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.
SessionContextActionSequence
array
Actions to run to initialize a server-managed session for a given sessionContext).
ActionTimeout
number
Maximum wait time in seconds.
SerpOptions
object
Options for SERP extraction.
2 properties
ExtractionOptions
object
Options for automatic extraction.
2 properties
scrollBottom
ActionResult
object
Returns detailed information about the elapsed time and errors for a particular action.
5 properties 3 required
CurrencyRaw
string
The currency as given on the website, without extra normalization (for example, both "$" and "USD" are possible currencies).
CustomAttribute
object
2 properties
ArticleNavigation
object
5 properties 2 required
Url
string
URL of a page where this product was extracted.
type
ExtractFrom
string
[Extraction source](/zyte-api/usage/extract/index.md). httpResponseBody extracts from httpResponseBody. It is usually faster and cheaper. browserHtml extracts…
Mpn
string
The Manufacturer Part Number (MPN) of the product. It is issued by the manufacturer, and is the same across different e-commerce websites.
waitForSelector
NavigationRequest
object
6 properties 2 required
hover
Weight
object
3 properties
goto
onError
string
Handle errors encountered while executing a particular action. continue - When a particular action fails, the action sequence continues, executing the next act…
click
UrlPattern
string
A string to compare with a URL according to urlMatchingOptions.
Author
object
Author of the article.
2 properties 1 required
waitForResponse
select
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
Gtin
object
Standardized GTIN product identifier which is unique for a product across different sellers.
2 properties 2 required
reload
Metadata__metadata
object
Extracted item metadata for single-item data types.
2 properties 2 required
setLocation
ArticleList
object
3 properties 2 required
CustomHttpRequestHeader
object
2 properties
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…
PostalAddress
object
Postal address to be set
4 properties
AdditionalProperty
object
Additional propertiy or characteristics. name field contains the property name, value field contains the property value. ![](https://docs.zyte.com/static/image…
2 properties 1 required
NetworkCaptureFilter
object
Filter defined in the networkCapture request field that matched the captured response.
2 properties 1 required
ForumThread
object
4 properties 2 required
Name
string
The name of the product.
OrganicResult
object
5 properties
CapturedResponse
object
7 properties
Currency
string
The ISO 4217 standard of the currency in which the price is in.
NetworkCaptureFilterSequence
array
Filters to capture browser network responses. HTTP responses received during browser rendering (including action execution) will be returned in the networkCapt…
SearchURL
string
Search URL. Should match url.
PageContent
object
13 properties 2 required
MetadataListItem
object
Item-level metadata for list data types.
1 property 1 required
PaginationNext
object
A link to the next page in the list.
2 properties 1 required
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…
Problem
object
4 properties
waitForRequest
InteractionLogEntry
object
Interaction log entry
3 properties
Article
object
18 properties 2 required
doubleClick
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…
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…
Response200
object
24 properties 1 required
interaction
ScreenshotOptions
object
Options for the screenshot taken when the screenshot request field is true.
2 properties
PageNumber
integer
Integer describing the current page number. Starts at 1.
Breadcrumb
object
Breadcrumb item (a specific navigation element) with optional name and url.
2 properties
Cookie
object
8 properties 3 required
ProductNavigation
object
8 properties
ExtractRequest
object
55 properties 1 required
RegularPrice
string
The price before any discount or special offer.
Serp
object
4 properties
ActionSelector
object
A CSS or XPath selector to search for an element.
3 properties 2 required
JobPostingNavigation
object
5 properties 2 required
evaluate
ProductList
object
5 properties 2 required
Image
object
Image.
1 property 1 required
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…
searchKeyword
Product
object
27 properties 2 required
Metadata
object
Metadata.
4 properties
MetadataList
object
Top-level metadata for list data types.
1 property 1 required
Sku
string
The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for the product - identifier assigned by the seller. ![](https://docs.zyte.com/static/images/…
ForbiddenDomainProblem
object
1 property
waitForNavigation
DateDownloaded
string
The timestamp at which the data was downloaded. Timezone: UTC. Format: ISO 8601 format: "YYYY-MM-DDThh:mm:ssZ"
keyPress
CanonicalUrl
string
Canonical URL of the product, if available.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zyte-extract-api-openapi.yml Raw ↑

Other APIs Zyte publishes across the network.

Scrapy Cloud API
AE Profile APIs.io
Zyte Stats API
AE Profile APIs.io
#Extract
← Back to Z APIs
API Details
ID
zyte:zyte-extract-api
Base URL
https://api.zyte.com/v1
Docs
https://www.zyte.com/zyte-api/
Provider
Zyte
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zyte-extract-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zyte-extract-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Zyte Extract API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.