Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Supported Twitter methods

All methods are available in both XML and JSON formats. All methods use a GET request, unless explicitly specified below.

Get Public Timeline

Gets the public timeline

GET /twitter/statuses/public_timeline

...

Get messages from conversations

Returns all messages from conversations the user was engaged in.

GET /twitter/statuses/replies

...

Get friends timeline

Gets a friends timeline

GET /twitter/statuses/friends_timeline

...

Get a users timeline

Gets a users timeline

GET /twitter/statuses/user_timeline

This method also accepts a user name or id: statuses/user_timeline/name.jsonstatuses/user_timeline/id.xml

...

Get a user

Gets a users

GET /twitter/statuses/show

This method only accepts a user name or id: statuses/show/name.jsonstatuses/show/id.xml

...

Update

Posts a message

POST /twitter/statuses/update

...

Method

...

Parameters:

  • status: text of the message
  • source: application name or twitterapi by default

...

Get friends

Returns friends

GET /twitter/statuses/friends

This method also accepts a user name or id: statuses/friends/name.jsonstatuses/friends/id.xml

...

Get followers

Returns followers

GET /twitter/statuses/followers

This method also accepts a user name or id: statuses/followers/name.jsonstatuses/followers/id.xml

...

Get Direct Messages

Get direct

...

messages

Dummy method, returns empty collection. Included for compatibility with Twitter clients who request this method upon startup and fail if it returns an error.

...

Show Users

Returns users

GET /twitter/users/show

This method only accepts a user name or id: users/show/name.jsonusers/show/id.xml

...

Create Friendship

Returns users

POST /twitter/friendships/create

This method only accepts a user name or id: friendships/create/name.jsonfriendships/create/id.xml

...

Delete Friendships

Deletes friendships

POST

...

/twitter/friendships/destroy

This method only accepts a user name or id: friendships/destroy/name.jsonfriendships/destroy/id.xml

Method

POST

friendships/exists

...

...

Show existing friendships

Shows existing friendships

GET /twitter/friendships/exists

This method only accepts a user name or id: friendships/exists/name.jsonfriendships/exists/id.xml

Parameters:

  • user_a
  • user_b

...

Verify Credentials

Verifies the credentials

GET /twitter/verify

...

/credentials

Returns basic user information if the credentials are correct.

...

End Session

Ends the current session

POST /twitter/account/end_session

Method

POST

Returns basic user information if the credentials are correct.

...

You can find more about Twitter's own API at http://apiwiki.twitter.com/REST+API+/w/page/22554679/Twitter-API-Documentation.

Twitter API URL

You can configure the prefix for the Twitter-compatible API via the twitter.prefix property. The default value is twitter, if you want no prefix, use an empty string like this:

...