twitter_api_v2 1.8.0

The lightweight and powerful wrapper library for Twitter API v2.0 written in Dart language. It works cross-platform.

The Lightweight and Cross-Platform Wrapper for Twitter API v2.0 🐦

---

---

• 1. Guide
  • 1.1. Getting Started
    • 1.1.1. Install Library
    • 1.1.2. Import
    • 1.1.3. Implementation
  • 1.2. Supported Endpoints
  • 1.3. Contribution
  • 1.4. Support
  • 1.5. License
  • 1.6. More Information

1. Guide

This library provides the easiest way to use Twitter API v2.0.

Show some ❤️ and star the repo to support the project.

1.1. Getting Started

1.1.1. Install Library

With Dart:

 dart pub add twitter_api_v2

Or With Flutter:

 flutter pub add twitter_api_v2

1.1.2. Import

import 'package:twitter_api_v2/twitter_api_v2';

1.1.3. Implementation

import 'package:twitter_api_v2/twitter_api_v2.dart' as v2;

void main() async {
  //! You need to get keys and tokens at https://developer.twitter.com
  final twitter = v2.TwitterApi(
    //! Authentication with OAuth2.0 is the default.
    //!
    //! Note that to use endpoints that require certain user permissions,
    //! such as Tweets and Likes, you need a token issued by OAuth2.0 PKCE.
    bearerToken: 'YOUR_TOKEN_HERE',

    //! Or perhaps you would prefer to use the good old OAuth1.0a method
    //! over the OAuth2.0 PKCE method. Then you can use the following code
    //! to set the OAuth1.0a tokens.
    //!
    //! However, note that some endpoints cannot be used for OAuth 1.0a method
    //! authentication.
    oauthTokens: v2.OAuthTokens(
      consumerKey: 'YOUR_CONSUMER_KEY_HERE',
      consumerSecret: 'YOUR_CONSUMER_SECRET_HERE',
      accessToken: 'YOUR_ACCESS_TOKEN_HERE',
      accessTokenSecret: 'YOUR_ACCESS_TOKEN_SECRET_HERE',
    ),
  );

  try {
    final me = await twitter.usersService.lookupMe();
    final tweets = await twitter.tweetsService.searchRecent(query: '#ElonMusk');

    final response = await twitter.tweetsService.createLike(
      userId: me.data.id,
      tweetId: tweets.data.first.id,
    );

    print(response);
  } on v2.TwitterException catch (e) {
    print(e.response.headers);
    print(e.response.body);
  }
}

1.2. Supported Endpoints

1. Tweets Service

   1. Manage Tweet
      1. DELETE /2/tweets/:id
      2. POST /2/tweets
   2. Likes
      1. DELETE /2/users/:id/likes/:tweet_id
      2. GET /2/tweets/:id/liking_users
      3. GET /2/users/:id/liked_tweets
      4. POST /2/users/:id/likes
   3. Retweets
      1. DELETE /2/users/:id/retweets/:source_tweet_id
      2. GET /2/tweets/:id/retweeted_by
      3. POST /2/users/:id/retweets
   4. Quote Tweets
      1. GET /2/tweets/:id/quote_tweets
   5. Search Tweets
      1. GET /2/tweets/search/all
      2. GET /2/tweets/search/recent
   6. Lookup Tweets
      1. GET /2/tweets
      2. GET /2/tweets/:id
   7. Tweet Counts
      1. GET /2/tweets/counts/all
      2. GET /2/tweets/counts/recent
   8. Bookmarks
      1. GET /2/tweets/counts/all
      2. GET /2/tweets/counts/recent
   9. Timelines
      1. GET /2/users/:id/mentions
      2. GET /2/users/:id/tweets

2. Users

   1. Follows
      1. DELETE /2/users/:source_user_id/following/:target_user_id
      2. GET /2/users/:id/followers
      3. GET /2/users/:id/following
      4. POST /2/users/:id/following
   2. Lookup Users
      1. GET /2/users
      2. GET /2/users/:id
      3. GET /2/users/by
      4. GET /2/users/by/username/:username
      5. GET /2/users/me
   3. Users Mutes
      1. DELETE /2/users/:source_user_id/muting/:target_user_id
      2. GET /2/users/:id/muting
      3. POST /2/users/:id/muting
   4. Hide Replies
      1. PUT /2/tweets/:id/hidden
   5. Blocks
      1. DELETE /2/users/:source_user_id/blocking/:target_user_id
      2. GET /2/users/:id/blocking
      3. POST /2/users/:id/blocking

3. Spaces

   1. Search Spaces
      1. GET /2/spaces/search
   2. Lookup Spaces
      1. GET /2/spaces
      2. GET /2/spaces/:id
      3. GET /2/spaces/:id/buyers
      4. GET /2/spaces/:id/tweets
      5. GET /2/spaces/by/creator_ids

4. Lists

   1. Lookup Lists
      1. GET /2/lists/:id
      2. GET /2/users/:id/owned_lists
   2. Pinnings
      1. DELETE /2/users/:id/pinned_lists/:list_id
      2. GET /2/users/:id/pinned_lists
      3. POST /2/users/:id/pinned_lists
   3. Tweet Lookup
      1. GET /2/lists/:id/tweets
   4. Manage
      1. DELETE /2/lists/:id
      2. PUT /2/lists/:id
      3. POST /2/lists
   5. Follows
      1. DELETE /2/users/:id/followed_lists/:list_id
      2. GET /2/lists/:id/followers
      3. GET /2/users/:id/followed_lists
      4. POST /2/users/:id/followed_lists
   6. Members
      1. DELETE /2/lists/:id/members/:user_id
      2. GET /2/lists/:id/members
      3. GET /2/users/:id/list_memberships
      4. POST /2/lists/:id/members

5. Compliance

   1. Batch Compliance
      1. GET /2/compliance/jobs
      2. GET /2/compliance/jobs/:id
      3. POST /2/compliance/jobs

Note:
Not all additional fields listed in the official documentation are supported. We intend to support them step by step.
Also you can create an Issue or Pull Request if you wish to suggest or contribute!

1.3. Contribution

If you would like to contribute to twitter_api_v2, please create an issue or create a Pull Request.

Owner will respond to issues and review pull requests as quickly as possible.

1.4. Support

The simplest way to show us your support is by giving the project a star at here.

And I'm always looking for sponsors to support this project.

Sponsors can be individuals or corporations, and the amount is optional.

👇 Click on the button below to see more details! 👇

1.5. License

All resources of twitter_api_v2 is provided under the BSD-3 license.

Note: License notices in the source are strictly validated based on .github/header-checker-lint.yml. Please check header-checker-lint.yml for the permitted standards.

1.6. More Information

twitter_api_v2 was designed and implemented by Kato Shinya.

• Creator Profile
• License
• API Document
• Release Note
• Bug Report