Overview

Copy for LLM

The Apify SDK for Python is the official library for creating Apify Actors using Python.

import httpx
from bs4 import BeautifulSoup

from apify import Actor


async def main() -> None:
    async with Actor:
        actor_input = await Actor.get_input()
        async with httpx.AsyncClient() as client:
            response = await client.get(actor_input['url'])
        soup = BeautifulSoup(response.content, 'html.parser')
        data = {
            'url': actor_input['url'],
            'title': soup.title.string if soup.title else None,
        }
        await Actor.push_data(data)

What are Actors?

Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.

Actors can be executed locally or on the Apify platform, which provides features for running them at scale, monitoring, scheduling, and even publishing and monetizing them.

If you're new to Apify, refer to the Apify platform documentation to learn what Apify is.

Quick start

To create and run Actors using Apify Console, check out Apify Console documentation. For creating and running Python Actors locally, refer to the quick start guide.

Explore the Guides section in the sidebar for a deeper understanding of the SDK's features and best practices.

Installation

The Apify SDK for Python requires Python version 3.9 or above. It is typically installed when you create a new Actor project using the Apify CLI. To install it manually in an existing project, use:

pip install apify

API client alternative

If you need to interact with the Apify API programmatically without creating Actors, use the Apify API client for Python instead.