twitter_api_v2

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

pub package Dart SDK Version Test Analyzer codecov Issues Pull Requests Stars Code size Last Commits License Contributor Covenant FOSSA Status

myconsciousness

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(
    consumerKey: 'YOUR_CONSUMER_KEY', // Or it's called "API Key"
    consumerSecret: 'YOUR_CONSUMER_SECRET', // Or it's called "API Secret"
    accessToken: 'YOUR_ACCESS_TOKEN',
    accessTokenSecret: 'YOUR_ACCESS_TOKEN_SECRET',
  );

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

    final response = await twitter.tweetService.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
  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

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. I'm not asking for royalties for use in providing this framework, but I do need support to continue ongoing open source development.

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

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

myconsciousness

1.5. License

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

FOSSA Status

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.

Libraries

twitter_api_v2