Leboncoin API wrapper goal is to make it easy to use the Leboncoin's API. (Still a WIP)
npm i leboncoin-api-wrapper
const lbc = require('leboncoin-api-wrapper');
const finder = new lbc.Finder();
finder.setKeywords('Evangelion'); // We set the keywords that we want to search
finder.setCategory('livres'); // Setting the category, you can find the full on Leboncoin.fr
finder.setOrder('desc'); // desc or asc
finder.setPage(1);
finder.setLimit(10); // Limit per page
(async () => {
const resp = await finder.search();
})();
setKeywords('evangelion')
Parameter: string
Define the keywords you want to search
setPage(1)
Parameter: integer
Define the page number
setOrder('desc')
Parameter: string
Define the ads order desc
or asc
setLimit(15)
Parameter: integer
Define the number of ads per page
setCategory('livres')
Parameter: string
Define the category, you can find a full list here
setMinPrice(15)
Parameter: integer
Define the minimal price
setMaxPrice(15)
Parameter: integer
Define the maximal price
setLocations([{'city': 'Montreuil','zipcode': '93100'}])
Parameter: array
Define the cities, you can add as many as you want
setMinRooms(2)
Parameter: integer
Define the minimum number of rooms (for real estate)
setMaxRooms(2)
Parameter: integer
Define the maximum number of rooms (for real estate)
setMinSquare(15)
Parameter: integer
Define the minimal size in square meter
setMaxSquare(15)
Parameter: integer
Define the maximal size in square meter
setEstateType(['maison'])
Parameter: array
Define the kind of real estate you are looking for, full list here
setFurnished(true)
Parameter: boolean
Define if the real estate is furnished or not (for locations` category)
setSellType(['old'])
Parameter: array
Define the real estate type, old
new
or viager
(for ventes immobilieres
category)`
search()
Run the search and will returns corresponding ads with phone numbers if possible.