LeBonCoin JS API is an API to obtain the data from leboncoin.fr in a fluent JS API.

# Features

• Search on leboncoin.fr with all functionality available leboncoin.fr
• Get the detailed page of an item
• Get the phone number of the seller (convert the image to string) /!\ This API have an unknown usage limit

# Example

# Search API

# run()

• Parameter http options: default:
• Parameter body parameter: default:
• Return type:

Make search request on leboncoin.fr.

# setQuery()

• Parameter:
• Return type:

Define the textual search query, by default the query search in the description and in the title. See to only search in the title. The query can contain specific keywords like , , as specified here: https://www2.leboncoin.fr/tips.htm.

# setTitleOnly()

• Parameter:
• Default:
• Return type:

Define if the query should only match the title of the item.

# setPage()

• Parameter:
• Default:
• Return type:

Define the page you want the results for, the page start at 1. See to define the number of results per page.

# setLimit()

• Parameter:
• Default:
• Return type:

Define the number of results per page.

# setSort()

• Parameter:
• Default:
• Return type:

Define the sorting order of the results. can be or and can be or .

# setFilter()

• Parameter:
• Default:
• Return type:

Define the type of user that posted the item.

# setCategory()

• Parameter:
• Return type:

Define the category of the search. Categories contains the complete list of possible values.

# setUrgencyOnly()

• Parameter:
• Default:
• Return type:

Search only urgent item.

# setRegion()

• Parameter:
• Return type:

Define the region of the search. Regions contains the complete list of possible values.

# setDepartment()

• Parameter:
• Return type:

Define the department of the search. Departments contains the complete list of possible values.

# setLocation()

• Parameter:
• Return type:

Define where the item is located using the zip code of the city.

# setArea()

• Parameter:
• Return type:

Define the area where the item is located using GPS coordinate. and define the latitude and longitude of the circle of the defined (in meter).

# addSearchExtra()

• Parameter: The key of the extra search parameter
• Parameter: The value of the extra search parameter
• Return type:

Define extra search parameter for the search. Each category has different extra parameter you can obtain the key and value by looking at the HTML content of leboncoin.fr page.

# Item

# title

The title of the item.

# description

The full description of the item.

# category

The category of the item.

# link

The url of the item.

# images

An array of pictures of the item.

# location

The location of the item.

# urgent

if the sell is urgent.

# price

The price of the item in euro.

# date

The date when the item has been published.

# owner

The user information of the seller.

# seller

The name of the seller of the item.

# attributes

A Javascript object that contains all the specific attributes of the item. The number of attributes varies depending on the category and the item.

# has_phone

if the seller of the item mentioned her phone number.

# getDetails()

• Return:

Get the details

# getPhoneNumber()

• Return:

Get the phone number of the seller. Pay attention that this API has a strict API usage limit. I recommend that this API is only used when a user request it.

# Regions

The and can be used in the function to filter the search.

# Departments

The and can be used in the function to filter the search.

# Categories

The and can be used in the function to filter the search.