Skip to main content

Query Parameters

text
string
Search keywords. Matches against ad titles and descriptions.
category
string
Restrict results to a Leboncoin category id. Use /v1/leboncoin/categories to look up ids.
region_id
string
Restrict results to a French region (includes DOM-TOM overseas territories). Use /v1/leboncoin/regions to look up ids.
department_id
string
Restrict results to a French department. Use /v1/leboncoin/departments to look up ids.
city
string
Restrict results to a city name. Resolve names with /v1/leboncoin/locations/search.
zipcode
string
Restrict results to a French postal code.
price_min
integer
Minimum price filter in euros.
price_max
integer
Maximum price filter in euros.
owner_type
string
default:"all"
Filter by seller type.
ad_type
string
default:"offer"
Filter by ad type.
sort
string
default:"relevance"
Sort order for results.
page
integer
default:1
Page number for paginated results.
limit
integer
default:35
Results per page. Maximum 100.

Response

ads
array
Array of matching ads.
total
integer
Number of ads matching the current filters.
total_all
integer
Total ads matching the query across all seller types.
total_pro
integer
Total matching ads from professional sellers.
total_private
integer
Total matching ads from private sellers.
total_shippable
integer
Total matching ads eligible for shipping.
max_pages
integer
Maximum number of pages available for this query.
page
integer
The page that was returned.
limit
integer
The page size that was applied.
source
string
The upstream source the results were scraped from.

Example Response

Each search request costs 5 credits. Failed requests are not charged.