Changelog

3.0.0-rc.0

3.0.0-rc.0 (2026-10-12)

This is the first release candidate of apify-client v3. It's published under the rc dist-tag, and latest stays on 2.x:

npm install apify-client@rc

v3 has a lot of breaking changes, so read the upgrading guide before you switch. If something breaks, please open an issue.

🚀 Features

• [breaking] Generate all output models from the OpenAPI spec (#985) (cc054bf) by @vdusek
• [breaking] Validate API responses with zod schemas generated from the OpenAPI spec (#1016) (118f359) by @vdusek
• [breaking] Add ApifyApiError subclasses grouped by HTTP status (#1041) (e9ff0eb) by @vdusek
• [breaking] Normalize URL fields in responses (#1045) (39bdf71) by @vdusek
• [breaking] Expose the timeout tiers on the public API (#1046) (e50bf2e) by @vdusek
• [breaking] Make the client's own code runtime-independent (#1052) (511191e) by @vdusek
• [breaking] Make request-body compression configurable (#1065) (7878800) by @vdusek
• [breaking] Allow passing a custom HTTP client to ApifyClient (#1058) (ac2fe94) by @vdusek
• Accept an AbortSignal in resource-client methods (#1081) (eba2a21) by @vdusek
• Accept the /v2 API version path in baseUrl and publicBaseUrl (#1077) (a7be6fe) by @vdusek
• Allow format parameter in dataset.createItemsPublicUrl (#1100) (bcf5cf5) by @gullmar
• [breaking] Type Actor input as plain objects, arrays of them, or raw bytes (#1099) (6f4eb0e) by @vdusek
• Add live iteration over a run's dataset items (#1085) (f3ab011) by @vdusek
• Retry starting a run on memory and concurrent-runs limits (#1091) (d7c70ca) by @vdusek
• Add pricingInfos and exampleRunInput to ActorUpdateOptions (#1144) (f62ab4a) by @vdusek

🐛 Bug Fixes

• Prevent path traversal by sanitizing URLs (#1011) (1967561) by @barjin
• [breaking] Correct Actor version, enum and setRecord input types (#1049) (b7b98c4) by @vdusek
• [breaking] Throw on ambiguous 404s instead of resolving to undefined (#1042) (58d18f2) by @vdusek
• [breaking] Type the Actor run input on ActorClient and RunClient (#1040) (a7ce30c) by @vdusek
• [breaking] Bump proxy-agent to v8 to remove the url.parse() deprecation warning (#1050) (0a73a63) by @vdusek
• [breaking] Keep pagination iterators advancing past fully filtered pages (#1044) (ac7dd23) by @vdusek
• [breaking] Convert date fields through the zod schemas instead of the *At suffix heuristic (#1060) (61d07b0) by @vdusek
• Carry the API error body of a failed streaming request (#1055) (ba48ad4) by @vdusek
• [breaking] Narrow pushItems() to the item shapes the API actually accepts (#1066) (5aabe54) by @barjin
• Add missing readme field to Profile model (#1110) (d530997) by @apify-service-account
• Page offset iterators past the first page's total (#1125) (9cd54be) by @vdusek
• Bound StreamedLog.stop() when the log stream is quiet (#1123) (762d34c) by @vdusek
• Stop waitForFinish() polling a job that keeps returning 404 (#1124) (510823e) by @vdusek
• Redirect the run log when the first log stream comes back empty (#1105) (b79b5e5) by @vdusek

🚜 Refactor

• [breaking] Validate arguments with zod instead of ow (#986) (b8fafd9) by @vdusek
• [breaking] Convert to native ESM (#1015) (589a3a7) by @vdusek
• [breaking] Remove all deprecated options (#1039) (d4545d2) by @vdusek
• [breaking] Drop the underscore prefix from non-public members (#1059) (160fdb2) by @vdusek
• [breaking] Drop deprecated top-level restartOnError from ActorUpdateOptions (#1122) (0ba2a7e) by @vdusek
• [breaking] Narrow dataset unwind option to string[] (#1121) (5a379c3) by @vdusek
• [breaking] Align model names with the OpenAPI schemas (#1107) (1bb919d) by @vdusek

⚡ Performance

• Skip request-body compression for already-compressed content types (#1053) (c709586) by @vdusek
• [breaking] Serialize requests once in batchAddRequests (#1051) (bddfd7f) by @vdusek

⚙️ Miscellaneous Tasks

• [breaking] Require Node.js 22 or newer (#984) (97e7720) by @vdusek

2.25.0

2.25.0 (2026-08-11)

🚀 Features

• Add Actor task publication endpoints (#989) (2b66d43) by @Janjiran

🐛 Bug Fixes

• Fall back to gzip when brotli compression is unavailable (#990) (9bee474) by @vdusek

2.24.0

2.24.0 (2026-07-30)

🚀 Features

• Add validateInput method to ActorClient (#957) (3637586) by @Pijukatel
• Compress requests using brotli algo (#962) (6827899) by @mixalturek

🐛 Bug Fixes

• ActorPermissionLevel was missing in ActorCollectionCreateOptions (#940) (4d8125e) by @valekjo
• Fix incomplete type hint of last run/task (#952) (3924ce0) by @Pijukatel
• Align User-Agent OS token with other Apify clients (#964) (1f0e814) by @Pijukatel

2.23.4

2.23.4 (2026-06-04)

🐛 Bug Fixes

• Accept readonly arrays for webhook eventTypes input (#931) (1737867) by @B4nan

2.23.3

2.23.3 (2026-05-11)

🐛 Bug Fixes

• Drop only-allow preinstall, enforce pnpm via devEngines (#895) (27f7b7b) by @B4nan

2.23.2

2.23.2 (2026-05-07)

🐛 Bug Fixes

• Add support for new list request-queue requests parameters (#880) (c5f441b) by @mvolfik

2.23.1

2.23.1 (2026-04-29)

🐛 Bug Fixes

• Make Node-only imports bundler-discoverable (#885) (d57c048) by @barjin

2.23.0

2.23.0 (2026-04-14)

🚀 Features

• Add output schema to ActorDefinition and includeUnrunnableActors to store API (#881) (c965d15) by @jancurn

🐛 Bug Fixes

• Turn any log streaming related errors to warnings (#876) (a3268ee) by @Pijukatel

2.22.3

2.22.3 (2026-03-20)

🚀 Features

• Add the ActorRunStorageIds field to Actor Run responses (#868) (de8d315) by @Pijukatel

🐛 Bug Fixes

• Use production mode and globalThis in browser bundle (#870) (b29c846) by @MartinKristof

2.22.2

2.22.2 (2026-02-20)

🐛 Bug Fixes

• Make all node-specific imports async, ignore in browser bundle (#847) (f61b417) by @barjin

2.22.1

2.22.1 (2026-02-13)

🚀 Features

• Add the new 'ownership' parameter to the storage list methods (#835) (7b328e1) by @nmanerikar
• Add ./browser conditional export (#845) (fab3913) by @barjin
• Add the readmeSummary field to Actor responses (#846) (7d6bb2f) by @janbuchar

2.22.0

2.22.0 (2026-01-27)

🚀 Features

• actor: Add 'taggedBuilds' to ActorUpdateOptions (#830) (c2c3560) by @l2ysho
• actor: Updates ActorStandby type (#833) (10144e8) by @l2ysho

🐛 Bug Fixes

• Align LimitsUpdateOptions type with backend validation logic (#820) (74c1e2a) by @barjin
• Fetch key-value store records as attachments (#821) (2073e69) by @mvolfik

⚡ Performance

• Omit proxy-agent from the browser bundle (#816) (d948b11) by @barjin

2.21.0

2.21.0 (2025-12-11)

🚀 Features

• Add CONNECT tunneling support for HTTP proxy in sandboxed environments (#791) (a27d55a) by @tducret
• Make all collectionClient.list methods return value also be asyncIterator of relevant data (#790) (f855fd4) by @Pijukatel
• Generated JSDocs based on the API reference (#797) (85653a1) by @jancurn
• Make storage clients list methods return value also be asyncIterator of relevant data (#803) (c58ce6f) by @Pijukatel
• Expose actorPermissionLevel in Actor client (#809) (513e41c) by @stepskop

2.20.0

2.20.0 (2025-11-20)

🚀 Features

• Add redirected actor logs (#769) (a7f4233) by @Pijukatel
• Replace agentkeepalive with native Node.js HTTP agents for proxy support (#788) (7d2be0f) by @tducret

🐛 Bug Fixes

• Actor start and run options and doc (#785) (61f91e5) by @michael-apify

⚡ Performance

• Dynamic imports for certain node: packages (#767) (0bf8db7) by @barjin
• Don't bundle node:crypto in the browser bundle (#782) (72a1d3c) by @barjin

2.19.0

2.19.0 (2025-10-20)

🚀 Features

• Move restartOnError from Actor to Run options (#760) (8f80f82) by @DaveHanns

2.18.0

2.18.0 (2025-10-09)

🚀 Features

• Allowed signature to be passed in kv-store/datasets (#761) (a31e36d) by @gippy
• Add startedBefore and startedAfter to run list (#763) (2345999) by @danpoletaev

🐛 Bug Fixes

• Export missing symbols from env vars and version client (#756) (86b591f) by @B4nan

2.17.0

2.17.0 (2025-09-11)

🚀 Features

• Add forcePermissionLevel run option (#743) (693808c) by @tobice

🐛 Bug Fixes

• Signed storage URLs avoid adding expiresInSecs to query params (#734) (70aff4f) by @danpoletaev
• Presigned resource urls shouldn't follow baseUrl (#745) (07b36fb) by @barjin

2.16.0

2.16.0 (2025-08-26)

Refactor

• [breaking] Rename expiresInMillis to expiresInSecs in create storage content URL (#733) (a190b72) by @danpoletaev

2.15.1

2.15.1 (2025-08-20)

🐛 Bug Fixes

• Add recordPublicUrl to KeyValueListItem type (#730) (42dfe64) by @danpoletaev

2.15.0

2.15.0 (2025-08-12)

🚀 Features

• Extend status parameter to an array of possible statuses (#723) (0be893f) by @JanHranicky

2.14.0

2.14.0 (2025-08-11)

🚀 Features

• Add keyValueStore.getRecordPublicUrl (#725) (d84a03a) by @danpoletaev

2.13.0

2.13.0 (2025-08-06)

🚀 Features

• Add new methods Dataset.createItemsPublicUrl & KeyValueStore.createKeysPublicUrl (#720) (62554e4) by @danpoletaev

🐛 Bug Fixes

• Add eventData to WebhookDispatch type (#714) (351f11f) by @valekjo
• KV store createKeysPublicUrl wrong URL (#724) (a48ec58) by @danpoletaev

2.12.6

2.12.6 (2025-06-30)

🚀 Features

• Allow sorting of Actors collection (#708) (562a193) by @protoss70

🐛 Bug Fixes

• Use appropriate timeouts (#704) (b896bf2) by @janbuchar
• Rename option for new sortBy parameter (#711) (f45dd03) by @protoss70

2.12.5

2.12.5 (2025-05-28)

🚀 Features

• List kv store keys by collection of prefix (#688) (be25137) by @MFori
• Add unlockRequests endpoint to RequestQueue client (#700) (7c52c64) by @drobnikj

🐛 Bug Fixes

• Add missing 'effectivePlatformFeatures', 'createdAt', 'isPaying' to User interface (#691) (e138093) by @metalwarrior665
• Move prettier into devDependencies (#695) (1ba903a) by @hudson-worden

2.12.4

2.12.4 (2025-05-13)

🚀 Features

• Allow overriding timeout of KVS.setRecord calls (#692) (105bd68) by @B4nan

🐛 Bug Fixes

• Fix RunCollectionListOptions status type (#681) (8fbcf82) by @MatousMarik
• actor: Add missing 'pricingInfos' field to Actor object (#683) (4bd4853) by @metalwarrior665

2.12.3

2.12.3 (2025-04-24)

🐛 Bug Fixes

• DefaultBuild() returns BuildClient (#677) (8ce72a4) by @danpoletaev

2.12.2

2.12.2 (2025-04-14)

🚀 Features

• Add support for general resource access (#669) (7deba52) by @tobice
• Add defaultBuild method (#668) (c494b3b) by @danpoletaev

2.12.1

2.12.1 (2025-03-11)

🚀 Features

• Add maxItems and maxTotalChargeUsd to resurrect (#652) (5fb9c9a) by @novotnyj

2.11.2

2.11.2 (2025-02-03)

🚀 Features

• Add dataset.statistics (#621) (6aeb2b7) by @MFori
• Added getOpenApiSpecification() to BuildClient (#626) (6248b28) by @danpoletaev

2.11.1

2.11.1 (2025-01-10)

🐛 Bug Fixes

• Change type Build.actorDefinitions to Build.actorDefinition (#624) (611f313) by @jirispilka
• Add ActorRunPricingInfo type (#623) (8880295) by @janbuchar