Toloka documentation

get_pools

toloka.client.TolokaClient.get_pools

Finds all pools that match certain rules and returns them in an iterable object

Unlike find_pools, returns generator. Does not sort pools. While iterating over the result, several requests to the Toloka server is possible.

Parameters Description

Parameters Type Description
status Optional[Pool.Status]

Pool status

  • OPEN
  • CLOSED
  • ARCHIVED
  • LOCKED

project_id Optional[str]

ID of the project to which the pool is attached.

id_lt Optional[str]

Pools with an ID less than the specified value.

id_lte Optional[str]

Pools with an ID less than or equal to the specified value.

id_gt Optional[str]

Pools with an ID greater than the specified value.

id_gte Optional[str]

Pools with an ID greater than or equal to the specified value.

created_lt Optional[datetime]

Pools created before the specified date.

created_lte Optional[datetime]

Pools created before or on the specified date.

created_gt Optional[datetime]

Pools created after the specified date.

created_gte Optional[datetime]

Pools created after or on the specified date.

last_started_lt Optional[datetime]

Pools that were last opened before the specified date.

last_started_lte Optional[datetime]

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

last_started_gt Optional[datetime]

Pools that were last opened after the specified date.

last_started_gte Optional[datetime]

Pools that were last opened on or after the specified date.

  • Yields:

    The next object corresponding to the request parameters.

  • Yield type:

    Generator[Pool, None, None]

Examples:

How to get all open pools from project.

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

How to get all pools from project.

all_pools = toloka_client.get_pools(project_id='1')