<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Twitter Dev API authentication — auth_twitter_dev • vosonSML</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Twitter Dev API authentication — auth_twitter_dev"><meta property="og:description" content="Twitter authentication uses OAuth and typically requires four developer API keys generated when you
create a twitter app via the twitter developer web site. These keys and the authentication object produced are
referenced as developer keys and developer access in this package. Software using developer access to the API can
operate with full access to the API including within the user-context but with the understanding that it is an app.
The rtweet package refers to this as 'bot' authentication."><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">vosonSML</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.34.3</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"><li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../news/index.html">
    <span class="fa fa-newspaper"></span>
     
    Changelog
  </a>
</li>
<li>
  <a href="../reference/index.html">
    <span class="fa fa-cubes fa-lg"></span>
     
    Reference
  </a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
    <span class="fa fa-book"></span>
     
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu"><li>
      <a href="../articles/Intro-to-vosonSML.html">
        <span class="far fa-file-alt"></span>
         
        Introduction to vosonSML
      </a>
    </li>
    <li>
      <a href="https://vosonlab.github.io/posts/2021-03-15-hyperlink-networks-with-vosonsml" class="external-link">
        <span class="far fa-file-alt"></span>
         
        Hyperlink Networks with vosonSML
      </a>
    </li>
    <li>
      <a href="../articles/Twitter-Usage.html">
        <span class="far fa-file-alt"></span>
         
        Twitter Usage
      </a>
    </li>
    <li>
      <a href="https://vosonlab.github.io/posts/2022-06-05-egocentric-networks-from-twitter-timelines" class="external-link">
        <span class="far fa-file-alt"></span>
         
        Egocentric Networks from Twitter timelines
      </a>
    </li>
    <li>
      <a href="https://vosonlab.github.io/posts/2021-10-01-testing-bot-status-of-twitter-users" class="external-link">
        <span class="far fa-file-alt"></span>
         
        Testing the bot status of users in Twitter networks collected via vosonSML
      </a>
    </li>
  </ul></li>
      </ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="http://vosonlab.net/" class="external-link">
    <span class="fa fa-flask fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="https://twitter.com/vosonlab" class="external-link">
    <span class="fab fa-twitter-square fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="https://github.com/vosonlab/vosonSML" class="external-link">
    <span class="fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Twitter Dev API authentication</h1>
    <small class="dont-index">Source: <a href="https://github.com/vosonlab/vosonSML/blob/HEAD/R/wrappers.R" class="external-link"><code>R/wrappers.R</code></a></small>
    <div class="hidden name"><code>auth_twitter_dev.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Twitter authentication uses OAuth and typically requires four developer API keys generated when you
create a twitter app via the twitter developer web site. These keys and the authentication object produced are
referenced as developer keys and developer access in this package. Software using developer access to the API can
operate with full access to the API including within the user-context but with the understanding that it is an app.
The <span class="pkg">rtweet</span> package refers to this as 'bot' authentication.</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">auth_twitter_dev</span><span class="op">(</span></span>
<span>  app_name <span class="op">=</span> <span class="st">"r twitter app"</span>,</span>
<span>  <span class="va">api_key</span>,</span>
<span>  <span class="va">api_secret</span>,</span>
<span>  <span class="va">access_token</span>,</span>
<span>  <span class="va">access_token_secret</span>,</span>
<span>  verbose <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>app_name</dt>
<dd><p>Character string. Registered twitter app name associated with the API keys.</p></dd>


<dt>api_key</dt>
<dd><p>Character string. API consumer key to authenticate (also called API key).</p></dd>


<dt>api_secret</dt>
<dd><p>Character string. API consumer secret to authenticate (also called API secret).</p></dd>


<dt>access_token</dt>
<dd><p>Character string. API access token to authenticate.</p></dd>


<dt>access_token_secret</dt>
<dd><p>Character string. API access token secret to authenticate.</p></dd>


<dt>verbose</dt>
<dd><p>Logical. Output additional information. Default is <code>FALSE</code>.</p></dd>


<dt>...</dt>
<dd><p>Additional parameters passed to function. Not used in this method.</p></dd>

</dl></div>
    <div id="value">
    <h2>Value</h2>
    

<p>A <code>credential</code> object containing an access token <code>$auth</code> and social media type descriptor
<code>$socialmedia</code> set to <code>"twitter"</code>. Object has the class names <code>"credential"</code> and <code>"twitter"</code>.</p>
    </div>
    <div id="note">
    <h2>Note</h2>
    <p><span class="pkg">vosonSML</span> uses the <span class="pkg">rtweet</span> package for twitter data collection and also gratefully acknowledges the
techniques and code written by its authors reproduced in this package for creating twitter API access tokens.</p>
    </div>

    <div id="ref-examples">
    <h2>Examples</h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span>
<span class="r-in"><span><span class="co"># twitter authentication using developer app API keys</span></span></span>
<span class="r-in"><span><span class="va">auth</span> <span class="op">&lt;-</span> <span class="fu">auth_twitter_dev</span><span class="op">(</span></span></span>
<span class="r-in"><span>  app_name <span class="op">=</span> <span class="st">"My App"</span>,</span></span>
<span class="r-in"><span>  api_key <span class="op">=</span> <span class="st">"xxxxxxxxxxxx"</span>,</span></span>
<span class="r-in"><span>  api_secret <span class="op">=</span> <span class="st">"xxxxxxxxxxxx"</span>,</span></span>
<span class="r-in"><span>  access_token <span class="op">=</span> <span class="st">"xxxxxxxxxxxx"</span>,</span></span>
<span class="r-in"><span>  access_token_secret <span class="op">=</span> <span class="st">"xxxxxxxxxxxx"</span></span></span>
<span class="r-in"><span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </div>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by Bryan Gertzel, Robert Ackland, Timothy Graham.</p>
</div>

<div class="pkgdown">
  <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.9.</p>
</div>

      </footer></div>

  


  

  </body></html>

