Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xdevplatform/Twitter-API-v2-sample-code
Sample code for the Twitter API v2 endpoints
https://github.com/xdevplatform/Twitter-API-v2-sample-code
java javascript nodejs python ruby twitter twitter-api twitter-api-v2
Last synced: 4 days ago
JSON representation
Sample code for the Twitter API v2 endpoints
- Host: GitHub
- URL: https://github.com/xdevplatform/Twitter-API-v2-sample-code
- Owner: xdevplatform
- License: apache-2.0
- Created: 2020-08-12T17:00:53.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T13:26:36.000Z (3 months ago)
- Last Synced: 2024-11-05T18:11:57.451Z (5 days ago)
- Topics: java, javascript, nodejs, python, ruby, twitter, twitter-api, twitter-api-v2
- Language: JavaScript
- Homepage: https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api
- Size: 146 KB
- Stars: 2,713
- Watchers: 63
- Forks: 999
- Open Issues: 91
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Twitter API v2 sample code [](https://developer.twitter.com/en/docs/twitter-api)
Sample code for the Twitter API v2 endpoints.
Individual API features have folders where you can find examples of usage in several coding languages (Java, Node.js, Python, R, and Ruby).
* [Twitter API Documentation](https://developer.twitter.com/en/docs/twitter-api/getting-started/about-twitter-api)
## Prerequisites
* Twitter API Essential Access ([sign up here](https://t.co/signup))
* A Project and an App created [in the dashboard](https://developer.twitter.com/en/portal/dashboard)
## Using the code samples
In order to run the samples in this repository you will need to set up some environment variables. You can find your credentials and bearer token in the App inside of your Project in the [dashboard of the developer portal](https://developer.twitter.com/en/portal/projects-and-apps).
For OAuth 1.0a samples, you will need to export your consumer key and secret in your terminal. Be sure to replace `` and `` with your own credentials without the `< >`.
```bash
export CONSUMER_KEY=''
export CONSUMER_SECRET=''
```
For samples which use bearer token authentication, you will need to export the bearer token. Be sure to replace `` with your own bearer token without the `< >`.
```bash
export BEARER_TOKEN=''
```
## Language-specific requirements
### Java environment set up
If you use Homebrew, you can install a Java runtime using:
```bash
brew cask install java
```
You will also need to download the relevant JAR files referenced in the individual samples in order to build and run the code. If you use an IDE, it may be able to do this automatically for you.
### JavaScript (Node.js) environment set up
You will need to have Node.js installed to run this code. All Node.js examples use `needle` as the HTTP client, which needs to be npm installed. For OAuth with user context requests, you'll need to install the `got` and `oauth-1.0a` packages.
```bash
npm install needle
npm install got
npm install oauth-1.0a
```
### Python environment set up
You will need to have Python 3 installed to run this code. The Python samples use `requests==2.24.0` which uses `requests-oauthlib==1.3.0`.
(Optionally) It is common and recommended not to install required package globally, but locally under project subfolder using `venv`:
```bash
python3 -m venv venv
source venv/bin/activate
```
You can install these packages as follows:
```bash
pip install requests
pip install requests-oauthlib
```
### Ruby environment set up
You will need to have Ruby (recommended: >= 2.0.0) installed in order to run the code. The Ruby examples use `typhoeus` as the HTTP client, which needs to be gem installed. For OAuth with user context requests, you'll also need to install the `oauth` gem (see below).
```bash
gem install typhoeus
gem install oauth
```
## Additional resources
We maintain a [Postman](https://getpostman.com) Collection which you can use for exercising individual API endpoints.
* [Using Postman with the Twitter API](https://developer.twitter.com/en/docs/tutorials/postman-getting-started)
* [Twitter API v2 on the Postman website](https://t.co/twitter-api-postman)
## Support
* For general questions related to the API and features, please use the v2 section of our [developer community forums](https://twittercommunity.com/c/twitter-api/twitter-api-v2/65).
* If there's an bug or issue with the sample code itself, please create a [new issue](https://github.com/twitterdev/Twitter-API-v2-sample-code/issues) here on GitHub.
## Contributing
We welcome pull requests that add meaningful additions to these code samples, particularly for languages that are not yet represented here.
We feel that a welcoming community is important and we ask that you follow Twitter's [Open Source Code of Conduct](https://github.com/twitter/.github/blob/main/code-of-conduct.md) in all interactions with the community.
## License
Copyright 2021 Twitter, Inc.
Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0