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

Uploaded Source

Built Distribution

zyte_api-0.5.1-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: zyte_api-0.5.1.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for zyte_api-0.5.1.tar.gz
Algorithm Hash digest
SHA256 dd36c0c894bf4dbec55bf7842b93eb9ce3c34539367b45f62b407771e4b03979
MD5 9bd3652615c10984149fde5191f33068
BLAKE2b-256 8363c946c6ee201c4fb6067cb261e4079b63d00d240d9692a15a1a8967c102e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: zyte_api-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for zyte_api-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec4ac671bb1f38ce8164c5acbae515c1a756753e78f0dde02d0bedfdf42f890f
MD5 4fe8bc8498ea9472f8f8ea3b78eee72b
BLAKE2b-256 5acace1cf8e33ff5c6e2e7ac309efe94000063b0b86dcc861da10605aa67d8f9

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