# v3-yelp-api

> Node Wrapper for Yelp Api V3

Latest version **1.0.2** (published 2017-04-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install v3-yelp-api
pnpm add v3-yelp-api
yarn add v3-yelp-api
bun add v3-yelp-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-04-19 |
| First published | 2017-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 7 |
| Author | dobiedad |
| Maintainers | dobiedad |
| Keywords | yelp-api, v3, react-native |

## Links

- npm: https://www.npmjs.com/package/v3-yelp-api
- Repository: https://github.com/dobiedad/YelpApiV3
- Homepage: https://github.com/dobiedad/YelpApiV3#readme
- Issues: https://github.com/dobiedad/YelpApiV3/issues
- npm.io page: https://npm.io/package/v3-yelp-api

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.16.1
- [querystring](https://npm.io/package/querystring.md) ^0.2.0

## Recent versions

- 1.0.2 (latest) — 2017-04-19
- 1.0.1 — 2017-04-15
- 1.0.0 — 2017-04-15

## README

# v3 Yelp Api
A simple npm wrapper for Yelp v3 Api which is compatible with [React Native](https://github.com/facebook/react-native)

## Dependencies
[axios](https://github.com/mzabriskie/axios)
[qs](https://github.com/ljharb/qs)
## Install

### npm
    npm i v3-yelp-api -S
### Usage

```JavaScript
import YelpApi from 'v3-yelp-api';

const credentials = {
    appId:"App Id from Yelp Developer Console",
    app: "App Secret from Yelp Developer Console"
}

const yelp = New YelpApi(credentials)
```

### Search
```JavaScript
let params = {
    query: 'food',
    location: '51.5007,0.1246',
    price: '2',
    limit: 10
}

yelp.search(params)
 .then(data => data)
 .catch(err => err)
```
### Phone Search
```JavaScript
let params = { phone: '+442073722882' }

yelp.phoneSearch(params)
 .then(data => data)
 .catch(err => err)
```
### Business / Reviews
```JavaScript
let bestRestaurantEver = 'tamada-london'

yelp.business(bestRestaurantEver)
 .then(data => data)
 .catch(err => err)

yelp.reviews(bestRestaurantEver)
 .then(data => data)
 .catch(err => err)
```
### Transactional Search
```JavaScript
let params = { location: 'london' }
let transactionType = 'delivery'

yelp.transactionSearch(params)(transactionType)
 .then(data => data)
 .catch(err => err)
```

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