get_pools

toloka.client.TolokaClient.get_pools | Source code

Finds all pools that match certain criteria.

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

If you need to sort pools use the find_pools method.

Parameters description

ParametersTypeDescription
statusOptional[Pool.Status]

Pool status. Refer to the Pool.Status page for more information on the available status values.

project_idOptional[str]

Pools belonging to the project with the specified ID.

id_ltOptional[str]

Pools with IDs less than the specified value.

id_lteOptional[str]

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

id_gtOptional[str]

Pools with IDs greater than the specified value.

id_gteOptional[str]

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

created_ltOptional[datetime]

Pools created before the specified date.

created_lteOptional[datetime]

Pools created before or on the specified date.

created_gtOptional[datetime]

Pools created after the specified date.

created_gteOptional[datetime]

Pools created after or on the specified date.

last_started_ltOptional[datetime]

Pools that were opened last time before the specified date.

last_started_lteOptional[datetime]

Pools that were opened last time before or on the specified date.

last_started_gtOptional[datetime]

Pools that were opened last time after the specified date.

last_started_gteOptional[datetime]

Pools that were opened last time 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 pool.

  • Yield type:

    Generator[Pool, None, None]

Examples:

Getting all open pools from a project.

open_pools = toloka_client.get_pools(project_id='92694', status='OPEN')

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