following

Accessed as client.users.following; the async client mirrors it.

SyncAsync

UsersFollowing

The users.following namespace.

get(username: str, target: str) -> None

Check if one user is following another user.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of following user	required
`target`	`str`	username of followed user	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: userCheckFollowing

list(username: str, *, page: int | None = None, limit: int | None = None) -> Paginated[User]

List the users that the given user is following.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user	required
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[User]`	UserList.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: userListFollowing

The users.following namespace.

get(username: str, target: str) -> None

Check if one user is following another user.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of following user	required
`target`	`str`	username of followed user	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: userCheckFollowing

list(username: str, *, page: int | None = None, limit: int | None = None) -> AsyncPaginated[User]

List the users that the given user is following.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user	required
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[User]`	UserList.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: userListFollowing