{
"openapi": "3.0.1",
"info": {
"title": "Leboncoin Scraper — Ads, Categories & Locations",
"description": "Scrape leboncoin.fr, France's largest classifieds site: search ads by keyword, category, region, department, city or postcode with price and seller-type filters, plus full ad detail and similar ads.",
"version": "1.0",
"x-build-id": "xLspOmAEtkeLZ7VQ2"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrape.badger~leboncoin-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrape.badger-leboncoin-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/scrape.badger~leboncoin-scraper/runs": {
"post": {
"operationId": "runs-sync-scrape.badger-leboncoin-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/scrape.badger~leboncoin-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrape.badger-leboncoin-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"title": "Mode",
"enum": [
"Search",
"Get Ad",
"Get Similar Ads",
"Search Locations",
"List Categories",
"List Regions",
"List Departments",
"List Markets"
],
"type": "string",
"description": "Which Leboncoin call to run. Each mode uses a different subset of the fields below — the run tells you if a required one is missing.",
"default": "Search"
},
"text": {
"title": "Text",
"type": "string",
"description": "Search keywords. Required for: Search."
},
"category": {
"title": "Category",
"type": "string",
"description": "Restrict the search to a category id. Used by: Search."
},
"region_id": {
"title": "Region id",
"type": "string",
"description": "Restrict the search to a region id. Used by: Search, List Departments."
},
"department_id": {
"title": "Department id",
"type": "string",
"description": "Restrict the search to a department id. Used by: Search."
},
"city": {
"title": "City",
"type": "string",
"description": "Restrict the search to a city. Used by: Search."
},
"zipcode": {
"title": "Zipcode",
"type": "string",
"description": "Restrict the search to a postal code. Used by: Search."
},
"price_min": {
"title": "Price min",
"type": "integer",
"description": "Minimum price filter (euros). Used by: Search."
},
"price_max": {
"title": "Price max",
"type": "integer",
"description": "Maximum price filter (euros). Used by: Search."
},
"owner_type": {
"title": "Owner type",
"enum": [
"all",
"pro",
"private"
],
"type": "string",
"description": "Seller type (\"all\", \"pro\", \"private\"). Used by: Search."
},
"ad_type": {
"title": "Ad type",
"enum": [
"offer",
"demand"
],
"type": "string",
"description": "Ad type (\"offer\", \"demand\"). Used by: Search."
},
"sort": {
"title": "Sort",
"enum": [
"relevance",
"newest",
"oldest",
"price_low",
"price_high"
],
"type": "string",
"description": "Sort order (\"relevance\", \"newest\", \"oldest\", \"price_low\", \"price_high\"). Used by: Search."
},
"page": {
"title": "Page",
"type": "integer",
"description": "Page number (1-indexed). Defaults to 1. Used by: Search.",
"default": 1
},
"limit": {
"title": "Limit",
"type": "integer",
"description": "Results per page. Used by: Search, Get Similar Ads."
},
"list_id": {
"title": "List id",
"type": "integer",
"description": "The Leboncoin ad id. Required for: Get Ad, Get Similar Ads."
},
"q": {
"title": "Q",
"type": "string",
"description": "Partial location query. Required for: Search Locations."
},
"max_items": {
"title": "Max items",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many records. The actor keeps paging until it hits this number or the site runs out of results. Each page is one charged event.",
"default": 100
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}