# yellowapi

> Wrapper for the YellowAPI http://www.yellowapi.com/docs

Latest version **1.0.1** (published 2012-09-06) · 0 weekly downloads

## Install

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

## 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.1 |
| Published | 2012-09-06 |
| First published | 2012-09-06 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ~0.6.9 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Francois Lafortune, |
| Maintainers | quickredfox |

## Links

- npm: https://www.npmjs.com/package/yellowapi
- Repository: https://github.com/quickredfox/yellowapi-node
- npm.io page: https://npm.io/package/yellowapi

## Recent versions

- 1.0.1 (latest) — 2012-09-06
- 1.0.0 — 2012-09-06

## README

# YellowAPI for node

Simple node wrapper for the YellowAPI http://www.yellowapi.com/docs.

# Installation

    $ npm install yellowapi

# Usage

    var YellowAPI = require( 'yellowapi' );
		var config = {
			host: 'api.sandbox.yellowapi.com' // or api.yellowapi.com
			apikey: 'you-api-key' // either sandbox api key or production api key.			
		}
		var yapi = YellowAPI( config )
		var query = { what: 'sushi', where: 'montreal', UID: 'yellowapi-node-test' }
		yapi.findBusiness( query , function( error, data){
			/*
				"error" is an application error, not an api erroneous response
			*/
			console.log( data )
		});

# API Methods

* [findBusiness](http://www.yellowapi.com/docs/places/#findbusiness)
* [getBusinessDetails](http://www.yellowapi.com/docs/places/#getbusinessdetails)
* [findDealer](http://www.yellowapi.com/docs/places/#finddealer)
* [getTypeAhead](http://www.yellowapi.com/docs/places/#gettypeahead)

# License

Copyright 2012 Francois Lafortune

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

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