Skip to main content
Version: Next

RunCollectionClient

Client for managing the collection of Actor runs.

Provides methods to list Actor runs across all Actors or for a specific Actor. To access an individual run, use the run() method on the main ApifyClient.

@example
const client = new ApifyClient({ token: 'my-token' });

// List all runs
const runsClient = client.runs();
const { items } = await runsClient.list();

// List runs for a specific Actor
const actorRunsClient = client.actor('my-actor-id').runs();
const { items: actorRuns } = await actorRunsClient.list();
@see

https://docs.apify.com/platform/actors/running/runs-and-builds

Hierarchy

  • ResourceCollectionClient
    • RunCollectionClient

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 all Actor runs.

    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/actor-runs-get

    Parameters

    Returns PaginatedIterator<ActorRunListItem>

    A paginated iterator of Actor runs.

Page Options