• Stars
    star
    1,782
  • Rank 24,549 (Top 0.6 %)
  • Language
    Ruby
  • License
    MIT License
  • Created over 14 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

OAuth-enabled curl for the Twitter API

Twurl

MIT License Gem Version CI

Twurl is like curl, but tailored specifically for the Twitter API. It knows how to grant an access token to a client application for a specified user and then sign all requests with that access token.

It also provides other development and debugging conveniences such as defining aliases for common requests, as well as support for multiple access tokens to easily switch between different client applications and Twitter accounts.

Installing Twurl

Twurl can be installed using RubyGems:

gem install twurl

Getting Started

If you haven't already, the first thing to do is apply for a developer account to access Twitter APIs:

https://developer.twitter.com/en/apply-for-access

After you have that access you can create a Twitter app and generate a consumer key and secret.

When you have your consumer key and its secret you authorize your Twitter account to make API requests with that consumer key and secret.

twurl authorize --consumer-key key       \
                --consumer-secret secret

This will return an URL that you should open up in your browser. Authenticate to Twitter, and then enter the returned PIN back into the terminal. Assuming all that works well, you will be authorized to make requests with the API. Twurl will tell you as much.

Making Requests

The simplest request just requires that you specify the path you want to request.

twurl /1.1/statuses/home_timeline.json

Similar to curl, a GET request is performed by default.

You can implicitly perform a POST request by passing the -d option, which specifies POST parameters.

twurl -d 'status=Testing twurl' /1.1/statuses/update.json

You can explicitly specify what request method to perform with the -X (or --request-method) option.

twurl -X POST /1.1/statuses/destroy/1234567890.json

Using Bearer Tokens (Application-only authentication)

You can generate a bearer token using --bearer option in combination with the authorize subcommand.

twurl authorize --bearer --consumer-key key       \
                         --consumer-secret secret

And then, you can make a request using a generated bearer token using --bearer request option.

twurl --bearer '/1.1/search/tweets.json?q=hello'

To list your generated bearer tokens, you can use the bearer_tokens subcommand.

twurl bearer_tokens

This will print a pair of consumer_key and its associated bearer token. Note, tokens are omitted from this output.

Accessing Different Hosts

You can access different hosts for other Twitter APIs using the -H flag.

twurl -H "ads-api.twitter.com" "/7/accounts"

Uploading Media

To upload binary files, you can format the call as a form post. Below, the binary is "/path/to/media.jpg" and the form field is "media":

twurl -H "upload.twitter.com" -X POST "/1.1/media/upload.json" --file "/path/to/media.jpg" --file-field "media"

Creating aliases

twurl alias h /1.1/statuses/home_timeline.json

You can then use "h" in place of the full path.

twurl h

Paths that require additional options (such as request parameters, for example) can be used with aliases the same as with full explicit paths, just as you might expect.

twurl alias tweet /1.1/statuses/update.json
twurl tweet -d "status=Aliases in twurl are convenient"

Changing your default profile

The first time you authorize a client application to make requests on behalf of your account, twurl stores your access token information in its ~/.twurlrc file. Subsequent requests will use this profile as the default profile. You can use the accounts subcommand to see what client applications have been authorized for what user names:

twurl accounts
  noradio
    HQsAGcBm5MQT4n6j7qVJw
    hhC7Koy2zRsTZvQh1hVlSA (default)
  testiverse
    guT9RsJbNQgVe6AwoY9BA

Notice that one of those consumer keys is marked as the default. To change the default use the set subcommand, passing then either just the username, if it's unambiguous, or the username and consumer key pair if it isn't unambiguous:

twurl set default testiverse
twurl accounts
  noradio
    HQsAGcBm5MQT4n6j7qVJw
    hhC7Koy2zRsTZvQh1hVlSA
  testiverse
    guT9RsJbNQgVe6AwoY9BA (default)
twurl set default noradio HQsAGcBm5MQT4n6j7qVJw
twurl accounts
  noradio
    HQsAGcBm5MQT4n6j7qVJw (default)
    hhC7Koy2zRsTZvQh1hVlSA
  testiverse
    guT9RsJbNQgVe6AwoY9BA

Profiles and Bearer Tokens

While changing the default profile allows you to select which access token (OAuth1.0a) to use, bearer tokens don't link to any user profiles as the Application-only authentication doesn't require user context. That is, you can make an application-only request regardless of your default profile if you specify the -c (--consumer-key) option once you generate a bearer token with this consumer key. By default, twurl reads the current profile's consumer key and its associated bearer token from ~/.twurlrc file.

Contributors

Marcel Molina / @noradio

Erik Michaels-Ober / @sferik

and there are many more!

More Repositories

1

the-algorithm

Source code for Twitter's Recommendation Algorithm
Scala
60,419
star
2

typeahead.js

typeahead.js is a fast and fully-featured autocomplete library
JavaScript
16,540
star
3

twemoji

Emoji for everyone. https://twemoji.twitter.com/
HTML
16,448
star
4

twemproxy

A fast, light-weight proxy for memcached and redis
C
11,940
star
5

the-algorithm-ml

Source code for Twitter's Recommendation Algorithm
Python
9,788
star
6

finagle

A fault tolerant, protocol-agnostic RPC system
Scala
8,716
star
7

hogan.js

A compiler for the Mustache templating language
JavaScript
5,139
star
8

labella.js

Placing labels on a timeline without overlap.
JavaScript
3,864
star
9

scala_school

Lessons in the Fundamentals of Scala
HTML
3,698
star
10

AnomalyDetection

Anomaly Detection with R
R
3,525
star
11

scalding

A Scala API for Cascading
Scala
3,465
star
12

twitter-text

Twitter Text Libraries. This code is used at Twitter to tokenize and parse text to meet the expectations for what can be used on the platform.
HTML
3,041
star
13

TwitterTextEditor

A standalone, flexible API that provides a full-featured rich text editor for iOS applications.
Swift
2,938
star
14

opensource-website

Twitter's open source website, identifying projects we've released, organizations we support, and the work we do to support open source.
SCSS
2,852
star
15

util

Wonderful reusable code from Twitter
Scala
2,671
star
16

algebird

Abstract Algebra for Scala
Scala
2,275
star
17

finatra

Fast, testable, Scala services built on TwitterServer and Finagle
Scala
2,269
star
18

effectivescala

Twitter's Effective Scala Guide
HTML
2,237
star
19

summingbird

Streaming MapReduce with Scalding and Storm
Scala
2,137
star
20

pelikan

Pelikan is Twitter's unified cache backend
C
1,914
star
21

ios-twitter-image-pipeline

Twitter Image Pipeline is a robust and performant image loading and caching framework for iOS clients
C
1,850
star
22

rezolus

Systems performance telemetry
Rust
1,539
star
23

twitter-server

Twitter-Server defines a template from which services at Twitter are built
Scala
1,522
star
24

activerecord-reputation-system

An Active Record Reputation System for Rails
Ruby
1,335
star
25

fatcache

Memcache on SSD
C
1,306
star
26

compose-rules

Static checks to aid with a healthy adoption of Compose
Kotlin
1,293
star
27

rsc

Experimental Scala compiler focused on compilation speed
Scala
1,243
star
28

communitynotes

Documentation and source code powering Twitter's Community Notes
Python
1,146
star
29

elephant-bird

Twitter's collection of LZO and Protocol Buffer-related Hadoop, Pig, Hive, and HBase code.
Java
1,139
star
30

cassovary

Cassovary is a simple big graph processing library for the JVM
Scala
1,039
star
31

Serial

Light-weight, fast framework for object serialization in Java, with Android support.
Java
982
star
32

hbc

A Java HTTP client for consuming Twitter's realtime Streaming API
Java
962
star
33

twemcache

Twemcache is the Twitter Memcached
C
926
star
34

innovators-patent-agreement

Innovators Patent Agreement (IPA)
917
star
35

vireo

Vireo is a lightweight and versatile video processing library written in C++11
C++
915
star
36

twitter-korean-text

Korean tokenizer
Scala
831
star
37

scrooge

A Thrift parser/generator
Scala
785
star
38

BreakoutDetection

Breakout Detection via Robust E-Statistics
C++
751
star
39

GraphJet

GraphJet is a real-time graph processing library.
Java
694
star
40

twitter-cldr-rb

Ruby implementation of the ICU (International Components for Unicode) that uses the Common Locale Data Repository to format dates, plurals, and more.
Ruby
663
star
41

bijection

Reversible conversions between types
Scala
662
star
42

chill

Scala extensions for the Kryo serialization library
Scala
603
star
43

ios-twitter-network-layer

Twitter Network Layer is a scalable and feature rich network layer built on top of NSURLSession for Apple platforms
Objective-C
572
star
44

hadoop-lzo

Refactored version of code.google.com/hadoop-gpl-compression for hadoop 0.20
Shell
544
star
45

storehaus

Storehaus is a library that makes it easy to work with asynchronous key value stores
Scala
465
star
46

rpc-perf

A tool for benchmarking RPC services
Rust
459
star
47

d3kit

D3Kit is a set tools to speed D3 related project development
JavaScript
427
star
48

scoot

Scoot is a distributed task runner, supporting both a proprietary API and Bazel's Remote Execution.
Go
347
star
49

twitter-cldr-js

JavaScript implementation of the ICU (International Components for Unicode) that uses the Common Locale Data Repository to format dates, plurals, and more. Based on twitter-cldr-rb.
JavaScript
344
star
50

scala_school2

Scala School 2
Scala
342
star
51

rustcommon

Common Twitter Rust lib
Rust
340
star
52

wordpress

The official Twitter plugin for WordPress. Embed Twitter content and grow your audience on Twitter.
PHP
311
star
53

ios-twitter-logging-service

Twitter Logging Service is a robust and performant logging framework for iOS clients
Objective-C
300
star
54

nodes

A library to implement asynchronous dependency graphs for services in Java
Java
246
star
55

SentenTree

A novel text visualization technique
JavaScript
223
star
56

interactive

Twitter interactive visualization
HTML
213
star
57

joauth

A Java library for authenticating HTTP Requests using OAuth
Java
210
star
58

thrift_client

A Thrift client wrapper that encapsulates some common failover behavior
Ruby
196
star
59

hpack

Header Compression for HTTP/2
Java
194
star
60

zktraffic

ZooKeeper protocol analyzer and stats gathering daemon
Python
164
star
61

twemoji-parser

A simple library for identifying emoji entities within a string in order to render them as Twemoji.
Scala
157
star
62

sbf

Java
154
star
63

cache-trace

A collection of Twitter's anonymized production cache traces.
Shell
151
star
64

tormenta

Scala extensions for Storm
Scala
132
star
65

whiskey

HTTP library for Android (beta)
Java
132
star
66

hraven

hRaven collects run time data and statistics from MapReduce jobs in an easily queryable format
Java
129
star
67

netty-http2

HTTP/2 for Netty
Java
121
star
68

ccommon

Cache Commons
C
99
star
69

sqrl

A Safe, Stateful Rules Language for Event Streams
TypeScript
99
star
70

focus

Focus aligns Git worktree content based on outlines of a repository's Bazel build graph. Focused repos are sparse, shallow, and thin and unlock markedly better performance in large repos.
Rust
89
star
71

dict_minimize

Access scipy optimizers from your favorite deep learning framework.
Python
74
star
72

metrics

74
star
73

twitter.github.io

HTML
71
star
74

go-bindata

Go
67
star
75

diffusion-rl

Python
65
star
76

birdwatch

64
star
77

cloudhopper-commons

Cloudhopper Commons
Java
57
star
78

twitter-cldr-npm

TwitterCldr npm package
JavaScript
49
star
79

.github

Twitter GitHub Organization-wide files
46
star
80

bazel-multiversion

Bazel rules to resolve, fetch and manage 3rdparty JVM dependencies with support for multiple parallel versions of the same dependency. Powered by Coursier.
Scala
45
star
81

libwatchman

A C interface to watchman
C
44
star
82

sslconfig

Twitter's OpenSSL Configuration
42
star
83

gatekeeper-service

GateKeeper is a service built to automate the manual steps involved in onboarding, offboarding, and lost asset scenarios.
Python
36
star
84

ios-twitter-apache-thrift

A thrift encoding and decoding library for Swift
Swift
36
star
85

dodo

The Twitter OSS Project Builder
Shell
35
star
86

repo-scaffolding

Tools for creating repos based on open source standards and best practices
31
star
87

iago2

A load generator, built for engineers
Scala
24
star
88

caladrius

Performance modelling system for Distributed Stream Processing Systems (DSPS) such as Apache Heron and Apache Storm
Python
22
star
89

ossdecks

Repository for Twitter Open Source Decks
10
star
90

curation-style-guide

Document Repository for Twitter's Curation Style Guide
10
star
91

analytics-infra-governance

Description of the process for how to commit, review, and release code to the Scalding OSS family (Scalding, Summingbird, Algebird, Bijection, Storehaus, etc)
9
star
92

gpl-commitment

Twitter's GPL Cooperation Commitment
5
star
93

second-control-probability-distributions

4
star
94

google-tag-manager-event-tag

Smarty
3
star
95

google-tag-manager-base-tag

Smarty
2
star