{ "openapi": "3.0.1", "info": { "title": "Portugal Property Auctions API - e-leiloes Judicial Auctions", "description": "[💵 $4.00 / 1K] Official Portugal e-leiloes judicial auctions in a clean English schema: minimum bid, appraisal discount, court case, debtor signals, location, and enforcement-agent contact for property, vehicle, and equipment auction sourcing.", "version": "0.1", "x-build-id": "oV609h4KpaEvm7msY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdata_labs~portugal-e-leiloes-auctions-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdata_labs-portugal-e-leiloes-auctions-api", "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/webdata_labs~portugal-e-leiloes-auctions-api/runs": { "post": { "operationId": "runs-sync-webdata_labs-portugal-e-leiloes-auctions-api", "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/webdata_labs~portugal-e-leiloes-auctions-api/run-sync": { "post": { "operationId": "run-sync-webdata_labs-portugal-e-leiloes-auctions-api", "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": { "districts": { "title": "Districts (distritos)", "type": "array", "description": "Portuguese districts to search. One request per district. Valid values: Aveiro, Beja, Braga, Bragança, Castelo Branco, Coimbra, Évora, Faro, Guarda, Ilha da Graciosa, Ilha da Madeira, Ilha das Flores, Ilha de Porto Santo, Ilha de Santa Maria, Ilha de São Jorge, Ilha de São Miguel, Ilha do Faial, Ilha do Pico, Ilha Terceira, Leiria, Lisboa, Portalegre, Porto, Santarém, Setúbal, Viana do Castelo, Vila Real, Viseu. Leave empty or use \"all\" to search all of Portugal (cap with Max results).", "items": { "type": "string" } }, "assetTypes": { "title": "Asset types", "type": "array", "description": "Optional filter. Accepts English names or codes: Real estate (1), Vehicle (2), Equipment (3), Furniture (4), Machinery (5), Right (6). Empty = all asset types.", "default": [ "Real estate" ], "items": { "type": "string" } }, "status": { "title": "Auction status", "enum": [ "live", "ended" ], "type": "string", "description": "\"live\" = auctions currently on sale (a decorrer). \"ended\" = terminated auctions.", "default": "live" }, "minValueEur": { "title": "Min minimum-bid (EUR)", "minimum": 0, "type": "integer", "description": "Only auctions whose minimum acceptable bid (valor mínimo) is at or above this value." }, "maxValueEur": { "title": "Max minimum-bid (EUR)", "minimum": 0, "type": "integer", "description": "Only auctions whose minimum acceptable bid (valor mínimo) is at or below this value." }, "includeDetails": { "title": "Include full details", "type": "boolean", "description": "Fetch each auction's detail record for area, coordinates, VAT, opening bid, the judicial process (court, case number, debtors), encumbrances (ónus), the auction ceremony, and the enforcement agent's name, phone and email. One extra request per auction - slower on large searches, but this is where the investor-lead and contact fields come from.", "default": false }, "onlyNewAuctions": { "title": "Only new auctions (monitoring mode)", "type": "boolean", "description": "Push only auctions not seen in previous runs of this Actor on your account (per district and asset type). The first run returns everything and initializes memory; every following run returns just the delta - ideal for scheduled monitoring, and you are charged only for new rows.", "default": false }, "maxResults": { "title": "Max results per scope", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cap the number of auctions collected per district/asset-type combination.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify cloud reaches e-leiloes.pt more reliably through RESIDENTIAL proxy exits than direct datacenter IPs. Keep enabled unless you have a reason to test direct access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }