Skip to main content
Version: Next

StoreCollectionClient

Sub-client for the Apify store collection.

Provides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate method on the ApifyClient class.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None

  • Initialize the resource client.

    Parameters

    • keyword-onlybase_url: str

      API base URL.

    • keyword-onlypublic_base_url: str

      Public CDN base URL.

    • keyword-onlyhttp_client: HttpClient

      HTTP client for making requests.

    • keyword-onlyresource_path: str

      Resource endpoint path (e.g., 'actors', 'datasets').

    • keyword-onlyclient_registry: ClientRegistry

      Bundle of client classes for dependency injection.

    • optionalkeyword-onlyresource_id: str | None = None

      Optional resource ID for single-resource clients.

    • optionalkeyword-onlyparams: dict | None = None

      Optional default parameters for all requests.

    Returns None

iterate

  • iterate(*, limit, offset, search, sort_by, category, username, pricing_model, timeout): Iterator[StoreListActor]

  • Iterate over Actors in Apify store.

    Simple list does only one API call, possibly not listing all items matching the criteria. This method returns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.

    https://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store

    Parameters

    • optionalkeyword-onlylimit: int | None = None

      How many Actors to list.

    • optionalkeyword-onlyoffset: int | None = None

      What Actor to include as first when retrieving the list.

    • optionalkeyword-onlysearch: str | None = None

      String to search by. The search runs on the following fields: title, name, description, username, readme.

    • optionalkeyword-onlysort_by: str | None = None

      Specifies the field by which to sort the results.

    • optionalkeyword-onlycategory: str | None = None

      Filter by this category.

    • optionalkeyword-onlyusername: str | None = None

      Filter by this username.

    • optionalkeyword-onlypricing_model: str | None = None

      Filter by this pricing model.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns Iterator[StoreListActor]

list

  • list(*, limit, offset, search, sort_by, category, username, pricing_model, timeout): ListOfStoreActors

  • List Actors in Apify store.

    https://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store

    Parameters

    • optionalkeyword-onlylimit: int | None = None

      How many Actors to list.

    • optionalkeyword-onlyoffset: int | None = None

      What Actor to include as first when retrieving the list.

    • optionalkeyword-onlysearch: str | None = None

      String to search by. The search runs on the following fields: title, name, description, username, readme.

    • optionalkeyword-onlysort_by: str | None = None

      Specifies the field by which to sort the results.

    • optionalkeyword-onlycategory: str | None = None

      Filter by this category.

    • optionalkeyword-onlyusername: str | None = None

      Filter by this username.

    • optionalkeyword-onlypricing_model: str | None = None

      Filter by this pricing model.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns ListOfStoreActors

    The list of available Actors matching the specified filters.

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options