Twitter4J

https://twitter4j.org
Admin
Twitter4J is a 100% pure Java library for the Twitter API with zero dependencies, built-in OAuth...
Tokens:184,725
Snippets:1,438
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### sample()

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Starts listening on a random sample of all public statuses.

```APIDOC
## sample()

### Description
Starts listening on random sample of all public statuses.

### Method
N/A (Method signature in Java interface)

### Endpoint
N/A
```

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

### getStart() - SymbolEntity

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the index of the start character of the symbol.

```APIDOC
## getStart() - SymbolEntity

### Description
Returns the index of the start character of the symbol.

### Method
This is a method within the `twitter4j.v1.SymbolEntity` interface.
```

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

### getStart() - UserMentionEntity

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the index of the start character of the user mention.

```APIDOC
## getStart() - UserMentionEntity

### Description
Returns the index of the start character of the user mention.

### Method
This is a method within the `twitter4j.v1.UserMentionEntity` interface.
```

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

### getStart() - HashtagEntity

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the index of the start character of the hashtag.

```APIDOC
## getStart() - HashtagEntity

### Description
Returns the index of the start character of the hashtag.

### Method
This is a method within the `twitter4j.v1.HashtagEntity` interface.
```

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

### Twitter.getInstance()

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/Twitter.html

Gets a Twitter instance. This is equivalent to calling newBuilder().build().

```APIDOC
## getInstance

### Description
Equivalent to calling newBuilder().build().

### Method
static Twitter

### Returns
Twitter Instance
```

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

### sample(String)

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Starts listening on a random sample of all public statuses with a specified filter.

```APIDOC
## sample(String)

### Description
Starts listening on random sample of all public statuses.

### Method
N/A (Method signature in Java interface)

### Endpoint
N/A
```

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

### sample

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/TwitterStream.html

Starts listening on a random sample of all public statuses. The default access level provides a small proportion of the Firehose.

```APIDOC
## sample

### Description
Starts listening on random sample of all public statuses. The default access level provides a small proportion of the Firehose. The "Gardenhose" access level provides a proportion more suitable for data mining and research applications that desire a larger proportion to be statistically significant sample.

### Method
`TwitterStream` sample()

### Returns
- `TwitterStream` - this instance

### See Also
- Streaming API: Methods statuses/sample
```

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

### getStart() - URLEntity

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the index of the start character of the URL mentioned in the tweet.

```APIDOC
## getStart() - URLEntity

### Description
Returns the index of the start character of the URL mentioned in the tweet.

### Method
This is a method within the `twitter4j.v1.URLEntity` interface.
```

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

### getInstance

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Factory method to get an instance of Twitter.

```APIDOC
## getInstance()

### Description
Factory method to get an instance of Twitter. Equivalent to calling newBuilder().build();

### Method
Static

### Interface
Twitter
```

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

### getSleepStartTime()

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the sleep start time configured for the user.

```APIDOC
## getSleepStartTime()

### Description
Returns the sleep start time configured for the user.

### Method
This is a method within the `twitter4j.v1.AccountSettings` interface.
```

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

### getStart() - TweetEntity

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the index of the start character of the entity in the tweet.

```APIDOC
## getStart() - TweetEntity

### Description
Returns the index of the start character of the entity in the tweet.

### Method
This is a method within the `twitter4j.v1.TweetEntity` interface.
```

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

### Get User List Subscriptions (Basic)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Lists the lists the specified user follows.

```APIDOC
## getUserListSubscriptions

### Description
List the lists the specified user follows.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/lists/subscriptions.json

### Parameters
#### Query Parameters
- **listSubscriberScreenName** (String) - The screen name of the list subscriber.
- **cursor** (long) - Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.

### Returns
The list of lists the specified user is subscribed to.

### Throws
`TwitterException` - when Twitter service or network is unavailable.

### Since
Twitter4J 2.1.0
```

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

### firehose

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/TwitterStream.html

Starts listening on all public statuses. This method is available only to approved parties and requires a signed agreement to access.

```APIDOC
## firehose

### Description
Starts listening on all public statuses. Available only to approved parties and requires a signed agreement to access. Please do not contact us about access to the firehose. If your service warrants access to it, we'll contact you.

### Method
`TwitterStream` firehose(int count)

### Parameters
#### Path Parameters
- `count` (int) - Indicates the number of previous statuses to stream before transitioning to the live stream.

### Returns
- `TwitterStream` - this instance

### See Also
- Streaming API Methods statuses/firehose
```

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

### QuickReply.of()

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/QuickReply.html

Constructs a new QuickReply instance with the provided label, description, and metadata.

```APIDOC
## QuickReply.of()

### Description
Constructs a new quick reply instance.

### Method
`public static QuickReply of(String label, String description, String metadata)`

### Parameters
#### Path Parameters
- **label** (String) - Required - The text label displayed on the button face. Label text is returned as the user’s message response. String, max length of 36 characters including spaces. Values with URLs are not allowed and will return an error.
- **description** (String) - Optional - Description text displayed under label text. All options must have this property defined if property is present in any option. Text is auto-wrapped and will display on a max of two lines and supports \n for controling line breaks. Description text is not include in the user’s message response. String, max length of 72 characters including spaces.
- **metadata** (String) - Optional - Metadata that will be sent back in the webhook request. String, max length of 1,000 characters including spaces.

### Returns
QuickReply - A new QuickReply object.
```

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

### Get OAuth2Authorization Instance

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/OAuth2Authorization.html

Get an instance of OAuth2Authorization, optionally with consumer key and secret.

```APIDOC
## getInstance

### Description
Equivalent to `OAuth2Authorization.newBuilder().oAuthConsumer(key, secret).build()`.

### Method
```java
public static OAuth2Authorization getInstance(String consumerKey, String consumerSecret)
```

### Parameters
#### Path Parameters
- **consumerKey** (String) - consumer key
- **consumerSecret** (String) - consumer secret

### Returns
`OAuth2Authorization`

---

## getInstance

### Description
Equivalent to `OAuth2Authorization.newBuilder().build()`.

### Method
```java
public static OAuth2Authorization getInstance()
```

### Returns
`OAuth2Authorization`
```

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

### Get Saved Searches

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/SavedSearchesResources.html

Retrieves a list of all saved search queries for the authenticated user. This corresponds to the GET /1.1/saved_searches.json API endpoint.

```APIDOC
## getSavedSearches

### Description
Returns the authenticated user's saved search queries.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/saved_searches.json

### Response
#### Success Response (200)
- **saved_searches** (ResponseList<SavedSearch>) - A list of saved searches.

#### Response Example
```json
[
  {
    "name": "#twitterapi",
    "url": "https:\/\/api.twitter.com\/1.1\/search\/tweets.json?q=%23twitterapi",
    "query": "#twitterapi",
    "position": 1,
    "created_at": "Mon Apr 20 23:17:10 +0000 2009",
    "id": 1234567890,
    "id_str": "1234567890"
  }
]
```
```

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

### links

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/TwitterStream.html

Starts listening on all public statuses containing links. This method is available only to approved parties and requires a signed agreement to access.

```APIDOC
## links

### Description
Starts listening on all public statuses containing links. Available only to approved parties and requires a signed agreement to access. Please do not contact us about access to the links stream. If your service warrants access to it, we'll contact you.

### Method
`TwitterStream` links(int count)

### Parameters
#### Path Parameters
- `count` (int) - Indicates the number of previous statuses to stream before transitioning to the live stream.

### Returns
- `TwitterStream` - this instance

### See Also
- Streaming API Methods statuses/links
```

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

### Get Geo Details

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/PlacesGeoResources.html

Retrieves detailed information about a specific place using its ID. This is useful for getting more context on a location previously identified through reverse geocoding.

```APIDOC
## GET /geo/id/:id.json

### Description
Find out more details of a place that was returned from the `reverseGeoCode(GeoQuery)` method.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/geo/id/:id.json

### Parameters
#### Path Parameters
- **placeId** (string) - Required - The ID of the location to query about.

### Response
#### Success Response (200)
- **Place** (object) - details of the specified place

#### Response Example
{
  "example": "{\"id\": \"247f43d4413c7177\", \"url\": \"https:\/\/api.twitter.com\/1.1\/geo\/id\/247f43d4413c7177.json\", \"name\": \"Twitter HQ\", \"full_name\": \"Twitter HQ\", \"country_code\": \"US\", \"bounding_box\": {\"type\": \"Polygon\"...}\"}"
}
```

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

### getStart() Method

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/URLEntity.html

Details for the getStart() method of the URLEntity interface.

```APIDOC
### getStart()

`int getStart()`

Returns the index of the start character of the URL mentioned in the tweet.

Specified by:
    `getStart` in interface `TweetEntity`

Returns:
    the index of the start character of the URL mentioned in the tweet
```

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

### getExtAltText()

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Returns the alternative text for extended media.

```APIDOC
## getExtAltText()

### Description
Returns the alternative text for extended media.

### Method
N/A (Method signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### TwitterStream.firehose

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Starts listening on all public statuses.

```APIDOC
## firehose(int)

### Description
Starts listening on all public statuses.

### Method
Method in twitter4j.v1.TwitterStream

### Parameters
* **limit** (int) - Description not available
```

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

### getInstance

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Factory method to get an instance of OAuthAuthorization.

```APIDOC
## getInstance()

### Description
Factory method to get an instance of OAuthAuthorization. Equivalent to OAuthAuthorization.newBuilder().build();

### Method
Static

### Class
OAuthAuthorization
```

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

### getInstance

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Factory method to get an instance of OAuth2Authorization.

```APIDOC
## getInstance()

### Description
Factory method to get an instance of OAuth2Authorization. Equivalent to OAuth2Authorization.newBuilder().build();

### Method
Static

### Class
OAuth2Authorization
```

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

### OAuthAuthorization getInstance()

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/OAuthAuthorization.html

Creates an OAuthAuthorization instance using default settings.

```APIDOC
## getInstance
public static OAuthAuthorization getInstance()

### Description
Equivalent to `OAuthAuthorization.newBuilder().build()`.

### Returns
`OAuthAuthorization` - An instance of OAuthAuthorization.
```

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

### User Language

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/User.html

Get the preferred language of the user.

```APIDOC
## User Language

### Description
Retrieves the preferred language setting for the user.

### Method
- `getLang()`

### Returns
- `String`: The preferred language of the user.
```

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

### sample (language)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/TwitterStream.html

Starts listening on a random sample of all public statuses, filtered by language. The default access level provides a small proportion of the Firehose.

```APIDOC
## sample

### Description
Starts listening on random sample of all public statuses. The default access level provides a small proportion of the Firehose. The "Gardenhose" access level provides a proportion more suitable for data mining and research applications that desire a larger proportion to be statistically significant sample. Only samples Tweets written in the given language.

### Method
`TwitterStream` sample(String language)

### Parameters
#### Path Parameters
- `language` (String) - language to be sampled

### Returns
- `TwitterStream` - this instance

### See Also
- Streaming API: Methods statuses/sample
```

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

### Create User List

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Constructs a UserList object from a raw JSON string. This is a static factory method.

```APIDOC
## createUserList(String json)

### Description
Constructs a UserList object from rawJSON string.

### Method
Static method

### Parameters
- **json** (String) - The raw JSON string representing the UserList.
```

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

### OEmbed.getWidth()

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Gets the width in pixels of the image specified in the url parameter.

```APIDOC
## getWidth()

### Description
Gets the width in pixels of the image specified in the url parameter.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **width** (int) - The width of the image in pixels.
```

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

### Create User List

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Creates a new list for the authenticated user. Requires list name, public status, and description.

```APIDOC
## createUserList

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

### Method Signature
`UserList createUserList(String listName, boolean isPublicList, String description)`
```

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

### Retweet Count

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Method to get the number of times a tweet has been retweeted.

```APIDOC
## Retweet Count

### Description
Method to get the number of times a tweet has been retweeted, or -1 when the tweet was created before this feature was enabled.

### Method
- `getRetweetCount()`
```

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

### includeExtAltTextEnabled

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/OAuthAuthorization.OAuthAuthorizationBuilder.html

Configures whether to include extended alternative text for media.

```APIDOC
## includeExtAltTextEnabled

### Description
Configures whether to include extended alternative text for media.

### Method Signature
public OAuthAuthorization.OAuthAuthorizationBuilder includeExtAltTextEnabled(boolean enabled)

### Parameters
* `enabled` (boolean) - Indicates if extended alt text inclusion should be enabled.
```

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

### Listed Count

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/User.html

Get the number of public lists the user is a member of.

```APIDOC
## Listed Count

### Description
Returns the count of public lists the user belongs to. Returns -1 if the count is unavailable.

### Method
- `getListedCount()`

### Returns
- `int`: The number of public lists the user is on, or -1 if unavailable.
```

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

### Status Count

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/User.html

Get the total number of statuses posted by the user.

```APIDOC
## Status Count

### Description
Returns the total number of tweets or statuses the user has posted.

### Method
- `getStatusesCount()`

### Returns
- `int`: The number of statuses posted by the user.
```

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

### APIStatisticsOpenMBean Constructor

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/management/APIStatisticsOpenMBean.html

Initializes a new instance of the APIStatisticsOpenMBean class with the provided API statistics.

```APIDOC
## APIStatisticsOpenMBean(APIStatistics apiStatistics)

### Description
Constructs a new APIStatisticsOpenMBean with the given API statistics.

### Parameters
* `apiStatistics` (APIStatistics) - The API statistics to be managed.
```

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

### OAuthAuthorization getInstance(String consumerKey, String consumerSecret)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/OAuthAuthorization.html

Creates an OAuthAuthorization instance with provided consumer key and secret.

```APIDOC
## getInstance
public static OAuthAuthorization getInstance(String consumerKey, String consumerSecret)

### Description
Equivalent to `OAuthAuthorization.newBuilder().oAuthConsumer(key, secret).build()`.

### Parameters
* `consumerKey` (String) - consumer key
* `consumerSecret` (String) - consumer secret

### Returns
`OAuthAuthorization` - An instance of OAuthAuthorization.
```

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

### OEmbedRequest Creation and Configuration

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/OEmbedRequest.html

This snippet demonstrates how to create an OEmbedRequest using the static `of` method and how to chain configuration methods to customize the request.

```APIDOC
## Static Method: OEmbedRequest.of

### Description
Creates a new `OEmbedRequest` instance with the mandatory `statusId` and `url`.

### Signature
`public static OEmbedRequest of(long statusId, String url)`

### Parameters
*   `statusId` (long) - The ID of the status to embed.
*   `url` (String) - The URL of the status to embed.

### Returns
*   `OEmbedRequest` - A new `OEmbedRequest` instance.

## Instance Methods for Configuration

### MaxWidth

#### Description
Sets the maximum width for the embedded content.

#### Signature
`public OEmbedRequest MaxWidth(int maxWidth)`

#### Parameters
*   `maxWidth` (int) - The maximum width in pixels.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### HideMedia

#### Description
Specifies whether to hide media associated with the tweet.

#### Signature
`public OEmbedRequest HideMedia(boolean hideMedia)`

#### Parameters
*   `hideMedia` (boolean) - `true` to hide media, `false` otherwise.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### HideThread

#### Description
Specifies whether to hide the entire tweet thread.

#### Signature
`public OEmbedRequest HideThread(boolean hideThread)`

#### Parameters
*   `hideThread` (boolean) - `true` to hide the thread, `false` otherwise.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### OmitScript

#### Description
Determines whether to omit the script tag in the embed output.

#### Signature
`public OEmbedRequest omitScript(boolean omitScript)`

#### Parameters
*   `omitScript` (boolean) - `true` to omit the script, `false` otherwise.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### Align

#### Description
Sets the alignment of the embedded content.

#### Signature
`public OEmbedRequest align(OEmbedRequest.Align align)`

#### Parameters
*   `align` (OEmbedRequest.Align) - The alignment value (e.g., LEFT, RIGHT, CENTER, NONE).

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### Related

#### Description
Specifies related accounts or topics to include in the embed.

#### Signature
`public OEmbedRequest related(String[] related)`

#### Parameters
*   `related` (String[]) - An array of strings representing related accounts or topics.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### Lang

#### Description
Sets the language for the embedded content.

#### Signature
`public OEmbedRequest lang(String lang)`

#### Parameters
*   `lang` (String) - The language code (e.g., "en").

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### WidgetType

#### Description
Specifies the type of widget to embed (e.g., TWEET, RICH_MEDIA).

#### Signature
`public OEmbedRequest widgetType(OEmbedRequest.WidgetType widgetType)`

#### Parameters
*   `widgetType` (OEmbedRequest.WidgetType) - The type of widget.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### HideTweet

#### Description
Specifies whether to hide the tweet itself, only showing media if applicable.

#### Signature
`public OEmbedRequest hideTweet(boolean hideTweet)`

#### Parameters
*   `hideTweet` (boolean) - `true` to hide the tweet, `false` otherwise.

#### Returns
*   `OEmbedRequest` - The modified `OEmbedRequest` instance.

### Example Usage
```java
OEmbedRequest request = OEmbedRequest.of(1234567890L, "https://twitter.com/user/status/1234567890")
    .MaxWidth(500)
    .HideMedia(false)
    .omitScript(true)
    .lang("en");
```
```

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

### createUserListSubscription (by ownerScreenName and slug)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Allows the authenticated user to follow a specified list using the owner's screen name and the list's slug. This method corresponds to the POST /1.1/list/subscribers/create.json API endpoint.

```APIDOC
## createUserListSubscription
UserList createUserListSubscription(String ownerScreenName, String slug) throws TwitterException

### Description
Make the authenticated user follow the specified list.

### Method
POST

### Endpoint
https://api.twitter.com/1.1/list/subscribers/create.json

### Parameters
#### Path Parameters
- **ownerScreenName** (String) - Required - The screen name of the user who owns the list being requested by a slug.
- **slug** (String) - Required - slug of the list

### Returns
- **UserList** - the updated list

### Throws
- **TwitterException** - when Twitter service or network is unavailable

### Since
Twitter4J 3.0.2
```

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

### showUserList(String, String)

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Shows the specified user list by owner's screen name and list slug.

```APIDOC
## showUserList(String, String)

### Description
Show the specified list.

### Method
N/A (Method signature in Java interface)

### Endpoint
N/A
```

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

### Version Class Method

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Static method to get the version of the Twitter library.

```APIDOC
## getVersion

### Description
Gets the version of the Twitter library.

### Method Signature
`getVersion()`
```

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

### Uploaded Media Progress

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Method to get the progress percentage of an uploaded media.

```APIDOC
## Uploaded Media Progress

### Description
Method to get the progress percentage of an uploaded media.

### Method
- `getProgressPercent()`
```

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

### Configure Twitter4J via System Properties

Source: https://twitter4j.org/configuration

Configure Twitter4J using system properties by prefixing property names with 'twitter4j.'. This is useful when launching Java applications.

```bash
$ java -Dtwitter4j.debug=true
    -Dtwitter4j.oauth.consumerKey=*********************
    -Dtwitter4j.oauth.consumerSecret=******************************************
    -Dtwitter4j.oauth.accessToken=**************************************************
    -Dtwitter4j.oauth.accessTokenSecret=******************************************
    -cp twitter4j-core-4.0.7.jar:yourApp.jar yourpackage.Main
```

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

### StatusAdapter Constructor

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/StatusAdapter.html

Initializes a new instance of the StatusAdapter class.

```APIDOC
## StatusAdapter Constructor

### Description
Initializes a new instance of the `StatusAdapter` class.

### Method
`public StatusAdapter()`
```

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

### getInstance

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Factory method to get an instance of OAuthAuthorization with consumer key and secret.

```APIDOC
## getInstance(String, String)

### Description
Factory method to get an instance of OAuthAuthorization with consumer key and secret. Equivalent to OAuthAuthorization.newBuilder().oAuthConsumer(key, secret).build();

### Method
Static

### Class
OAuthAuthorization

### Parameters
#### Path Parameters
- **key** (String) - Required - The consumer key.
- **secret** (String) - Required - The consumer secret.
```

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

### AccountSettings

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Interface for account settings.

```APIDOC
## Interface AccountSettings

Interface for account settings.
```

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

### getInstance

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Factory method to get an instance of OAuth2Authorization with consumer key and secret.

```APIDOC
## getInstance(String, String)

### Description
Factory method to get an instance of OAuth2Authorization with consumer key and secret. Equivalent to OAuth2Authorization.newBuilder().oAuthConsumer(key, secret).build();

### Method
Static

### Class
OAuth2Authorization

### Parameters
#### Path Parameters
- **key** (String) - Required - The consumer key.
- **secret** (String) - Required - The consumer secret.
```

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

### Withheld In Countries

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/User.html

Get the list of countries where the user's content is withheld.

```APIDOC
## Withheld In Countries

### Description
Returns a list of country codes where the user's profile or content is withheld from display.

### Method
- `getWithheldInCountries()`

### Returns
- `String[]`: An array of country codes where the user is withheld. Returns `null` if not withheld.
```

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

### Create User List

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Creates a new list for the authenticated user. Accounts are limited to 20 lists.

```APIDOC
## createUserList

### Description
Creates a new list for the authenticated user. Accounts are limited to 20 lists.

### Method
POST

### Endpoint
https://api.twitter.com/1.1/lists/create.json

### Parameters
#### Query Parameters
- **listName** (String) - The name of the list you are creating. Required.
- **isPublicList** (Boolean) - set true if you wish to make a public list
- **description** (String) - The description of the list you are creating. Optional.

### Returns
The list that was created.

### Throws
`TwitterException` - when Twitter service or network is unavailable, or the authenticated user already has 20 lists(TwitterException.getStatusCode() == 403).

### Since
Twitter4J 2.1.0
```

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

### Get Twitter4j Version

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/Version.html

Retrieves the current version string of the Twitter4j library.

```APIDOC
## getVersion

### Description
Returns the version string of the Twitter4j library.

### Method
```java
public static String getVersion()
```

### Returns
- `String`: The version string of the library.
```

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

### Twitter.TwitterBuilder.build

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Builds the Twitter instance.

```APIDOC
## Method build()

Builds the Twitter instance.
```

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

### Get Authorization Header

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/OAuth2Authorization.html

Generates the authorization header for a given HTTP request.

```APIDOC
## getAuthorizationHeader

### Description
Returns the authorization header for the request.

### Method
```java
public String getAuthorizationHeader(twitter4j.HttpRequest req)
```

### Specified by
`getAuthorizationHeader` in interface `Authorization`

### Parameters
#### Path Parameters
- **req** (twitter4j.HttpRequest) - request

### Returns
`String` - header
```

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

### Place Interface Methods

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/Place.html

This section details the methods available on the Place interface for retrieving specific information about a location.

```APIDOC
## Place Interface

This interface represents a geographic place within the Twitter API.

### Methods

*   **String getName()**
    Returns the name of the place.

*   **String getStreetAddress()**
    Returns the street address of the place.

*   **String getCountryCode()**
    Returns the country code of the place.

*   **String getId()**
    Returns the unique identifier of the place.

*   **String getCountry()**
    Returns the name of the country where the place is located.

*   **String getPlaceType()**
    Returns the type of the place (e.g., 'city', 'neighborhood').

*   **String getURL()**
    Returns the URL associated with the place.

*   **String getFullName()**
    Returns the full name of the place.

*   **String getBoundingBoxType()**
    Returns the type of the bounding box (e.g., 'Polygon').

*   **GeoLocation[][] getBoundingBoxCoordinates()**
    Returns the coordinates defining the bounding box of the place.

*   **String getGeometryType()**
    Returns the type of the geometry (e.g., 'Point').

*   **GeoLocation[][] getGeometryCoordinates()**
    Returns the coordinates defining the geometry of the place.

*   **Place[] getContainedWithIn()**
    Returns an array of places that contain this place.
```

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

### Show User List (by Owner Screen Name and Slug)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Shows the specified list. Private lists will only be shown if the authenticated user owns the specified list.

```APIDOC
## showUserList

### Description
Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/lists/show.json

### Parameters
#### Query Parameters
- **ownerScreenName** (String) - The screen name of the user who owns the list being requested by a slug.
- **slug** (String) - slug of the list

### Returns
The specified list.

### Throws
`TwitterException` - when Twitter service or network is unavailable.

### Since
Twitter4J 3.0.2
```

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

### TwitterStream.filter

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Starts consuming public statuses that match specified filter predicates.

```APIDOC
## filter(FilterQuery)

### Description
Start consuming public statuses that match one or more filter predicates.

### Method
Method in twitter4j.v1.TwitterStream

### Parameters
* **query** (FilterQuery) - The filter query to apply.
```

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

### getSleepStartTime

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/AccountSettings.html

Retrieves the start time of the user's sleep time setting.

```APIDOC
## getSleepStartTime

### Description
Returns sleep start time.

### Method
```java
String getSleepStartTime()
```

### Returns
- sleep start time
```

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

### OAuthAuthorization Instance Creation

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/OAuthAuthorization.html

Methods for creating pre-configured OAuthAuthorization instances.

```APIDOC
## getInstance()

### Description
Creates an `OAuthAuthorization` instance using default settings. This is equivalent to calling `OAuthAuthorization.newBuilder().build()`.

### Method
`static OAuthAuthorization`

### Endpoint
N/A (Static method)

### Parameters
None
```

```APIDOC
## getInstance(String consumerKey, String consumerSecret)

### Description
Creates an `OAuthAuthorization` instance with the provided consumer key and secret. This is equivalent to calling `OAuthAuthorization.newBuilder().oAuthConsumer(key, secret).build()`.

### Method
`static OAuthAuthorization`

### Endpoint
N/A (Static method)

### Parameters
- **consumerKey** (String) - The consumer key for authentication.
- **consumerSecret** (String) - The consumer secret for authentication.
```

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

### Raw JSON Retrieval

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Static method to get the raw JSON form of an object.

```APIDOC
## Raw JSON Retrieval

### Description
Static method to get the raw JSON form of an object. Note that raw JSON forms can be retrieved only from the same thread invoked the last method call and will become inaccessible once another method call.

### Method
- `getRawJSON(Object)`
```

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

### Show User List (by Owner ID and Slug)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Shows the specified list. Private lists will only be shown if the authenticated user owns the specified list.

```APIDOC
## showUserList

### Description
Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/lists/show.json

### Parameters
#### Query Parameters
- **ownerId** (long) - The user ID of the user who owns the list being requested by a slug.
- **slug** (String) - slug of the list

### Returns
The specified list.

### Throws
`TwitterException` - when Twitter service or network is unavailable.

### Since
Twitter4J 3.0.0
```

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

### Main Method for Version

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/Version.html

A main method provided for demonstration purposes, which prints the Twitter4j version to the console.

```APIDOC
## main

### Description
Prints the version string of the Twitter4j library to the console.

### Method
```java
public static void main(String[] args)
```

### Parameters
- `args` (String[]) - Ignored. This parameter is not used by the method.
```

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

### HelpResources

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/package-tree.html

Interface for accessing Help related resources.

```APIDOC
## Interface: HelpResources

### Description
Provides access to Twitter's Help API, including information about supported languages and trends.

### Methods
This interface is expected to contain methods for retrieving supported languages and other help-related information.
```

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

### Get Contributors by Screen Name

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/UsersResources.html

Returns an array of users who can contribute to the specified account.

```APIDOC
## GET users/contributors

### Description
Returns an array of users who can contribute to the specified account.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/users/contributors.json

### Parameters
#### Query Parameters
- **screenName** (String) - Required - The screen name of the user for whom to return results for.

### Response
#### Success Response (200)
- **contributors** (ResponseList<User>) - A list of contributors.

### Throws
- `TwitterException` - when Twitter service or network is unavailable
```

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

### OEmbed Methods

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Methods for interacting with the oEmbed resource.

```APIDOC
## getVersion

### Description
The oEmbed version number.

### Method Signature
`getVersion()`
```

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

### Get Contributors by User ID

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/UsersResources.html

Returns an array of users who can contribute to the specified account.

```APIDOC
## GET users/contributors

### Description
Returns an array of users who can contribute to the specified account.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/users/contributors.json

### Parameters
#### Query Parameters
- **userId** (long) - Required - The user ID of the user for whom to return results for.

### Response
#### Success Response (200)
- **contributors** (ResponseList<User>) - A list of contributors.

### Throws
- `TwitterException` - when Twitter service or network is unavailable
```

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

### Get Contributees by Screen Name

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/UsersResources.html

Returns an array of users that the specified user can contribute to.

```APIDOC
## GET users/contributors

### Description
Returns an array of users that the specified user can contribute to.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/users/contributors.json

### Parameters
#### Query Parameters
- **screenName** (String) - Required - The screen name of the user for whom to return results for.

### Response
#### Success Response (200)
- **contributors** (ResponseList<User>) - A list of contributors.

### Throws
- `TwitterException` - when Twitter service or network is unavailable
```

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

### createUserListSubscription (by ownerId and slug)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Allows the authenticated user to follow a specified list using the owner's user ID and the list's slug. This method corresponds to the POST /1.1/list/subscribers/create.json API endpoint.

```APIDOC
## createUserListSubscription
UserList createUserListSubscription(long ownerId, String slug) throws TwitterException

### Description
Make the authenticated user follow the specified list.

### Method
POST

### Endpoint
https://api.twitter.com/1.1/list/subscribers/create.json

### Parameters
#### Path Parameters
- **ownerId** (long) - Required - The user ID of the user who owns the list being requested by a slug.
- **slug** (String) - Required - slug of the list

### Returns
- **UserList** - the updated list

### Throws
- **TwitterException** - when Twitter service or network is unavailable

### Since
Twitter4J 3.0.0
```

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

### createUserList

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/TwitterObjectFactory.html

Constructs a UserList object from a raw JSON string.

```APIDOC
## createUserList

### Description
Constructs a UserList object from a raw JSON string.

### Method Signature
`public static UserList createUserList(String rawJSON) throws TwitterException`

### Parameters
* `rawJSON` (String) - The raw JSON form as a String.

### Returns
* `UserList` - A UserList object.

### Throws
* `TwitterException` - If the provided string is not a valid JSON string.
```

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

### Get Contributees by User ID

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/UsersResources.html

Returns an array of users that the specified user can contribute to.

```APIDOC
## GET users/contributors

### Description
Returns an array of users that the specified user can contribute to.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/users/contributors.json

### Parameters
#### Query Parameters
- **userId** (long) - Required - The user ID of the user for whom to return results for.

### Response
#### Success Response (200)
- **contributors** (ResponseList<User>) - A list of contributors.

### Throws
- `TwitterException` - when Twitter service or network is unavailable
```

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

### UserList Creation

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/TwitterObjectFactory.html

Constructs a UserList object from a raw JSON string.

```APIDOC
## createUserList

### Description
Constructs a UserList object from rawJSON string.

### Method Signature
`static UserList createUserList(String rawJSON)`
```

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

### Get Retweets of Me

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/TimelinesResources.html

Retrieves the 20 most recent tweets of the authenticated user that have been retweeted by others.

```APIDOC
## GET statuses/retweets_of_me

### Description
Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.

### Method
GET

### Endpoint
https://api.twitter.com/1.1/statuses/retweets_of_me.json

### Parameters
None

### Response
#### Success Response (200)
- **list** (ResponseList<Status>) - the 20 most recent tweets of the authenticated user that have been retweeted by others.

#### Response Example
```json
{
  "example": "response body"
}
```

### Throws
- **TwitterException** - when Twitter service or network is unavailable
```

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

### Get Retweets of Me

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/TimelinesResources.html

Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.

```APIDOC
## GET /statuses/retweets_of_me

### Description
Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.

### Method
GET

### Endpoint
/1.1/statuses/retweets_of_me

### Parameters
#### Query Parameters
- **count** (int) - Optional - Specifies the number of tweets to retrieve (up to 100).
- **since_id** (long) - Optional - Returns results with an ID greater than the specified ID.
- **max_id** (long) - Optional - Returns results with an ID less than or equal to the specified ID.
- **trim_user** (boolean) - Optional - When set to either true, t or 1 all strings will be omitted and this parameter will reduce the size of the response.

### Response
#### Success Response (200)
- **statuses** (list) - A list of Status objects representing tweets.

#### Response Example
{
  "statuses": [
    {
      "created_at": "Mon Sep 30 18:00:00 +0000 2013",
      "id": 384925191122345678,
      "text": "This is a retweet of my tweet."
    }
  ]
}
```

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

### Create User List Subscription

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Makes the authenticated user follow a specified list. This can be done using the list ID or list slug and owner screen name.

```APIDOC
## createUserListSubscription(long listId)

### Description
Makes the authenticated user follow the specified list by its ID.

### Method
POST

### Endpoint
/lists/subscribe.json

### Parameters
#### Query Parameters
- **list_id** (long) - Required - The ID of the list to subscribe to.
```

```APIDOC
## createUserListSubscription(long listId, String ownerScreenName)

### Description
Makes the authenticated user follow the specified list by its ID and the owner's screen name.

### Method
POST

### Endpoint
/lists/subscribe.json

### Parameters
#### Query Parameters
- **list_id** (long) - Required - The ID of the list to subscribe to.
- **owner_screen_name** (String) - Required - The screen name of the list owner.
```

```APIDOC
## createUserListSubscription(String listSlug, String ownerScreenName)

### Description
Makes the authenticated user follow the specified list by its slug and the owner's screen name.

### Method
POST

### Endpoint
/lists/subscribe.json

### Parameters
#### Query Parameters
- **slug** (String) - Required - The slug of the list to subscribe to.
- **owner_screen_name** (String) - Required - The screen name of the list owner.
```

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

### Get DM Image Stream

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/DirectMessagesResources.html

Returns a stream of an image included in direct messages.

```APIDOC
## GET DM Image Stream

### Description
Returns a stream of the image included in direct messages.

### Method
GET

### Endpoint
(URL provided in the `url` parameter)

### Parameters
#### Query Parameters
- **url** (String) - Required - The URL of the image to retrieve.

### Response
#### Success Response (200)
- **InputStream** - A stream of the image data.
```

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

### showUserList(long, String)

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Shows the specified user list by its ID and owner's screen name.

```APIDOC
## showUserList(long, String)

### Description
Show the specified list.

### Method
N/A (Method signature in Java interface)

### Endpoint
N/A
```

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

### OEmbedRequest Configuration

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Methods for configuring OEmbed requests.

```APIDOC
## MaxWidth(int)

### Description
Sets the maximum width for the OEmbed request.

### Method
Method

### Class
twitter4j.v1.OEmbedRequest
```

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

### Get Favorites (No Parameters)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/FavoritesResources.html

Returns the 20 most recent favorite statuses for the authenticating user.

```APIDOC
## GET /favorites.json

### Description
Returns the 20 most recent favorite statuses for the authenticating user.

### Method
GET

### Endpoint
/favorites.json

### Response
#### Success Response (200)
- **ResponseList<Status>** - A list of favorite statuses.

### Throws
- `TwitterException` - when Twitter service or network is unavailable
```

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

### UserList Interface Methods

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/UserList.html

This section details the methods available on the UserList interface for retrieving list information.

```APIDOC
## UserList Interface

A data interface representing Basic list information element.

### Methods

- **getId()** (long): Returns the id of the list.
- **getName()** (String): Returns the name of the list.
- **getFullName()** (String): Returns the full name of the list.
- **getSlug()** (String): Returns the slug of the list.
- **getDescription()** (String): Returns the description of the list.
- **getSubscriberCount()** (int): Returns the subscriber count of the list.
- **getMemberCount()** (int): Returns the member count of the list.
- **getURI()** (URI): Returns the uri of the list.
- **isPublic()** (boolean): Tests if the list is public.
- **getUser()** (User): Returns the user of the list.
- **isFollowing()** (boolean): Returns if the authenticated user is following the list.
- **getCreatedAt()** (LocalDateTime): Returns the date the list was created.
```

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

### Media Handling

Source: https://twitter4j.org/javadocs/4.1.2/index-all.html

Methods for handling media uploads and configurations.

```APIDOC
## media(File)

### Description
Sets the media file for the status update.

### Method
Method

### Class
twitter4j.v1.StatusUpdate
```

```APIDOC
## media(String, InputStream)

### Description
Sets the media name and input stream for the status update.

### Method
Method

### Class
twitter4j.v1.StatusUpdate
```

```APIDOC
## mediaIds(long...)

### Description
Sets the media IDs for the status update.

### Method
Method

### Class
twitter4j.v1.StatusUpdate
```

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

### Get User List Memberships

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/ListsResources.html

Retrieves lists that the authenticated user is a member of. Supports pagination.

```APIDOC
## getUserListMemberships

### Description
Returns lists that the authenticated user is a member of.

### Method Signature
`PagableResponseList<UserList> getUserListMemberships(int count, long cursor)`
```

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

### Configure Twitter4J via Environment Variables

Source: https://twitter4j.org/configuration

Configure Twitter4J using environment variables by prefixing property names with 'twitter4j_'. This method is common in server environments.

```bash
$ export twitter4j_debug=true
$ export twitter4j_oauth_consumerKey=*********************
$ export twitter4j_oauth_consumerSecret=******************************************
$ export twitter4j_oauth_accessToken=**************************************************
$ export twitter4j_oauth_accessTokenSecret=******************************************
$ java -cp twitter4j-core-4.1.1.jar:yourApp.jar yourpackage.Main
```

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

### Get Direct Message Image Stream

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/DirectMessagesResources.html

Returns a stream of the image included in direct messages.

```APIDOC
## GET /direct_messages/image_stream

### Description
Returns a stream of the image included in direct messages.

### Method
GET

### Endpoint
[URL of the image]

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```
GET [URL of the image]
```

### Response
#### Success Response (200)
- **InputStream** (object) - A stream of the image data.

#### Response Example
```
[Binary image data]
```
```

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

### Get Favorites (Paging)

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/FavoritesResources.html

Returns the 20 most recent favorite statuses for the authenticating user with pagination.

```APIDOC
## GET /favorites.json

### Description
Returns the 20 most recent favorite statuses for the authenticating user with pagination.

### Method
GET

### Endpoint
/favorites.json

### Parameters
#### Query Parameters
- **paging** (Paging) - Optional - Controls pagination. Supports sinceId and page parameters.

### Response
#### Success Response (200)
- **ResponseList<Status>** - A list of favorite statuses.

### Throws
- `TwitterException` - when Twitter service or network is unavailable
```

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

### Created At

Source: https://twitter4j.org/javadocs/4.1.2/twitter4j/v1/User.html

Retrieves the date and time when the user account was created.

```APIDOC
## getCreatedAt

### Description
Returns the date and time when the user account was created.

### Method Signature
`LocalDateTime getCreatedAt()`

### Returns
- `LocalDateTime`: the creation timestamp of the user account
```
Tokens:
Raw