Toloka documentation

find_pools

toloka.client.TolokaClient.find_pools

Finds all pools that match certain rules

As a result, it returns an object that contains the first part of the found pools and whether there are any more results. It is better to use the "get_pools" method, they allow to iterate trought all results and not just the first output.

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.
sort Union[List[str], PoolSortItems, None]

How to sort result. Defaults to None.
limit Optional[int]

Limit on the number of results returned. The maximum is 300. Defaults to None, in which case it returns first 20 results.

  • Returns:

    The first limit pools in items. And a mark that there is more.

  • Return type:

    PoolSearchResult

Examples:

Find all pools in all projects.

toloka_client.find_pools()

Find all open pools in all projects.

toloka_client.find_pools(status='OPEN')

Find open pools in a specific project.

toloka_client.find_pools(status='OPEN', project_id='1')

If method finds more objects than custom or system limit allows to operate, it will also show an indicator has_more=True.