# avalonbay-api

> An api wrapper around avalonapi.com

Latest version **1.0.3** (published 2020-06-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install avalonbay-api
pnpm add avalonbay-api
yarn add avalonbay-api
bun add avalonbay-api
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-06-29 |
| First published | 2020-06-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 16.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | davidrules88 |
| Maintainers | davidrules88 |
| Keywords | avalonbay, apartments |

## Links

- npm: https://www.npmjs.com/package/avalonbay-api
- Repository: https://github.com/davidrocks88/avalonbay-api
- Homepage: https://github.com/davidrocks88/avalonbay-api#readme
- Issues: https://github.com/davidrocks88/avalonbay-api/issues
- npm.io page: https://npm.io/package/avalonbay-api

## Dependencies (5)

- [path](https://npm.io/package/path.md) ^0.12.7
- [fetch](https://npm.io/package/fetch.md) ^1.1.0
- [format](https://npm.io/package/format.md) ^0.2.2
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.3
- [node-html-parser](https://npm.io/package/node-html-parser.md) ^1.2.20

## Recent versions

- 1.0.3 (latest) — 2020-06-29
- 1.0.2 — 2020-06-29
- 1.0.1 — 2020-06-29
- 1.0.0 — 2020-06-28

## README

# avalonbay-api

An npm package used to query the avalonbay api.

*Note: This API should only be used for personal use. For Terms of Use, see [https://www.avaloncommunities.com/terms-of-use](https://www.avaloncommunities.com/terms-of-use)*.

## Usage
The package exports several methods that return promises. See the usage below.
```js
import { search, searchState, searchCommunity } from 'avalonbay-api';

// Does a fuzzy search for communities
search("camb")
    .then(results => console.log(results))

// Does a search for communnities in a given state
let communityID;
searchState("California")
   .then(communities => communityID = communities[0].id))

// Does a search for units within a community
searchCommunity(communityID)
    .then(units => console.log(units))

```

See https://itnext.io/step-by-step-building-and-publishing-an-npm-typescript-package-44fe7164964c for instructions on how to build and publish an npm package.

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