Skip to main content

Python interface to Zyte API

Project description

PyPI Version Supported Python Versions Build Status Coverage report

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

Installation

pip install zyte-api

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.

Project details


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.6.0.tar.gz (27.4 kB view details)

Uploaded Source

Built Distribution

zyte_api-0.6.0-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zyte_api-0.6.0.tar.gz
  • Upload date:
  • Size: 27.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for zyte_api-0.6.0.tar.gz
Algorithm Hash digest
SHA256 bebd255f77f536f33d97c3b5f3902a6c72ac1701dbd7b3c6b0021fffb49699e5
MD5 2c9e1df3bf67ecebb987b6bc71edf6ed
BLAKE2b-256 fa5cbb6fcab98894c39fa11d16d23f192249c113bdbd7ce75e839a9938f66e7d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zyte_api-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for zyte_api-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d34057d2d848c9942a2d7aac07134da9597a503e80a2da5089a818dca0405bfa
MD5 0dc7c7f1157aa2e61988b9f3a9d6abe6
BLAKE2b-256 1d8dfd04bb0d73ac4214be318b86d7b1350fe27655d32abbc184525afb0c2920

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page