CINXE.COM

<!DOCTYPE html><head><script type="text/javascript" src="/_static/js/bundle-playback.js?v=HxkREWBo" charset="utf-8"></script> <script type="text/javascript" src="/_static/js/wombat.js?v=txqj7nKC" charset="utf-8"></script> <script>window.RufflePlayer=window.RufflePlayer||{};window.RufflePlayer.config={"autoplay":"on","unmuteOverlay":"hidden"};</script> <script type="text/javascript" src="/_static/js/ruffle/ruffle.js"></script> <script type="text/javascript"> __wm.init("https://web.archive.org/web"); __wm.wombat("https://dev.twitter.com/docs","20111109103732","https://web.archive.org/","web","/_static/", "1320835052"); </script> <link rel="stylesheet" type="text/css" href="/_static/css/banner-styles.css?v=S1zqJCYt" /> <link rel="stylesheet" type="text/css" href="/_static/css/iconochive.css?v=3PDvdIFv" />  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Documentation | Twitter Developers</title> <script src="https://web.archive.org/web/20111109103732js_/https://platform.twitter.com/widgets.js" type="text/javascript"></script> <link rel="shortcut icon" href="/web/20111109103732im_/https://dev.twitter.com/sites/all/themes/twitter_commons/favicon.ico" type="image/x-icon"/> <link type="text/css" rel="stylesheet" media="all" href="/web/20111109103732cs_/https://dev.twitter.com/sites/default/files/css/css_4bec37e0724c1af952a30b91314160ed.css"/> <script type="text/javascript" src="/web/20111109103732js_/https://dev.twitter.com/sites/default/files/js/js_6a0ca864189781d957cde9705a092b22.js"></script> <script type="text/javascript"> <![CDATA[//><!]]> </script> </head> <body id="page-docs" class="not-front not-logged-in no-sidebars"> <div id="page"> <a href="#content-main" class="skip">Skip to Main Content Area</a> <div id="header-outer"> <div id="header"> <a href="/web/20111109103732/https://dev.twitter.com/" id="logo" title="Home"> Developers </a> <form action="/web/20111109103732/https://dev.twitter.com/docs" accept-charset="UTF-8" method="post" id="search-theme-form"> <input id="search-q" name="search_theme_form" type="text" maxlength="128" size="15" value="Search" title="Enter search terms" placeholder="Search"/> <input id="search-submit" name="op" type="submit" value="Search"/> <input type="hidden" name="form_build_id" id="form-1be551ad2e0c8c2e72c2e42dc09ccaa9" value="form-1be551ad2e0c8c2e72c2e42dc09ccaa9"/> <input type="hidden" name="form_id" id="edit-search-theme-form" value="search_theme_form"/> </form> <ul id="title-nav"><li class="expanded first"><a href="/web/20111109103732/https://dev.twitter.com/status" title="">API Health</a><ul class="menu"><li class="leaf first"><a href="/web/20111109103732/https://dev.twitter.com/status" title="">API Status</a></li> <li class="leaf last"><a href="/web/20111109103732/https://dev.twitter.com/issues" title="">API Issues</a></li> </ul></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/blog" title="">Blog</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/discussions" title="">Discussions</a></li> <li class="expanded active-trail"><a href="/web/20111109103732/https://dev.twitter.com/docs" title="" class="active">Documentation</a><ul class="menu"><li class="leaf first"><a href="/web/20111109103732/https://dev.twitter.com/docs" title="" class="active">Overview</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/docs/api" title="">REST API</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/docs/streaming-api" title="Streaming API">Streaming API</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/docs/twitter-for-websites" title="">Twitter for Websites</a></li> <li class="leaf last"><a href="/web/20111109103732/https://dev.twitter.com/docs/recent" title="">Recently updated</a></li> </ul></li> <li class="leaf last"><a href="/web/20111109103732/https://dev.twitter.com/user/login?destination=docs" title="">Sign in</a></li> </ul> </div> </div> <div id="content-outer"> <div id="breadcrumbs"> <div class="breadcrumb"><a href="/web/20111109103732/https://dev.twitter.com/">Home</a><div></div></div> </div> <h1 id="title">Documentation</h1> <div id="content-inner"> <div id="content-main"> <div id="panel-top"> <div class="section"> <p class="message"><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/start">Getting Started</a> with the Twitter Platform is easy. Jump right into the <a href="/web/20111109103732/https://dev.twitter.com/docs/api">API resource documentation</a>, explore the <a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/console">developer console</a>, or <a href="/web/20111109103732/https://dev.twitter.com/apps/new">create an app</a>.</p> </div> </div> <div id="panel-first"> <div class="section"> <h2 id="getting-started">Getting Started</h2> <div class="section"> <ul> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/start">Getting Started with the Twitter Platform</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/intro-twitterapi">Intro to the Platform</a> (slides)</li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/api-faq">Twitter API FAQ</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/counting-characters">Counting Characters</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/twitter-ids-json-and-snowflake">JSON Parsing & Tweet IDs</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/tco-url-wrapper">The t.co URL Wrapper</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/console">Developer Console</a></li> </div> <h2 id="tfw">Twitter for Websites</h2> <div class="section"> <p>Easily embed Twitter functionality, encourage your users to share content on Twitter, and increase your audience reach with <a href="/web/20111109103732/https://dev.twitter.com/docs/twitter-for-websites">Twitter for Websites</a>.</p> <ul> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/tweet-button">Tweet Button</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/follow-button">Follow Button</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/intents">Web Intents</a> & <a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/intents/events">Javascript callback events</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/share-bookmarklet">Share Bookmarklet</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/anywhere/welcome">@Anywhere</a></li> </ul> </div> <h2 id="guidelines-and-terms">Guidelines and Terms</h2> <div class="section"> <p>API terms of service and guidelines for use.</p> <ul> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/terms/api-terms">Developer Rules of the Road</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/terms/display-guidelines">Display Guidelines</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/terms/geo-developer-guidelines">Geo Guidelines</a></li> <li><a href="https://web.archive.org/web/20111109103732/http://support.twitter.com/entries/114233">Broadcast Guidelines</a></li> </ul> </div> <h2 id="ecosystem">Other Resources</h2> <div class="section"> <ul> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/support">API Support</a></li> <li><a href="/web/20111109103732/https://dev.twitter.com/videos">#devnestSF Videos</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/developers-for-hire">Developers for Hire</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/media">Media resources</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/security-best-practices">Security Best Practices</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/twitter-libraries">Twitter Libraries with OAuth</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/international-glossary">Adding international support to your apps</a></li> <li> <a href="/web/20111109103732/https://dev.twitter.com/pages/image-resources"> <img src="//web.archive.org/web/20111109103732im_/https://si0.twimg.com/images/dev/cms/intents/bird/bird_blue/bird_16_blue.png"> Bird, <img src="//web.archive.org/web/20111109103732im_/https://si0.twimg.com/images/dev/cms/intents/icons/favorite.png"> Favorite, <img src="//web.archive.org/web/20111109103732im_/https://si0.twimg.com/images/dev/cms/intents/icons/reply.png"> Reply, <img src="//web.archive.org/web/20111109103732im_/https://si0.twimg.com/images/dev/cms/intents/icons/retweet.png"> Retweet Icons & Sprites </a> </li> </ul> </div> </div> </div> <div id="panel-last"> <div class="section"> <h2 id="rest-api-general">The REST API</h2> <div class="section"> <p>The <a href="/web/20111109103732/https://dev.twitter.com/docs/api">REST API</a> provides simple interfaces for most Twitter functionality.</p> <ul> <li><a href="/web/20111109103732/https://dev.twitter.com/docs/api">Comprehensive Resource Documentation</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/using-search">Using the Twitter Search API</a> and <a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/api/1/get/search">GET search</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/tweet-entities">Tweet Entities</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/things-every-developer-should-know">Things to know about the REST API</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/history-rest-search-api">History of the REST and Search APIs</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/rate-limiting">Rate Limiting</a> & <a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/rate-limiting/faq">Rate Limiting FAQ</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/error-codes-responses">Error Codes & Responses</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/console">Explore the API with Tools & Consoles</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/places/finding-tweets-about-places">Finding Tweets about Places</a></li> </ul> </div> <h2 id="streaming-api-user-streams">Streaming API, User Streams, Site Streams</h2> <div class="section"> <p>The Streaming API is a family of powerful real-time APIs for Tweets and other social events.</p> <ul> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/streaming-api">Streaming API Documentation</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/streaming-api/user-streams">User Streams</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/streaming-api/site-streams">Site Streams</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/twitter-data-providers">Partner Providers of Twitter Data</a></li> </ul> </div> <h2 id="authentication">Authentication</h2> <div class="section"> <p>Learn how a user authorizes your application and how you securely communicate on their behalf.</p> <ul> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth">Which authorization path should I choose?</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth/oauth">OAuth 1.0a</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/application-permission-model">the Application Permission Model</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth/oauth/single-user-with-examples">Single user OAuth with examples</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth/moving-from-basic-auth-to-oauth">From Basic Auth to OAuth for Beginners</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/twitter-libraries">Twitter Libraries with OAuth</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth/oauth/faq">OAuth FAQ</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth/sign-in-with-twitter">Sign in with Twitter Overview</a></li> <li><a href="https://web.archive.org/web/20111109103732/https://dev.twitter.com/docs/auth/oauth/oauth-echo">OAuth Echo</a></li> </ul> </div> </div> </div> </div> </div> </div> <div id="footer-outer"> <div id="footer"> <a href="https://web.archive.org/web/20111109103732/http://twitter.com/twitterapi" data-show-count="false" class="twitter-follow-button" data-text-color="999999" data-link-color="0080A6">Follow @twitterapi</a><ul class="menu"><li class="leaf first"><a href="/web/20111109103732/https://dev.twitter.com/terms/api-terms" title="Developer Rules of the Road">API Terms</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/status" title="Twitter API Status">API Status</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/blog" title="Twitter Developer blog">Blog</a></li> <li class="leaf"><a href="/web/20111109103732/https://dev.twitter.com/discussions" title="Twitter Development discussions">Discussions</a></li> <li class="leaf active-trail"><a href="/web/20111109103732/https://dev.twitter.com/docs" title="Twitter development documentation" class="active">Documentation</a></li> <li class="leaf last"><a href="https://web.archive.org/web/20111109103732/http://www.acquia.com/" title="Acquia">A Drupal community site supported by Acquia</a></li> </ul> </div> </div> </div><script type="text/javascript"> <![CDATA[//><!]]> </script> </body> </html>