Skip to main content
Version: Next

StoreCollectionClient

Client for browsing Actors in the Apify Store.

The Apify Store contains publicly available Actors that can be used by anyone. This client provides methods to search and list Actors from the Store.

@example
const client = new ApifyClient();
const storeClient = client.store();

// Search for Actors in the Store
const { items } = await storeClient.list({ search: 'web scraper' });

// Get details about a specific Store Actor
const actor = await storeClient.list({ username: 'apify', actorName: 'web-scraper' });
@see

https://docs.apify.com/platform/actors/publishing

Hierarchy

  • ResourceCollectionClient
    • StoreCollectionClient

Index

Properties

Methods

Properties

inheritedapifyClient

apifyClient: ApifyClient

inheritedbaseUrl

baseUrl: string

inheritedhttpClient

httpClient: HttpClient

optionalinheritedid

id?: string

optionalinheritedparams

params?: Record<string, unknown>

inheritedpublicBaseUrl

publicBaseUrl: string

inheritedresourcePath

resourcePath: string

optionalinheritedsafeId

safeId?: string

inheritedurl

url: string

Methods

list

  • Lists Actors from the Apify Store.

    Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched items in a single API call is limited.

    const paginatedList = await client.list(options);

    Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are retrieved.

    for await (const singleItem of client.list(options)) {...}
    @see

    https://docs.apify.com/api/v2/store-actors-get

    Parameters

    Returns PaginatedIterator<ActorStoreList>

    A paginated iterator of store Actors.

Page Options