Zyte API usage documentation#

Initial setup#

How would you prefer to use Zyte API?

Scrapy

Use scrapy-zyte-api (tutorial).

Python

Use python-zyte-api.

Other

Use any HTTP client library or program.

POST to https://api.zyte.com/v1/extract with your API key and parameters:

curl \
    --user YOUR_API_KEY: \
    --header 'Content-Type: application/json' \
    --data '{"url": "https://toscrape.com", "httpResponseBody": true}' \
    --compressed \
    "https://api.zyte.com/v1/extract"

Looking for a proxy API?

We are considering offering a proxy API for Zyte API, but we need your feedback to do it right. Please fill this form.

Tip

Got an SSL error? Install our CA certificate.

Basic usage#

What do you want to do with Zyte API?

HTTP requests

Get HTTP responses.

HTTP

Browser automation

Get rendered content.

Browser

Automatic extraction

Get structured data.

Extraction

Additional features#

Customize your Zyte API requests further to get what you want:

Geolocation

Choose a location of origin for your request.

http browser extraction

Cookies

Get and set cookies to reproduce requests and maintain sessions.

http browser extraction

Screenshots

Take a screenshot of a webpage.

browser

Actions

Interact with a webpage.

browser

Advanced topics#

Optimization

Make the most out of Zyte API.

Error handling

Handle rate-limiting and unsuccessful API responses, as well as issues in successful API responses.

API reference

See the complete API reference documentation.