# tinderauth

> Get your credentials for the Tinder API programatically

Latest version **2.0.3** (published 2016-09-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install tinderauth
pnpm add tinderauth
yarn add tinderauth
bun add tinderauth
```

Provides the command `tinderauth`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2016-09-04 |
| First published | 2016-03-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 27 |
| Author | Anthony Mayfield |
| Maintainers | barczag, mrmayfield |

## Links

- npm: https://www.npmjs.com/package/tinderauth
- Repository: https://github.com/tinderjs/tinderauth
- Homepage: https://github.com/tinderjs/tinderauth#readme
- Issues: https://github.com/tinderjs/tinderauth/issues
- npm.io page: https://npm.io/package/tinderauth

## Dependencies (10)

- [nock](https://npm.io/package/nock.md) git+https://github.com/barczaG/nock.git
- [axios](https://npm.io/package/axios.md) ^0.9.1
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [tinder](https://npm.io/package/tinder.md) ^1.19.0
- [zombie](https://npm.io/package/zombie.md) ^4.2.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.6
- [inquirer](https://npm.io/package/inquirer.md) ^1.1.2
- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.6.1
- [babel-plugin-transform-runtime](https://npm.io/package/babel-plugin-transform-runtime.md) ^6.6.0

## Recent versions

- 2.0.3 (latest) — 2016-09-04
- 2.0.2 — 2016-09-04
- 2.0.1 — 2016-09-02
- 2.0.0 — 2016-09-02
- 1.5.0 — 2016-07-10
- 1.4.0 — 2016-07-10
- 1.3.0 — 2016-03-26
- 1.2.0 — 2016-03-16
- 1.1.1 — 2016-03-16
- 1.1.0 — 2016-03-16
- 1.0.0 — 2016-03-16

## README

# tinderauth

<p align="center">
  <a href="https://www.npmjs.com/package/tinderauth"><img src="https://img.shields.io/npm/dm/tinderauth.svg" alt="npm downloads"></a>
  <a href="https://www.npmjs.com/package/tinderauth"><img src="https://img.shields.io/npm/v/tinderauth.svg" alt="npm version"></a>
  <a href="https://standardjs.com"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="js-standard-style"></a>
</p>
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

## CLI usage
```
npm i tinderauth -g
tinderauth
```
![alt text](https://raw.githubusercontent.com/tinderjs/tinderauth/master/docs/cli.gif "Logo Title Text 1")

## Api usage
Get your credentials for the Tinder API programatically

This module uses your FACEBOOK_USERNAME and FACEBOOK_PASSWORD to programatically get a token and your profile id, both of which are needed to authenticate with the http://www.github.com/tinderjs/tinder API.

First, run from the commandline:

`$ export FACEBOOK_EMAIL='your@email.com'`

`$ export FACEBOOK_PASSWORD='yourpassword'`

Then, from your file:

ES6:

```
import tinderauth from 'tinderauth';

(async function(){
  // alternatively you can pass credentials as arguments
  const { token, profile_id } = await tinderauth('hello@domain.com', 'sosecret');
  console.log(token, profile_id);
})();
```

ES5:

```
var tinderauth = require('tinderauth');

tinderauth().then(function(response){
  var token = response.token;
  var profile_id = response.profile_id;
  console.log(token, profile_id);
});
```

By the way, you may have concerns about using your FACEBOOK_EMAIL and FACEBOOK_PASSWORD. A couple points about this: 

First, if you would like an alternative, check out http://www.github.com/tinderjs/tindercred , you will have to manually copy your password and ID so it's not programmatic, but it's a nice option. 

Secondly, these variables are never shared with an outside service, and aren't in your source since they are exported with an environment variable. 

Lastly, and most importantly, you should *not* use these experimental technologies with your real Facebook account. Make a throwaway Facebook account so that if things glitch you don't lose privelleges with your real Facebook account. Therefore, you shouldn't ever need to worry about losing access to your real Facebok account, don't even use it with this module. 


To-Do:

- [X] Get ES5 working
- [ ] Add copyright and change to MIT license

## Developing & testing
- Get your user ID from: http://findmyfbid.com/
- Clone the repo repo
- `$ npm i`
- `$ FACEBOOK_EMAIL='your@email.com' FACEBOOK_PASSWORD='your-password' FACEBOOK_EXPECTED_USER_ID='your_expected_user_id' DEBUG=tinderauth npm test`

---
_Source: https://npm.io/package/tinderauth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._