{
"openapi": "3.0.1",
"info": {
"title": "Licitor Scraper: French Judicial Real Estate Auctions",
"description": "New French judicial real estate auction listings (ventes aux enchères immobilières) and hammer prices from licitor.com, as a clean table. No personal data. Run daily.",
"version": "0.1",
"x-build-id": "qhQR2Ijk1dNREzTyq"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/klyde_nsx~licitor-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-klyde_nsx-licitor-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/klyde_nsx~licitor-scraper/runs": {
"post": {
"operationId": "runs-sync-klyde_nsx-licitor-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/klyde_nsx~licitor-scraper/run-sync": {
"post": {
"operationId": "run-sync-klyde_nsx-licitor-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",
"properties": {
"mode": {
"title": "Mode / Mode",
"enum": [
"new_listings",
"results",
"both"
],
"type": "string",
"description": "What to collect. new_listings: listings published since the last run (first run: last 7 days). results: hammer prices of hearings from the last N days. both: both. / Que collecter. new_listings : annonces publiées depuis le dernier lancement (premier lancement : 7 derniers jours). results : prix d'adjudication des audiences des N derniers jours. both : les deux.",
"default": "both"
},
"departements": {
"title": "Départements / Départements",
"type": "array",
"description": "French département codes, e.g. 69, 75, 2A, 974. Empty = all of France. / Codes de département, par ex. 69, 75, 2A, 974. Vide = toute la France.",
"default": [],
"items": {
"type": "string"
}
},
"region": {
"title": "Region / Région",
"enum": [
"auvergne-rhone-alpes",
"bourgogne-franche-comte",
"bretagne",
"centre-val-de-loire",
"corse",
"grand-est",
"hauts-de-france",
"ile-de-france",
"normandie",
"nouvelle-aquitaine",
"occitanie",
"pays-de-la-loire",
"provence-alpes-cote-d-azur",
"outre-mer"
],
"type": "string",
"description": "Shortcut: adds all départements of a region to the list above. / Raccourci : ajoute tous les départements d'une région à la liste ci-dessus."
},
"typesDeBien": {
"title": "Property types / Types de bien",
"type": "array",
"description": "Keep only these property types. Empty = all. / Ne garder que ces types de bien. Vide = tous.",
"items": {
"type": "string",
"enum": [
"apartment",
"house",
"building",
"commercial",
"land",
"parking",
"other"
],
"enumTitles": [
"Apartment / Appartement",
"House / Maison",
"Building / Immeuble",
"Commercial / Local commercial",
"Land / Terrain",
"Parking / Parking",
"Other / Autre"
]
},
"default": []
},
"miseAPrixMin": {
"title": "Minimum starting price (€) / Mise à prix minimale (€)",
"minimum": 0,
"type": "integer",
"description": "New listings only: minimum starting price in euros. Empty = no minimum. / Nouvelles annonces seulement : mise à prix minimale en euros. Vide = pas de minimum."
},
"miseAPrixMax": {
"title": "Maximum starting price (€) / Mise à prix maximale (€)",
"minimum": 0,
"type": "integer",
"description": "New listings only: maximum starting price in euros. Empty = no maximum. / Nouvelles annonces seulement : mise à prix maximale en euros. Vide = pas de maximum."
},
"saleDateFrom": {
"title": "Sale date from / Date de vente à partir du",
"type": "string",
"description": "Keep sales on or after this date (results: hearing date). Applied once the listing is open. / Ventes à partir de cette date (résultats : date d'audience). Appliqué une fois la fiche ouverte."
},
"saleDateTo": {
"title": "Sale date until / Date de vente jusqu'au",
"type": "string",
"description": "Keep sales on or before this date. / Ventes jusqu'à cette date incluse."
},
"occupancyFilter": {
"title": "Occupancy / Occupation",
"enum": [
"any",
"free_only"
],
"type": "string",
"description": "free_only: keep only properties stated as free (libre) on the listing; listings that say nothing are dropped. / free_only : ne garder que les biens indiqués libres sur la fiche ; les fiches muettes sont écartées.",
"default": "any"
},
"joursResultats": {
"title": "Results: number of days / Résultats : nombre de jours",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Results mode: hearings from the last N days (maximum 10). / Mode résultats : audiences des N derniers jours (10 au maximum).",
"default": 10
},
"maxResultats": {
"title": "Maximum rows per run / Nombre maximal de lignes par lancement",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Stop after this many rows (you pay per row). / Arrêt après ce nombre de lignes (facturation à la ligne).",
"default": 50
},
"cleMemoire": {
"title": "Memory key / Nom de la mémoire",
"pattern": "^[\\w.-]{1,100}$",
"type": "string",
"description": "Name of the memory that remembers what was already delivered. Use a different name for each saved search. Letters, digits, dot, dash, underscore. / Nom de la mémoire des annonces déjà livrées. Un nom différent par recherche suivie. Lettres, chiffres, point, tiret, tiret bas.",
"default": "defaut"
}
}
},
"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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}