Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redouane59/twittered
Twitter API client for Java developers
https://github.com/redouane59/twittered
java twitter twitter-api twitter-api-stream twitter-api-v2 twitter-apis twitter-app twitter-application twitter-authentication twitter-bot twitter-cli twitter-client twitter-json twitter-library twitter-search
Last synced: 2 months ago
JSON representation
Twitter API client for Java developers
- Host: GitHub
- URL: https://github.com/redouane59/twittered
- Owner: redouane59
- License: apache-2.0
- Created: 2020-01-26T17:20:50.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-31T14:27:45.000Z (6 months ago)
- Last Synced: 2024-08-04T02:08:36.771Z (6 months ago)
- Topics: java, twitter, twitter-api, twitter-api-stream, twitter-api-v2, twitter-apis, twitter-app, twitter-application, twitter-authentication, twitter-bot, twitter-cli, twitter-client, twitter-json, twitter-library, twitter-search
- Language: Java
- Homepage:
- Size: 9.15 MB
- Stars: 237
- Watchers: 11
- Forks: 64
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This project is a JAVA library which allows you to consume the Twitter API.
[](https://developer.twitter.com/en/docs/twitter-api)
[](https://developer.twitter.com/en/docs/api-reference-index)
[](https://developer.twitter.com/en/docs/tweets/search/api-reference/premium-search)
### Configuration
In your pom.xml, add the following dependency and replace `VERSION` with the version you wish:
```xml
io.github.redouane59.twitter
twittered
VERSION
```
If you are using Gradle Kotlin DSL, make sure you have MavenCentral among the available repositories:
```kotlin
repositories {
mavenCentral()
// [...]
}
```
Then add the following line to your `dependencies` block:
```kotlin
implementation("io.github.redouane59.twitter:twittered:VERSION")
```
To be able to see library logs, also add sl4j references :
```xml
org.slf4j
slf4j-api
1.7.30
org.slf4j
slf4j-simple
1.7.30
```
In order to use your own developer credentials, you have several options :
#### Using a json file
File example :
```json
{
"apiKey": "xxx",
"apiSecretKey": "xxx",
"accessToken": "xxx",
"accessTokenSecret": "xxx"
}
```
##### With program argument
Pass through java argument your file path like `-Dtwitter.credentials.file.path=/your/path/to/json`
. Then instantiate the client like
```java
TwitterClient client = new TwitterClient();
```
or
##### Using deserialization in your code
```java
TwitterClient twitterClient = new TwitterClient(TwitterClient.OBJECT_MAPPER
.readValue(new File("/your/path/to/json"), TwitterCredentials.class));
```
#### With hard-coded values
```java
TwitterClient twitterClient = new TwitterClient(TwitterCredentials.builder()
.accessToken("")
.accessTokenSecret("")
.apiKey("")
.apiSecretKey("")
.build());
```
NB : Your twitter credentials can be found
in [your twitter app page](https://developer.twitter.com/en/apps) in the _Key and tokens_
page.
### Available methods
See :
- [ITwitterClientV2.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/ITwitterClientV2.java)
- [ITwitterClientV1.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/ITwitterClientV1.java)
- [Tweet.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/dto/tweet/Tweet.java)
- [User.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/dto/user/User.java)
### Code samples
See :
- [ITwitterClientV2Test.java](https://github.com/redouane59/twittered/blob/develop/src/test/java/io/github/redouane59/twitter/nrt/ITwitterClientV2Test.java)
- [ITwitterClientV2AuthenticatedTest.java](https://github.com/redouane59/twittered/blob/develop/src/test/java/io/github/redouane59/twitter/nrt/ITwitterClientV2AuthenticatedTest.java)
- [ITwitterClientV1Test.java](https://github.com/redouane59/twittered/blob/develop/src/test/java/io/github/redouane59/twitter/nrt/ITwitterClientV1Test.java)
### Basic examples
#### 1. Init TwitterClient
```java
TwitterClient twitterClient = new TwitterClient(TwitterClient.OBJECT_MAPPER
.readValue(new File("/your/path/to/json"), TwitterCredentials.class));
```
#### 2. Get Tweet object from tweet id and display some information
```java
Tweet tweet = twitterClient.getTweet("1224041905333379073");
System.out.println(tweet.getText());
System.out.println(tweet.getCreatedAt());
System.out.println(tweet.getLang());
System.out.println(tweet.getLikeCount());
System.out.println(tweet.getRetweetCount());
System.out.println(tweet.getReplyCount());
System.out.println(tweet.getUser().getName());
```
#### 3. Get User object from username and display some information
```java
User user = twitterClient.getUserFromUserName("RedouaneBali");
System.out.println(user.getName());
System.out.println(user.getDisplayedName());
System.out.println(user.getDateOfCreation());
System.out.println(user.getDescription());
System.out.println(user.getTweetCount());
System.out.println(user.getFollowersCount());
System.out.println(user.getFollowingCount());
System.out.println(user.getPinnedTweet());
System.out.println(user.getPinnedTweet());
System.out.println(user.getLocation());
System.out.println(user.getId());
System.out.println(user.getUrl());
```
### Contribution
If you want to contribute to the project, don't hesitate to submit pull requests. To add a new
feature :
- Create the interface method in the related interface (
e.g [ITwitterClientV2.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/ITwitterClientV2.java))
- If needed, add the endpoint URL
in [URLHelper.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/helpers/URLHelper.java)
- Implement your method in the child class (
e.g [TwitterClient.java](https://github.com/redouane59/twittered/blob/develop/src/main/java/io/github/redouane59/twitter/TwitterClient.java))
- Don't forget to add your unit tests in `src/test/java/io/github/redouane59/twitter/unit`
Code style is also available in `.idea/codeStyles/GoogleStyle.xml` file.
### External Resources
[Twitter Developers docs](https://developer.twitter.com/en/docs)
### Special thanks
I would like to give special thanks to
[@hypr2771](https://github.com/hypr2771)
[@mmornati](https://github.com/mmornati)
[@andypiper](https://github.com/andypiper)
[@igorbrigadir](https://github.com/igorbrigadir)
[@sparack](https://github.com/sparack)
for having helped me building this Twitter API library for Java. The tool is now working and I hope
that students, junior and senior developers will enjoy it, being able to play easily with twitter
data using Java programming language.