Changelog

All notable changes to this project will be documented in this file.

2.2.1 (2025-10-20)

🐛 Bug Fixes

• Move restart on error Actor option to Run options (#508) (8f73420) by @DaveHanns

2.2.0 (2025-10-13)

🚀 Features

• Add KeyValueStoreClient(Async).get_record_public_url (#506) (6417d26) by @Pijukatel, closes #497
• Add started_before and started_after to run list (#513) (3aaa056) by @danpoletaev

2.1.0 (2025-09-15)

🚀 Features

• Add forcePermissionLevel run option (#498) (b297523) by @tobice

🐛 Bug Fixes

• Casing in exclusiveStartKey API param (#495) (5e96f71) by @barjin, closes #484
• Presigned resource urls shouldn't follow base url (#500) (b224218) by @Pijukatel, closes #496

2.0.0 (2025-08-15)

• Check out the Upgrading guide to ensure a smooth update.

🚀 Features

• Extend status parameter to an array of possible statuses (#455) (76f6769) by @JanHranicky
• Expose apify_client.errors module (#468) (c0cc147) by @Mantisus, closes #158
• Add dataset.create_items_public_url and key_value_store.create_keys_public_url (#453) (2b1e110) by @danpoletaev

Chore

• [breaking] Bump minimum Python version to 3.10 (#469) (92b4789) by @vdusek

Refactor

• [breaking] Remove support for passing a single string to the unwind parameter in DatasetClient (#467) (e8aea2c) by @Mantisus, closes #255
• [breaking] Remove deprecated constant re-exports from consts.py (#466) (7731f0b) by @Mantisus, closes #163
• [breaking] Replace httpx HTTP client with impit (#456) (1df6792) by @Mantisus
• [breaking] Remove deprecated as_bytes and as_file parameters from KeyValueStoreClient.get_record (#463) (b880231) by @Mantisus
• [breaking] Remove parse_response arg from the call method (#462) (840d51a) by @Mantisus, closes #166

1.12.2 (2025-08-08)

🐛 Bug Fixes

• Fix API error with stream (#459) (0c91ca5) by @Pijukatel

1.12.1 (2025-07-30)

🐛 Bug Fixes

• Restrict apify-shared version (#447) (22cd220) by @vdusek

1.12.0 (2025-06-26)

🚀 Features

• Allow sorting of Actors collection (#422) (df6e47d) by @protoss70
• Add KeyValueStoreClient.record_exists (#427) (519529b) by @janbuchar

🐛 Bug Fixes

• Enable to add headers template in webhooks created dynamically (#419) (b84d1ec) by @gaelloyoly
• Rename sortBy parameters option (#426) (a270409) by @protoss70

1.11.0 (2025-06-13)

🚀 Features

• Add validate_input endpoint (#396) (1c5bf85) by @Pijukatel, closes #151
• Add list kv store keys by collection or prefix (#397) (6747c20) by @MFori
• Add redirected actor logs (#403) (fd02cd8) by @Pijukatel, closes #402
• Add unlock_requests method to RequestQueue clients (#408) (d4f0018) by @drobnikj
• Add StatusMessageWatcher (#407) (a535512) by @Pijukatel, closes #404

1.10.0 (2025-04-29)

🚀 Features

• Add support for general resource access (#394) (cc79c30) by @tobice

1.9.4 (2025-04-24)

🐛 Bug Fixes

• Default_build() returns BuildClient (#389) (8149052) by @danpoletaev

1.9.3 (2025-04-14)

🚀 Features

• Add maxItems and maxTotalChargeUsd to resurrect (#360) (a020807) by @novotnyj
• Add get default build method (#385) (f818b95) by @danpoletaev

1.9.2 (2025-02-14)

🐛 Bug Fixes

• Add missing PPE-related Actor parameters (#351) (75b1c6c) by @janbuchar

1.9.1 (2025-02-07)

🐛 Bug Fixes

• Add stats attribute for ApifyClientAsync (#348) (6631f8c) by @Mantisus
• Fix return type of charge API call (#350) (28102fe) by @janbuchar

1.9.0 (2025-02-04)

🚀 Features

• Add user.update_limits (#279) (7aed9c9) by @MFori, closes #329
• Add charge method to the run client for "pay per event" (#304) (3bd6bbb) by @Jkuzz
• Add error data to ApifyApiError (#314) (df2398b) by @Pijukatel, closes #306
• Add GET: dataset.statistics (#324) (19ea4ad) by @MFori
• Add get_open_api_specification method to BuildClient (#336) (9ebcedb) by @danpoletaev
• Add rate limit statistics (#343) (f35c68f) by @Mantisus

1.8.1 (2024-09-17)

🐛 Bug Fixes

• Batch add requests can handle more than 25 requests (#268) (9110ee0) by @vdusek, closes #264

1.8.0 (2024-08-30)

• drop support for Python 3.8

🚀 Features

• Adds headers_template to webhooks and webhooks_collection (#239) (6dbd781) by @jakerobers
• Add actor standby (#248) (dd4bf90) by @jirimoravcik
• Allow passing list of fields to unwind parameter (#256) (036b455) by @fnesveda

1.7.1 (2024-07-11)

🐛 Bug Fixes

• Fix breaking change (sync -> async) in 1.7.0
• Fix getting storages of last run

1.7.0 (2024-05-20)

🐛 Bug Fixes

• Fix abort of last task run
• Fix abort of last Actor run
• ActorClient's and TaskClient's last_run methods are asynchronous

1.6.4 (2024-02-27)

🚀 Features

• Add monthlyUsage() and limits() methods to UserClient

1.6.3 (2023-02-16)

🚀 Features

• Add log() method to BuildClient

1.6.2 (2023-01-08)

Chore

• Relative imports were replaced for absolute imports

1.6.1 (2023-12-11)

🐛 Bug Fixes

• Fix _BaseHTTPClient._parse_params() method to ensure correct conversion of API list parameters

1.6.0 (2023-11-16)

Chore

• Migrate from Autopep8 and Flake8 to Ruff

1.5.0 (2023-10-18)

🚀 Features

• Add support for Python 3.12
• Add DELETE to Actor runs
• Add DELETE to Actor builds

Chore

• Rewrite documentation publication to use Docusaurus
• Remove PR Toolkit workflow

1.4.1 (2023-09-06)

🚀 Features

• Add StoreCollectionClient for listing Actors in the Apify Store
• Add support for specifying the max_items parameter for pay-per result Actors and their runs

Chore

• Improve logging of HTTP requests
• Remove pytest-randomly Pytest plugin

1.4.0 (2023-08-23)

🚀 Features

• Add RunClient.reboot method to reboot Actor runs

Chore

• Simplify code via flake8-simplify
• Unify indentation in configuration files

1.3.1 (2023-07-28)

Chore

• Start importing general constants and utilities from the apify-shared library

1.3.0 (2023-07-24)

🚀 Features

• Add list_and_lock_head, delete_request_lock, prolong_request_lock methods to RequestQueueClient
• Add batch_add_requests, batch_delete_requests, list_requests methods RequestQueueClient

1.2.2 (2023-05-31)

🐛 Bug Fixes

• Fix encoding webhook lists in request parameters

1.2.1 (2023-05-23)

🐛 Bug Fixes

• Relax dependency requirements to improve compatibility with other libraries

1.2.0 (2023-05-23)

🚀 Features

• Add option to change the build, memory limit and timeout when resurrecting a run

Chore

• Update dependencies

1.1.1 (2023-05-05)

Chore

• Change GitHub workflows to use new secrets

1.1.0 (2023-05-05)

🚀 Features

• Add support for is_status_message_terminal flag in Actor run status message update

Chore

• Switch from setup.py to pyproject.toml for specifying project setup

1.0.0 (2023-03-13)

Breaking changes

• Drop support for Python 3.7, add support for Python 3.11
• Unify methods for streaming resources
• Switch underlying HTTP library from requests to httpx

🚀 Features

• Add support for asynchronous usage via ApifyClientAsync
• Add configurable socket timeout for requests to the Apify API
• Add py.typed file to signal type checkers that this package is typed
• Add method to update status message for a run
• Add option to set up webhooks for Actor builds
• Add logger with basic debugging info
• Add support for schema parameter in get_or_create method for datasets and key-value stores
• Add support for title parameter in task and schedule methods
• Add x-apify-workflow-key header support
• Add support for flatten and view parameters in dataset items methods
• Add support for origin parameter in Actor/task run methods
• Add clients for Actor version environment variables

🐛 Bug Fixes

• Disallow NaN and Infinity values in JSONs sent to the Apify API

Chore

• Simplify retrying with exponential backoff
• Improve checks for "not found" errors
• Simplify flake8 config
• Update development dependencies
• Simplify development scripts
• Update GitHub Actions versions to fix deprecations
• Unify unit test style
• Unify preparing resource representation
• Update output management in GitHub Workflows to fix deprecations
• Improve type hints across codebase
• Add option to manually publish the package with a workflow dispatch
• Add pre-commit to run code quality checks before committing
• Convert unittest-style tests to pytest-style tests
• Backport project setup improvements from apify-sdk-python

0.6.0 (2022-06-27)

Removed

• Drop support for single-file Actors

Chore

• Update dependencies
• Fix some lint issues in shell scripts and setup.py
• Add Python 3.10 to unit test roster

0.5.0 (2021-09-16)

Changed

• Improve retrying broken API server connections

🐛 Bug Fixes

• Fix timeout value in actively waiting for a run to finish

Chore

• Update development dependencies

0.4.0 (2021-09-07)

Changed

• Improve handling of Enum arguments
• Improve support for storing more data types in key-value stores

🐛 Bug Fixes

• Fix values of some ActorJobStatus Enum members

0.3.0 (2021-08-26)

🚀 Features

• Add the test() method to the webhook client
• Add support for indicating the pagination direction in the ListPage objects

Changed

• Improve support for storing more data types in datasets

🐛 Bug Fixes

• Fix return type in the DatasetClient.list_items() method docs

Chore

• Add human-friendly names to the jobs in Github Action workflows
• Update development dependencies

0.2.0 (2021-08-09)

🚀 Features

• Add the gracefully parameter to the "Abort run" method

Changed

• Replace base_url with api_url in the client constructor to enable easier passing of the API server url from environment variables available to Actors on the Apify platform

Chore

• Change tags for Actor images with this client on Docker Hub to be aligned with the Apify SDK Node.js images
• Update the requests dependency to 2.26.0
• Update development dependencies

0.1.0 (2021-08-02)

Changed

• Methods using specific option values for arguments now use well-defined and documented Enums for those arguments instead of generic strings
• Make the submodule apify_client.consts containing those Enums available

Chore

• Update development dependencies
• Enforce unified use of single quotes and double quotes
• Add repository dispatch to build Actor images with this client when publishing a new version

0.0.1 (2021-05-13)

• Initial release of the package.