Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/filipchr/node-booli
https://github.com/filipchr/node-booli
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/filipchr/node-booli
- Owner: filipchr
- Created: 2019-02-01T20:05:32.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-25T05:52:32.000Z (over 2 years ago)
- Last Synced: 2024-08-04T01:12:36.169Z (4 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-sweden - JavaScript
README
# Booli API Node wrapper
> Booli API Node wrapper provides access to the Booli Api.
:link: For a detailed API description, please see [the full api reference](https://www.booli.se/p/api/)
## Getting started
```javascript
npm install --save node-booli
```
Initialize
```javascript
const Booli = require('node-booli');
```
All methods uses `fetch` under the hood
**Listings**
```javascript
const query = {
q: 'Stockholm',
minRooms: 2,
maxRooms: 3,
};
const listingsResponse = await Booli.listings.all(query); // Fetch all listings.
const singleResponse = await Booli.listings.single(1); // Fetch one item with the id of 1
```
**Sold**
```javascript
const query = {
q: 'Stockholm',
minRooms: 2,
maxRooms: 3,
maxPrice: 3500000,
};
const soldResponse = await Booli.sold.all(query); // Fetch all sold given the parameter
```
**Areas**
```javascript
const areasResponse = await Booli.areas.getAreas([
'Midsommarkransen',
'Stockholm',
]); // fetch areas
```
## Development
```
git clone https://github.com/filipchr/node-booli
cd node-booli
```
Install dependencies
```
npm install
```
Run example
```
node example.js
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/filipchr/node-booli
## License
All data provided belongs to Booli Search Technologies AB.
This packages is powered by [Booli](http://www.booli.se)
