get_projects

toloka.client.TolokaClient.get_projects | Source code

Finds all projects that match certain criteria.

get_projects returns a generator. You can iterate over all found projects using the generator. Several requests to the Toloka server are possible while iterating.

If you need to sort projects use the find_projects method.

Parameters description

ParametersTypeDescription
statusOptional[Project.ProjectStatus]

Project status. Refer to the ProjectStatus page for more information on the available status values.

id_ltOptional[str]

Projects with IDs less than the specified value.

id_lteOptional[str]

Projects with IDs less than or equal to the specified value.

id_gtOptional[str]

Projects with IDs greater than the specified value.

id_gteOptional[str]

Projects with IDs greater than or equal to the specified value.

created_ltOptional[datetime]

Projects created before the specified date.

created_lteOptional[datetime]

Projects created before or on the specified date.

created_gtOptional[datetime]

Projects created after the specified date.

created_gteOptional[datetime]

Projects created after or on the specified date.

batch_sizeOptional[int]

A limit of items returned by each request to Toloka. The maximum allowed value: 300. The default value: 20.

  • Yields:

    The next matching project.

  • Yield type:

    Generator[Project, None, None]

Examples:

Get all active projects.

active_projects = toloka_client.get_projects(status='ACTIVE')

Get all your projects.

my_projects = toloka_client.get_projects()

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming