NAME¶

VERSION¶

SYNOPSIS¶

    ### Common usage ###

    use Twitter::API;
    my $client = Twitter::API->new_with_traits(
        traits              => 'Enchilada',
        consumer_key        => $YOUR_CONSUMER_KEY,
        consumer_secret     => $YOUR_CONSUMER_SECRET,
        access_token        => $YOUR_ACCESS_TOKEN,
        access_token_secret => $YOUR_ACCESS_TOKEN_SECRET,
    );

    my $me   = $client->verify_credentials;
    my $user = $client->show_user('twitter');

    # In list context, both the Twitter API result and a Twitter::API::Context
    # object are returned.
    my ($r, $context) = $client->home_timeline({ count => 200, trim_user => 1 });
    my $remaning = $context->rate_limit_remaining;
    my $until    = $context->rate_limit_reset;


    ### No frills ###

    my $client = Twitter::API->new(
        consumer_key    => $YOUR_CONSUMER_KEY,
        consumer_secret => $YOUR_CONSUMER_SECRET,
    );

    my $r = $client->get('account/verify_credentials', {
        -token        => $an_access_token,
        -token_secret => $an_access_token_secret,
    });

    ### Error handling ###

    use Twitter::API::Util 'is_twitter_api_error';
    use Try::Tiny;

    try {
        my $r = $client->verify_credentials;
    }
    catch {
        die $_ unless is_twitter_api_error($_);

        # The error object includes plenty of information
        say $_->http_request->as_string;
        say $_->http_response->as_string;
        say 'No use retrying right away' if $_->is_permanent_error;
        if ( $_->is_token_error ) {
            say "There's something wrong with this token."
        }
        if ( $_->twitter_error_code == 326 ) {
            say "Oops! Twitter thinks you're spam bot!";
        }
    };

DESCRIPTION¶

Features:

• full support for all Twitter REST API endpoints
• not dependent on a new distribution for new endpoint support
• optionally specify access tokens per API call
• error handling via an exception object that captures the full request/response context
• full support for OAuth handshake and Xauth authentication

Additional features are available via optional traits:

• convenient methods for API endpoints with simplified argument handling via ApiMethods
• normalized booleans (Twitter likes 'true' and 'false', except when it doesn't) via NormalizeBooleans
• automatic decoding of HTML entities via DecodeHtmlEntities
• automatic retry on transient errors via RetryOnError
• "the whole enchilada" combines all the above traits via Enchilada
• app-only (OAuth2) support via AppAuth
• automatic rate limiting via RateLimiting

Some features are provided by separate distributions to avoid additional dependencies most users won't want or need:

• async support via subclass Twitter::API::AnyEvent <https://github.com/semifor/Twitter-API-AnyEvent>
• inflate API call results to objects via Twitter::API::Trait::InflateObjects <https://github.com/semifor/Twitter-API-Trait-InflateObjects>

OVERVIEW¶

ATTRIBUTES¶

METHODS¶

SEE ALSO¶

• API::Twitter - Twitter.com API Client
• AnyEvent::Twitter::Stream - Receive Twitter streaming API in an event loop
• AnyEvent::Twitter - A thin wrapper for Twitter API using OAuth
• Mojo::WebService::Twitter - Simple Twitter API client
• Net::Twitter - Twitter::API's predecessor (also Net::Twitter::Lite)

AUTHOR¶

COPYRIGHT AND LICENSE¶

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.