{ "openapi": "3.0.1", "info": { "title": "Caixa Leiloes Properties and Details Scraper", "description": "Extract source-backed CAIXA auction and direct-sale property records only after confirming permission for automated access and intended reuse. Errors and permission skips are reported in OUTPUT_SUMMARY; no source request is made by default.", "version": "1.0", "x-build-id": "Rkv42B8TSPVusn526" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/realestateapi~caixa-leiloes-properties-and-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-realestateapi-caixa-leiloes-properties-and-details-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/realestateapi~caixa-leiloes-properties-and-details-scraper/runs": { "post": { "operationId": "runs-sync-realestateapi-caixa-leiloes-properties-and-details-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/realestateapi~caixa-leiloes-properties-and-details-scraper/run-sync": { "post": { "operationId": "run-sync-realestateapi-caixa-leiloes-properties-and-details-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": { "siteAuthorizationConfirmed": { "title": "Confirm written permission and data-use rights", "type": "boolean", "description": "Confirm you have permission covering automated access to CAIXA property pages, the fields collected, and intended reuse. Leave false unless you have verified this.", "default": false }, "propertyIds": { "title": "Property IDs", "maxItems": 100, "type": "array", "description": "Caixa property identifiers used to build public detail URLs.", "items": { "type": "string" } }, "propertyId": { "title": "Property ID", "maxLength": 80, "type": "string", "description": "One explicitly selected Caixa property identifier. No property is selected by default." }, "detailUrls": { "title": "Property detail URLs", "maxItems": 100, "type": "array", "description": "Public venda-imoveis.caixa.gov.br detalhe-imovel.asp URLs.", "items": { "type": "string" } }, "searchUrls": { "title": "Caixa search URLs", "maxItems": 20, "type": "array", "description": "Public Caixa search pages containing detalhe-imovel links.", "items": { "type": "string" } }, "includeDetails": { "title": "Fetch property details from search results", "type": "boolean", "description": "Follow property links found on explicitly supplied search pages. Enable only when your permission covers detail-page requests.", "default": false }, "startUrls": { "title": "Public Caixa URLs", "maxItems": 100, "type": "array", "description": "Request-list alias for public search or detail URLs.", "items": { "type": "object", "properties": { "url": { "title": "Caixa public URL", "type": "string", "description": "Public Caixa property search or detail URL." } }, "required": [ "url" ] } }, "maxProperties": { "title": "Maximum properties", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum property records to emit.", "default": 5 }, "maxItems": { "title": "Maximum properties alias", "minimum": 1, "maximum": 100, "type": "integer", "description": "Alias for maxProperties." }, "timeoutMs": { "title": "Request timeout (ms)", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Maximum time allowed for each public request.", "default": 30000 }, "userAgent": { "title": "User agent", "maxLength": 300, "type": "string", "description": "Optional transparent HTTP user-agent; it does not bypass access controls." }, "acceptLanguage": { "title": "Accept-Language", "maxLength": 120, "type": "string", "description": "Optional normal HTTP language preference.", "default": "pt-BR,pt;q=0.9,en;q=0.8" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Retained for compatibility; direct requests are used and access controls are not bypassed." } } }, "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 } } } } } } } } } }