find_projects

toloka.client.TolokaClient.find_projects | Source code

Finds projects that match certain criteria.

The number of returned projects is limited. To find remaining projects call find_projects with updated search criteria.

To iterate over all matching projects you may use the get_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.

sortUnion[List[str], ProjectSortItems, None]

Sorting options. Default: None.

limitOptional[int]

Returned projects limit. The maximum allowed value: 300. The default value: 20.

  • Returns:

    Found projects and a flag showing whether there are more matching projects exceeding the limit.

  • Return type:

    ProjectSearchResult

Examples:

The example shows how to find projects created before a specific date.

find_result = toloka_client.find_projects(created_lt='2021-06-01T00:00:00')
projects = find_result.items

If there are projects exceeding the limit, then find_result.has_more is set to True.

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