twitter-v1-oauth/README.md

# Twitter API v1.1 OAuth 1.0a 🔑

[![npm version](https://badge.fury.io/js/twitter-v1-oauth.svg)](https://www.npmjs.com/package/twitter-v1-oauth)
[![Build and Test](https://github.com/MauricioRobayo/twitter-v1-oauth/actions/workflows/main.yml/badge.svg)](https://github.com/MauricioRobayo/twitter-v1-oauth/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/MauricioRobayo/twitter-v1-oauth/branch/main/graph/badge.svg?token=M2SaEIeOtO)](https://codecov.io/gh/MauricioRobayo/twitter-v1-oauth)
[![CodeFactor](https://www.codefactor.io/repository/github/mauriciorobayo/twitter-v1-oauth/badge)](https://www.codefactor.io/repository/github/mauriciorobayo/twitter-v1-oauth)

Simple and minimalist module to send OAuth 1.0a requests to the Twitter API v1.1.

It returns an object with the request options necessary to make a request using your favorite tool.

```typescript
import dotenv from "dotenv";
import oAuthV1Request from "twitter-v1-oauth";
import axios from "axios";

dotenv.config();

const oAuthOptions = {
  api_key: process.env.TWITTER_API_KEY || "",
  api_secret_key: process.env.TWITTER_API_SECRET_KEY || "",
  access_token: process.env.TWITTER_ACCESS_TOKEN || "",
  access_token_secret: process.env.TWITTER_ACCESS_TOKEN_SECRET || "",
};
const baseURL = "https://api.twitter.com/1.1/search/tweets.json";
const method = "GET";
const params = { q: "twitter bot" };

const searchRequest = oAuthV1Request({
  oAuthOptions,
  method,
  baseURL,
  params,
});

axios
  .request(searchRequest)
  .then(({ data }) => console.log(data))
  .catch((err) => {
    if (err.response) {
      return console.log(err.response);
    }
    console.log(err);
  });
```

No dependencies and super small: [![install size](https://packagephobia.now.sh/badge?p=twitter-v1-oauth)](https://packagephobia.now.sh/result?p=twitter-v1-oauth).

![twitter-v1-oauth](https://media.giphy.com/media/km2mais9qzYI/giphy.gif)

## Install

```shell
npm install twitter-v1-oauth
```

## Usage

Create an app and get your credentials, you will need:

- API KEY
- API SECRET KEY
- ACCESS TOKEN
- ACCESS TOKEN SECRET

Use your preferred library to send the request using the documented endpoints and parameters for the [twitter v1 API](https://developer.twitter.com/en/docs/basics/getting-started).

#### CommonJS

```js
const authRequest = require("twitter-v1-oauth").default;
```

#### ES6 Modules

```js
import oAuthV1Request from "twitter-v1-oauth";
```

#### TypeScript

Type definitions are included.

## Examples

Check the [examples](./examples) directory for ideas on how to use it with [axios](https://github.com/axios/axios).

The [index.test.ts](./src/index.test.ts) file should also provide a good idea on its usage.

## Twitter documentation

- [Authentication](https://developer.twitter.com/en/docs/basics/authentication/overview/oauth)
- [Authorizing a request](https://developer.twitter.com/en/docs/basics/authentication/guides/authorizing-a-request.html)
- [Creating a signature](https://developer.twitter.com/en/docs/basics/authentication/guides/authorizing-a-request.html)

## License

[MIT](./LICENSE)