Skip to main content
PyPI Version Supported Python Versions Build Status Coverage report

Command-line client and Python client library for Zyte API.

Installation

pip install zyte-api

Or, to use x402:

pip install zyte-api[x402]

Basic usage

Set your API key

After you sign up for a Zyte API account, copy your API key.

Use the command-line client

Then you can use the zyte-api command-line client to send Zyte API requests. First create a text file with a list of URLs:

https://books.toscrape.com
https://quotes.toscrape.com

And then call zyte-api from your shell:

zyte-api url-list.txt --api-key YOUR_API_KEY --output results.jsonl

Use the Python sync API

For very basic Python scripts, use the sync API:

from zyte_api import ZyteAPI

client = ZyteAPI(api_key="YOUR_API_KEY")
response = client.get({"url": "https://toscrape.com", "httpResponseBody": True})

Use the Python async API

For asyncio code, use the async API:

import asyncio

from zyte_api import AsyncZyteAPI


async def main():
    client = AsyncZyteAPI(api_key="YOUR_API_KEY")
    response = await client.get(
        {"url": "https://toscrape.com", "httpResponseBody": True}
    )


asyncio.run(main())

Read the documentation for more information.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zyte_api-0.11.0.tar.gz (47.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zyte_api-0.11.0-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file zyte_api-0.11.0.tar.gz.

File metadata

  • Download URL: zyte_api-0.11.0.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for zyte_api-0.11.0.tar.gz
Algorithm Hash digest
SHA256 c7f63f042d7dc0c5c0859c1ee7de7c756478e032832da5424197ae53a3897eca
MD5 35ef3dd160245da32c3974739ddcb384
BLAKE2b-256 c3398b5918b08bf6f8e009348a1be65f7ab462b604bfe27f640b9f8f421acb0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for zyte_api-0.11.0.tar.gz:

Publisher: publish.yml on zytedata/python-zyte-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zyte_api-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: zyte_api-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for zyte_api-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 feb3aa41de10f78557d24c067e0bdbb9206f2d24d7b0097ebf60100269f48d08
MD5 da9de5ff3bb435865bffbfd35e4989fa
BLAKE2b-256 912524affe84b7534eb566a40df343266ebc3db348b06c74cf86c0871cd3de49

See more details on using hashes here.

Provenance

The following attestation bundles were made for zyte_api-0.11.0-py3-none-any.whl:

Publisher: publish.yml on zytedata/python-zyte-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page