Tweepy

https://docs.tweepy.org/en/latest/
Admin
Tweepy is a Python library for interacting with the Twitter API, supporting both Twitter API v1.1...
Tokens:137,681
Snippets:803
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install with Async Support

Source: https://docs.tweepy.org/en/latest/install.html

Install Tweepy with the 'async' extra to enable the asynchronous subpackage functionality.

```bash
pip install tweepy[async]

```

--------------------------------

### Install Development Version from Source

Source: https://docs.tweepy.org/en/latest/install.html

Clone the Tweepy repository from GitHub and install the latest development version locally.

```bash
git clone https://github.com/tweepy/tweepy.git
cd tweepy
pip install .

```

--------------------------------

### Install Tweepy with Test Extra

Source: https://docs.tweepy.org/en/latest/development.html

Install Tweepy from source with the test extra to enable running tests. Optionally include the dev extra for additional tools like tox and coverage.

```bash
pip install .[test]
```

```bash
pip install .[dev,test]
```

--------------------------------

### Install Directly from GitHub

Source: https://docs.tweepy.org/en/latest/install.html

Install the latest version of Tweepy directly from its GitHub repository using pip.

```bash
pip install git+https://github.com/tweepy/tweepy.git

```

--------------------------------

### Install Latest Version with Pip

Source: https://docs.tweepy.org/en/latest/install.html

Use this command to install the latest stable release of Tweepy from the Python Package Index.

```bash
pip install tweepy

```

--------------------------------

### Get Followed Lists

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves lists that the specified user is following.

```APIDOC
## GET /2/users/:id/followed_lists

### Description
Retrieves lists that the specified user is following.

### Method
GET

### Endpoint
/2/users/:id/followed_lists

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the user.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of list objects that the user is following.

#### Response Example
{
  "data": [
    {
      "id": "123",
      "name": "Followed List"
    }
  ]
}
```

--------------------------------

### Get Space Buyers

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves a list of users who have bought access to a Space.

```APIDOC
## GET /2/spaces/:id/buyers

### Description
Retrieves a list of users who have bought access to a Space.

### Method
GET

### Endpoint
/2/spaces/:id/buyers

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Space.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of user objects who bought access.

#### Response Example
{
  "data": [
    {
      "id": "12345",
      "name": "Buyer User",
      "username": "buyeruser"
    }
  ]
}
```

--------------------------------

### Get Access Token using PIN Verifier

Source: https://docs.tweepy.org/en/latest/authentication.html

Retrieve the access token and secret using the PIN provided by the user as the verifier.

```python
verifier = input("Input PIN: ")
access_token, access_token_secret = oauth1_user_handler.get_access_token(
    verifier
)

```

--------------------------------

### Connect to Sample Stream

Source: https://docs.tweepy.org/en/latest/streaming.html

Use StreamingClient.sample() to connect to and run a sampling stream.

```python
streaming_client.sample()
```

--------------------------------

### Specific Tweepy File Logging Setup

Source: https://docs.tweepy.org/en/latest/logging.html

Configure logging specifically for Tweepy by getting its logger, setting its level, and adding a file handler. This allows for targeted logging to a file.

```python
import logging

logger = logging.getLogger("tweepy")
logger.setLevel(logging.DEBUG)
handler = logging.FileHandler(filename="tweepy.log")
logger.addHandler(handler)
```

--------------------------------

### Basic Console Logging Setup

Source: https://docs.tweepy.org/en/latest/logging.html

Use `logging.basicConfig()` for simple console output of all library logs. The `level` argument controls the verbosity.

```python
import logging

logging.basicConfig(level=logging.DEBUG)
```

--------------------------------

### Get Bookmarks

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Allows you to get an authenticated user’s 800 most recent bookmarked Tweets.

```APIDOC
## GET /users/:id/bookmarks

### Description
Allows you to get an authenticated user’s 800 most recent bookmarked Tweets.

### Method
GET

### Endpoint
/users/:id/bookmarks

### Parameters
#### Query Parameters
- **expansions** (list[str] | str | None) - Optional - expansions Parameter
- **max_results** (int | None) - Optional - The maximum number of results to be returned per page. This can be a number between 1 and 100. By default, each page will return 100 results.
- **media_fields** (list[str] | str | None) - Optional - media_fields
- **pagination_token** (str | None) - Optional - Used to request the next page of results if all results weren’t returned with the latest request, or to go back to the previous page of results. To return the next page, pass the `next_token` returned in your previous response. To go back one page, pass the `previous_token` returned in your previous response.
- **place_fields** (list[str] | str | None) - Optional - place_fields
- **poll_fields** (list[str] | str | None) - Optional - poll_fields
- **tweet_fields** (list[str] | str | None) - Optional - tweet_fields
- **user_fields** (list[str] | str | None) - Optional - user_fields

### Response
#### Success Response (200)
- **Response** (dict | aiohttp.ClientResponse | Response) - Details of the operation.

### References
https://developer.twitter.com/en/docs/twitter-api/tweets/bookmarks/api-reference/get-users-id-bookmarks
```

--------------------------------

### Initialize AsyncClient

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Instantiate the AsyncClient with authentication tokens. Supports Bearer Token or OAuth 1.0a credentials. You can also specify the return type for API responses and whether to wait on rate limits.

```python
client = tweepy.AsyncClient(
    bearer_token="YOUR-BEARER-TOKEN",
    consumer_key="YOUR-CONSUMER-KEY",
    consumer_secret="YOUR-CONSUMER-SECRET",
    access_token="YOUR-ACCESS-TOKEN",
    access_token_secret="YOUR-ACCESS-TOKEN-SECRET",
    return_type=tweepy.Response,
    wait_on_rate_limit=True,
)
```

--------------------------------

### chunked_upload_init()

Source: https://docs.tweepy.org/en/latest/genindex.html

Initializes a chunked media upload process.

```APIDOC
## chunked_upload_init()

### Description
Initializes a chunked media upload process.

### Method
This method is part of the `tweepy.API` class.

### Endpoint
Not specified in the source.

### Parameters
Not specified in the source.

### Request Example
Not specified in the source.

### Response
Not specified in the source.
```

--------------------------------

### Get Recent Tweets Count

Source: https://docs.tweepy.org/en/latest/examples.html

This snippet demonstrates how to get the count of recent tweets matching a query. It uses the `get_recent_tweets_count` method with a specified granularity.

```python
import tweepy


bearer_token = ""

client = tweepy.Client(bearer_token)

# Get Recent Tweets Count

# This endpoint/method returns count of Tweets from the last seven days that
# match a search query

query = "Tweepy -is:retweet"

# Granularity is what you want the timeseries count data to be grouped by
# You can request minute, hour, or day granularity
# The default granularity, if not specified is hour
response = client.get_recent_tweets_count(query, granularity="day")

for count in response.data:
    print(count)

```

--------------------------------

### Create List

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Creates a new list.

```APIDOC
## POST /2/lists

### Description
Creates a new list.

### Method
POST

### Endpoint
/2/lists

### Parameters
#### Request Body
- **name** (string) - Required - The name of the list.
- **description** (string) - Optional - The description of the list.
- **private** (boolean) - Optional - Whether the list is private.

### Request Example
{
  "name": "My New List",
  "description": "A list of important users."
}

### Response
#### Success Response (200)
- **data** (object) - The created list object.

#### Response Example
{
  "data": {
    "id": "123",
    "name": "My New List"
  }
}
```

--------------------------------

### Initialize OAuth1UserHandler

Source: https://docs.tweepy.org/en/latest/authentication.html

Initialize an OAuth1UserHandler instance with your API keys and callback URI.

```python
import tweepy

oauth1_user_handler = tweepy.OAuth1UserHandler(
    "API / Consumer Key here", "API / Consumer Secret here",
    callback="Callback / Redirect URI / URL here"
)

```

--------------------------------

### get_retweeters

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Allows you to get information about who has Retweeted a Tweet.

```APIDOC
## GET /tweets/:id/retweeted_by

### Description
Allows you to get information about who has Retweeted a Tweet.

### Method
GET

### Endpoint
/tweets/:id/retweeted_by

### Parameters
#### Path Parameters
- **id** (int | str) - Required - Tweet ID of the Tweet to request Retweeting users of.

#### Query Parameters
- **expansions** (list[str] | str | None) - Optional - expansions Parameter
- **max_results** (int | None) - Optional - The maximum number of results to be returned per page. This can be a number between 1 and 100. By default, each page will return 100 results.
- **media_fields** (list[str] | str | None) - Optional - media_fields
- **pagination_token** (str | None) - Optional - Used to request the next page of results if all results weren’t returned with the latest request, or to go back to the previous page of results. To return the next page, pass the `next_token` returned in your previous response. To go back one page, pass the `previous_token` returned in your previous response.
- **place_fields** (list[str] | str | None) - Optional - place_fields
- **poll_fields** (list[str] | str | None) - Optional - poll_fields
- **tweet_fields** (list[str] | str | None) - Optional - tweet_fields
- **user_fields** (list[str] | str | None) - Optional - user_fields
- **user_auth** (bool) - Optional - Whether or not to use OAuth 1.0a User Context to authenticate. Defaults to False.

### Response
#### Success Response (200)
- **dict | aiohttp.ClientResponse | Response** - The result of the operation.

### References
https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by
```

--------------------------------

### Initialize PIN-based OAuth1UserHandler

Source: https://docs.tweepy.org/en/latest/authentication.html

Initialize an OAuth1UserHandler for PIN-based OAuth by setting the callback to 'oob'.

```python
import tweepy

oauth1_user_handler = tweepy.OAuth1UserHandler(
    "API / Consumer Key here", "API / Consumer Secret here",
    callback="oob"
)

```

--------------------------------

### Get List

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves a specific list by its ID.

```APIDOC
## GET /2/lists/:id

### Description
Retrieves a specific list by its ID.

### Method
GET

### Endpoint
/2/lists/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the list to retrieve.

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - The list object.

#### Response Example
{
  "data": {
    "id": "123",
    "name": "My List",
    "description": "A list of my favorite users."
  }
}
```

--------------------------------

### Get Space

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves a specific Space by its ID.

```APIDOC
## GET /2/spaces/:id

### Description
Retrieves a specific Space by its ID.

### Method
GET

### Endpoint
/2/spaces/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Space to retrieve.

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - The space object.

#### Response Example
{
  "data": {
    "id": "1234567890",
    "name": "Example Space"
    }
}
```

--------------------------------

### Initialize OAuth2UserHandler for PKCE Flow

Source: https://docs.tweepy.org/en/latest/authentication.html

Initialize OAuth2UserHandler for OAuth 2.0 Authorization Code Flow with PKCE. Requires Client ID, redirect URI, and scopes. Client Secret is needed for confidential clients.

```python
import tweepy

oauth2_user_handler = tweepy.OAuth2UserHandler(
    client_id="Client ID here",
    redirect_uri="Callback / Redirect URI / URL here",
    scope=["Scope here", "Scope here"],
    # Client Secret is only necessary if using a confidential client
    client_secret="Client Secret here"
)
```

--------------------------------

### Get Compliance Jobs

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves a list of compliance jobs.

```APIDOC
## GET /2/compliance/jobs

### Description
Retrieves a list of compliance jobs.

### Method
GET

### Endpoint
/2/compliance/jobs

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of compliance job (e.g., 'tweets', 'users').

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of compliance job objects.

#### Response Example
{
  "data": [
    {
      "id": "job123",
      "type": "tweets",
      "created_at": "2023-01-01T12:00:00Z"
    }
  ]
}
```

--------------------------------

### Client.create_list

Source: https://docs.tweepy.org/en/latest/client.html

Enables the authenticated user to create a List. Requires a name for the List and optionally accepts a description, privacy setting, and uses OAuth 1.0a User Context for authentication.

```APIDOC
## Client.create_list

### Description
Enables the authenticated user to create a List.

### Method
POST (inferred from context of creation and Twitter API reference)

### Endpoint
/2/lists

### Parameters
#### Query Parameters
- **name** (str) - Required - The name of the List you wish to create.
- **description** (str | None) - Optional - Description of the List.
- **private** (bool | None) - Optional - Determine whether the List should be private.
- **user_auth** (bool) - Optional - Whether or not to use OAuth 1.0a User Context to authenticate

### Response
#### Success Response (200)
- **dict | requests.Response | Response** - The result of the creation operation.
```

--------------------------------

### Get List Members

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves members of a specific list.

```APIDOC
## GET /2/lists/:id/members

### Description
Retrieves members of a specific list.

### Method
GET

### Endpoint
/2/lists/:id/members

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the list.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of user objects who are members of the list.

#### Response Example
{
  "data": [
    {
      "id": "12345",
      "name": "List Member",
      "username": "listmember"
    }
  ]
}
```

--------------------------------

### Client.get_spaces

Source: https://docs.tweepy.org/en/latest/client.html

Returns details about multiple live or scheduled Spaces. Up to 100 comma-separated Space or user IDs can be looked up.

```APIDOC
## GET /spaces

### Description
Returns details about multiple live or scheduled Spaces (created by the specified user IDs if specified). Up to 100 comma-separated Space or user IDs can be looked up using this endpoint.

### Method
GET

### Endpoint
/spaces

### Parameters
#### Query Parameters
- **ids** (list[str] | str | None) - A comma separated list of Spaces (up to 100).
- **user_ids** (list[int | str] | str | None) - A comma separated list of user IDs (up to 100).
- **expansions** (list[str] | str | None) - expansions Parameter
- **space_fields** (list[str] | str | None) - space_fields
- **user_fields** (list[str] | str | None) - user_fields

### Response
#### Success Response (200)
- **dict | requests.Response | Response** - Details about the requested Spaces.

### References
- https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces
- https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-by-creator-ids
```

--------------------------------

### Get List Followers

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves the followers of a specific list.

```APIDOC
## GET /2/lists/:id/followers

### Description
Retrieves the followers of a specific list.

### Method
GET

### Endpoint
/2/lists/:id/followers

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the list.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of user objects who follow the list.

#### Response Example
{
  "data": [
    {
      "id": "12345",
      "name": "Follower User",
      "username": "followeruser"
    }
  ]
}
```

--------------------------------

### Get List Tweets

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves tweets from a specific list.

```APIDOC
## GET /2/lists/:id/tweets

### Description
Retrieves tweets from a specific list.

### Method
GET

### Endpoint
/2/lists/:id/tweets

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the list.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of tweet objects belonging to the list.

#### Response Example
{
  "data": [
    {
      "id": "9876543210",
      "text": "Tweet from the list."
    }
  ]
}
```

--------------------------------

### create_list()

Source: https://docs.tweepy.org/en/latest/genindex.html

Creates a new list for the authenticated user.

```APIDOC
## create_list()

### Description
Creates a new list for the authenticated user.

### Method
This method can be called on `tweepy.API`, `tweepy.asynchronous.AsyncClient`, and `tweepy.Client` objects.

### Endpoint
Not specified in the source.

### Parameters
Not specified in the source.

### Request Example
Not specified in the source.

### Response
Not specified in the source.
```

--------------------------------

### Get Space Tweets

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Returns Tweets shared in the requested Spaces.

```APIDOC
## GET /spaces/{id}/tweets

### Description
Returns Tweets shared in the requested Spaces.

### Method
GET

### Endpoint
/spaces/{id}/tweets

### Parameters
#### Path Parameters
- **id** (str) - Unique identifier of the Space containing the Tweets you’d like to access.

#### Query Parameters
- **expansions** (list[str] | str | None) - expansions Parameter
- **media_fields** (list[str] | str | None) - media_fields
- **place_fields** (list[str] | str | None) - place_fields
- **poll_fields** (list[str] | str | None) - poll_fields
- **tweet_fields** (list[str] | str | None) - tweet_fields
- **user_fields** (list[str] | str | None) - user_fields

### Response
#### Success Response (200)
- **Response** (dict | aiohttp.ClientResponse | Response) - Tweets shared in the requested Space.

### References
- https://developer.twitter.com/en/docs/twitter-api/spaces/lookup/api-reference/get-spaces-id-tweets
```

--------------------------------

### API.create_list

Source: https://docs.tweepy.org/en/latest/api.html

Creates a new list for the authenticated user. Lists can be either public or private, and have a name and an optional description.

```APIDOC
## API.create_list

### Description
Creates a new list for the authenticated user. Note that you can create up to 1000 lists per account.

### Method
POST

### Endpoint
/lists/create

### Parameters
#### Request Body
* **name** (str) - The name of the new list.
* **mode** (str) - Whether your list is public or private. Values can be public or private. Lists are public by default if no mode is specified.
* **description** (str) - The description of the list you are creating.

### Response
#### Success Response (200)
- **List** (List) - The newly created list object.
```

--------------------------------

### Get Compliance Job

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves a specific compliance job by its ID.

```APIDOC
## GET /2/compliance/jobs/:id

### Description
Retrieves a specific compliance job by its ID.

### Method
GET

### Endpoint
/2/compliance/jobs/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the compliance job.

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - The compliance job object.

#### Response Example
{
  "data": {
    "id": "job123",
    "type": "tweets",
    "created_at": "2023-01-01T12:00:00Z"
  }
}
```

--------------------------------

### Initialize Tweepy Client with Access Token and Secret

Source: https://docs.tweepy.org/en/latest/authentication.html

Initialize the Tweepy Client object by directly passing consumer and access tokens.

```python
client = tweepy.Client(
    consumer_key="API / Consumer Key here",
    consumer_secret="API / Consumer Secret here",
    access_token="Access Token here",
    access_token_secret="Access Token Secret here"
)

```

--------------------------------

### Get Pinned Lists

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves lists pinned by the specified user.

```APIDOC
## GET /2/users/:id/pinned_lists

### Description
Retrieves lists pinned by the specified user.

### Method
GET

### Endpoint
/2/users/:id/pinned_lists

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the user.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of list objects pinned by the user.

#### Response Example
{
  "data": [
    {
      "id": "123",
      "name": "Pinned List"
    }
  ]
}
```

--------------------------------

### Paginate User Followers with Paginator

Source: https://docs.tweepy.org/en/latest/v2_pagination.html

Use Paginator to retrieve a limited number of user followers. This example demonstrates iterating through paginated responses and printing metadata.

```python
import tweepy

client = tweepy.Client("Bearer Token here")

for response in tweepy.Paginator(client.get_users_followers, 2244994945,
                                    max_results=1000, limit=5):
    print(response.meta)
```

--------------------------------

### Get List Memberships

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves lists that a specific user is a member of.

```APIDOC
## GET /2/users/:id/list_memberships

### Description
Retrieves lists that a specific user is a member of.

### Method
GET

### Endpoint
/2/users/:id/list_memberships

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the user.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of list objects the user is a member of.

#### Response Example
{
  "data": [
    {
      "id": "123",
      "name": "Member List"
    }
  ]
}
```

--------------------------------

### StreamingClient Initialization

Source: https://docs.tweepy.org/en/latest/streamingclient.html

Initializes the StreamingClient with a bearer token and various optional parameters to configure the stream connection.

```APIDOC
## `StreamingClient` Constructor

### Description
Initializes the StreamingClient for filtering and sampling real-time Tweets with Twitter API v2.

### Parameters
* **bearer_token** (str) - Required - Twitter API Bearer Token.
* **return_type** (type) - Optional - Type to return from requests to the API (e.g., `__dict__`, `__requests.Response__`, `Response`). Defaults to `Response`.
* **wait_on_rate_limit** (bool) - Optional - Whether to wait before retrying when a rate limit is encountered. Applies to non-stream requests. Defaults to `False`.
* **chunk_size** (int) - Optional - The default socket.read size. Defaults to 512.
* **daemon** (bool) - Optional - Whether to use a daemon thread when running the stream. Defaults to `False`.
* **max_retries** (int) - Optional - Maximum number of times to retry connecting the stream. Defaults to `inf`.
* **proxy** (str | None) - Optional - URL of the proxy to use when connecting to the stream. Defaults to `None`.
* **verify** (bool | str) - Optional - Controls TLS certificate verification. Defaults to `True`.
```

--------------------------------

### bookmark()

Source: https://docs.tweepy.org/en/latest/genindex.html

Manages bookmarks for the authenticated user. This method is available for both asynchronous and synchronous clients.

```APIDOC
## bookmark()

### Description
Manages bookmarks for the authenticated user.

### Method
This method can be called on both `tweepy.asynchronous.AsyncClient` and `tweepy.Client` objects.

### Endpoint
Not specified in the source.

### Parameters
Not specified in the source.

### Request Example
Not specified in the source.

### Response
Not specified in the source.
```

--------------------------------

### Get Owned Lists

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves lists owned by the specified user.

```APIDOC
## GET /2/users/:id/owned_lists

### Description
Retrieves lists owned by the specified user.

### Method
GET

### Endpoint
/2/users/:id/owned_lists

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the user.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of list objects owned by the user.

#### Response Example
{
  "data": [
    {
      "id": "123",
      "name": "Owned List"
    }
  ]
}
```

--------------------------------

### API.chunked_upload_init

Source: https://docs.tweepy.org/en/latest/api.html

Initiates a chunked file upload session, returning a media ID to be used for subsequent uploads.

```APIDOC
## POST /media/upload/init

### Description
Use this endpoint to initiate a chunked file upload session.

### Method
POST

### Endpoint
/media/upload/init

### Parameters
#### Query Parameters
- **total_bytes** (integer) - Required - The size of the media being uploaded in bytes.
- **media_type** (string) - Required - The MIME type of the media being uploaded.
- **media_category** (string) - Optional - The category that represents how the media will be used. This field is required when using the media with the Ads API.
- **additional_owners** (list of strings) - Optional - A list of user IDs to set as additional owners allowed to use the returned `media_id` in Tweet or Cards. Up to 100 additional owners may be specified.

### Response
#### Success Response (200)
- **Media** (object) - Returns media object upon successful initialization.
```

--------------------------------

### Client.follow

Source: https://docs.tweepy.org/en/latest/client.html

Alias for Client.follow_user(). Deprecated since version 4.2: Use Client.follow_user() instead.

```APIDOC
## POST /users/:source_user_id/following (Alias)

### Description
Alias for `Client.follow_user()`. Allows a user ID to follow another user.

### Method
POST

### Endpoint
/users/:source_user_id/following

### Parameters
#### Path Parameters
- **source_user_id** (int | str) - Required - The user ID of the user that you would like to follow.

#### Query Parameters
- **user_auth** (bool) - Optional - Whether or not to use OAuth 1.0a User Context to authenticate. Defaults to True.

### Request Example
```json
{
  "target_user_id": "12345",
  "user_auth": true
}
```

### Response
#### Success Response (200)
- **data** (dict) - Indicates if the follow action was successful.

#### Response Example
```json
{
  "data": {
    "following_created": true
  }
}
```

### Raises
- **TypeError** - If the access token isn’t set

### Deprecated
Deprecated since version 4.2: Use `Client.follow_user()` instead.
```

--------------------------------

### Get Space Tweets

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves tweets associated with a specific Space.

```APIDOC
## GET /2/spaces/:id/tweets

### Description
Retrieves tweets associated with a specific Space.

### Method
GET

### Endpoint
/2/spaces/:id/tweets

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the Space.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of tweet objects.

#### Response Example
{
  "data": [
    {
      "id": "9876543210",
      "text": "This is a tweet in the space."
    }
  ]
}
```

--------------------------------

### create_list

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Enables the authenticated user to create a List. This method corresponds to the POST /lists endpoint.

```APIDOC
## POST /lists

### Description
Enables the authenticated user to create a List.

### Method
POST

### Endpoint
/lists

### Parameters
#### Path Parameters
None.

#### Query Parameters
None explicitly documented for this operation.

#### Request Body
- **name** (str) - Required - The name of the List you wish to create.
- **description** (str | None) - Optional - Description of the List.
- **private** (bool | None) - Optional - Determine whether the List should be private.

### Request Example
None provided in source.

### Response
#### Success Response (200)
- **dict** | **aiohttp.ClientResponse** | **Response** - The API may return a dictionary, aiohttp.ClientResponse, or a Response object upon successful creation.

#### Response Example
None provided in source.
```

--------------------------------

### Get Spaces

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Retrieves a list of Spaces based on provided filters.

```APIDOC
## GET /2/spaces

### Description
Retrieves a list of Spaces based on provided filters.

### Method
GET

### Endpoint
/2/spaces

### Parameters
#### Query Parameters
- **ids** (array of strings) - Required - A list of Space IDs to retrieve.
- **user_ids** (array of strings) - Optional - A list of user IDs to filter spaces by.

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - An array of space objects.

#### Response Example
{
  "data": [
    {
      "id": "1234567890",
      "name": "Example Space"
    }
  ]
}
```

--------------------------------

### Client.get_liked_tweets

Source: https://docs.tweepy.org/en/latest/client.html

Allows you to get information about a user’s liked Tweets.

```APIDOC
## Client.get_liked_tweets

### Description
Allows you to get information about a user’s liked Tweets. The Tweets returned by this endpoint count towards the Project-level Tweet cap.

### Method
GET

### Endpoint
/2/users/:id/liked_tweets

### Parameters
#### Path Parameters
* **id** (int | str) - User ID of the user to request liked Tweets for.

#### Query Parameters
* **expansions** (list[str] | str | None) - expansions Parameter
* **max_results** (int | None) - The maximum number of results to be returned per page. This can be a number between 5 and 100. By default, each page will return 100 results.
* **media_fields** (list[str] | str | None) - media_fields
* **pagination_token** (str | None) - Used to request the next page of results if all results weren’t returned with the latest request, or to go back to the previous page of results. To return the next page, pass the `next_token` returned in your previous response. To go back one page, pass the `previous_token` returned in your previous response.
* **place_fields** (list[str] | str | None) - place_fields
* **poll_fields** (list[str] | str | None) - poll_fields
* **tweet_fields** (list[str] | str | None) - tweet_fields
* **user_fields** (list[str] | str | None) - user_fields
* **user_auth** (bool) - Whether or not to use OAuth 1.0a User Context to authenticate. Defaults to False.

### Returns
Return type: dict | requests.Response | Response
```

--------------------------------

### Initialize Tweepy Client with Fetched Access Token

Source: https://docs.tweepy.org/en/latest/authentication.html

Initialize the Tweepy Client using the access token obtained from the OAuth 2.0 PKCE flow. This allows the client to make authenticated requests on behalf of the user.

```python
client = tweepy.Client("Access Token here")
```

--------------------------------

### Initialize API with Access Token and Secret

Source: https://docs.tweepy.org/en/latest/authentication.html

Initialize the Tweepy API object directly using the obtained access token and secret.

```python
auth = tweepy.OAuth1UserHandler(
   "API / Consumer Key here", "API / Consumer Secret here",
   "Access Token here", "Access Token Secret here"
)
api = tweepy.API(auth)

```

--------------------------------

### Client.get_liking_users

Source: https://docs.tweepy.org/en/latest/client.html

Allows you to get information about a Tweet’s liking users.

```APIDOC
## Client.get_liking_users

### Description
Allows you to get information about a Tweet’s liking users.

### Method
GET

### Endpoint
/2/tweets/:id/liking_users

### Parameters
#### Path Parameters
* **id** (int | str) - Tweet ID of the Tweet to request liking users of.

#### Query Parameters
* **expansions** (list[str] | str | None) - expansions Parameter
* **max_results** (int | None) - The maximum number of results to be returned per page. This can be a number between 1 and 100. By default, each page will return 100 results.
* **media_fields** (list[str] | str | None) - media_fields
* **pagination_token** (str | None) - Used to request the next page of results if all results weren’t returned with the latest request, or to go back to the previous page of results. To return the next page, pass the `next_token` returned in your previous response. To go back one page, pass the `previous_token` returned in your previous response.
* **place_fields** (list[str] | str | None) - place_fields
* **poll_fields** (list[str] | str | None) - poll_fields
* **tweet_fields** (list[str] | str | None) - tweet_fields
* **user_fields** (list[str] | str | None) - user_fields
* **user_auth** (bool) - Whether or not to use OAuth 1.0a User Context to authenticate. Defaults to False.

### Returns
Return type: dict | requests.Response | Response
```

--------------------------------

### Get Muted Users

Source: https://docs.tweepy.org/en/latest/asyncclient.html

Returns a list of users who are muted by the authenticating user.

```APIDOC
## get_muted

### Description
Returns a list of users who are muted by the authenticating user.

### Method
GET

### Endpoint
/users/:user_id/muting

### Parameters
#### Query Parameters
- **expansions** (list[str] | str | None) - Optional - expansions Parameter
- **max_results** (int | None) - Optional - The maximum number of results to be returned per page. This can be a number between 1 and 1000. By default, each page will return 100 results.
- **pagination_token** (str | None) - Optional - Used to request the next page of results if all results weren’t returned with the latest request, or to go back to the previous page of results.
- **tweet_fields** (list[str] | str | None) - Optional - tweet_fields
- **user_fields** (list[str] | str | None) - Optional - user_fields
- **user_auth** (bool) - Optional - Whether or not to use OAuth 1.0a User Context to authenticate

### Response
#### Success Response (200)
- **Response** (dict | aiohttp.ClientResponse | Response) - A list of muted users.

### References
https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting
```
Tokens:
Raw