twitterapi.users.user module

user.py: Implementation of Twitter Users lookup endpoint.

“The RESTful endpoint uses the GET method to return information about a user or group of users, specified by a user ID or a username. The response includes one or many user objects, which deliver fields such as the Follower count, location, pinned Tweet ID, and profile bio. Responses can also optionally include expansions to return the full Tweet object for a user’s pinned Tweet, including the Tweet text, author, and other Tweet fields.” (Source: https://developer.twitter.com/en/docs/twitter-api/users/lookup/introduction)

Find the Open API Spec under: https://api.twitter.com/2/openapi.json

Examples

Get Users by username:

import os
os.environ["BEARER_TOKEN"] = "xxxxxxxxxxx"
from sparta.twitterapi.users.user import get_users_by_username

async for user in get_users_by_username(['projekt_sparta', 'Bundestag']):
    print(user.model_dump_json())

Get Users by ID:

import os
os.environ["BEARER_TOKEN"] = "xxxxxxxxxxx"
from sparta.twitterapi.users.user import get_users_by_ids

async for user in get_users_by_ids(['1422600096324231168', '3088296873']):
    print(user.model_dump_json())

async sparta.twitterapi.users.user.get_users_by_ids(ids: List[str]) → AsyncGenerator[User, None]

Asynchronously retrieves information about users specified by their usernames.

This function queries the Twitter API to get information about users based on a list of Twitter user ids. It handles rate limiting using an internal instance of RateLimiter, automatically pausing requests if the rate limit is exceeded.

Parameters:

usernames (List[str]) – A list of Twitter user ids. Up to 100 usernames are allowed in a single request.

Yields:

User – An object representing a Twitter user for each provided username.

Raises:

Exception – If an HTTP error occurs that prevents retrieving the user information or if any of the usernames are invalid.

Note

The function automatically handles pagination of results using the ‘next_token’ provided by Twitter’s API response.

async sparta.twitterapi.users.user.get_users_by_username(usernames: List[str]) → AsyncGenerator[User, None]

Asynchronously retrieves information about users specified by their usernames.

This function queries the Twitter API to get information about users based on a list of Twitter usernames. It handles rate limiting using an internal instance of RateLimiter, automatically pausing requests if the rate limit is exceeded.

Parameters:

usernames (List[str]) – A list of Twitter usernames (handles). Up to 100 usernames are allowed in a single request.

Yields:

User – An object representing a Twitter user for each provided username.

Raises:

Exception – If an HTTP error occurs that prevents retrieving the user information or if any of the usernames are invalid.

Note

The function automatically handles pagination of results using the ‘next_token’ provided by Twitter’s API response.