Skip to main content
Version: 0.6

Quick start

Installation

pip install apify-client

Authentication

To use the Apify API, you need an API token. You can find your token in the Integrations section of Apify Console.

from apify_client import ApifyClient

apify_client = ApifyClient('MY-APIFY-TOKEN')

Running an Actor

The simplest way to run an Actor is to use the call method, which starts the Actor and waits for it to finish.

from apify_client import ApifyClient

apify_client = ApifyClient('MY-APIFY-TOKEN')

# Start an actor and wait for it to finish
actor_call = apify_client.actor('john-doe/my-cool-actor').call()

# Fetch results from the actor's default dataset
dataset_items = apify_client.dataset(actor_call['defaultDatasetId']).list_items().items

Working with datasets

# Get (or create, if it doesn't exist) a dataset with the name of my-dataset
my_dataset = apify_client.datasets().get_or_create(name='my-dataset')

# Append items to the end of the dataset
apify_client.dataset(my_dataset['id']).push_items([{'foo': 1}, {'bar': 2}])

# List items in the dataset
items = apify_client.dataset(my_dataset['id']).list_items().items