// docs

Portal Zuk: Get listing details

Extracts a property page at auction from Portal Zuk with lot identification, address and coordinates, photos, occupancy, characteristics, rounds, values, discount, seller, registration, process, visitation, payments and documents.

portalzuk.com.br:pdp · 1 credit per request

Standard credit cost. Your account pricing is shown in the sandbox.

Try this operation in the sandbox

HTTP request

cURL

curl -X POST https://api.geckoapi.com.br/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "portalzuk.com.br",
  "type": "pdp",
  "url": "https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343"
}'

Keep your API key on your server. See the quickstart for authentication and response handling.

MCP request

The hosted MCP tool fixes target and type for this operation. Its remaining arguments use the same input rules as Extract.

POST /v1/mcp · Bearer or X-API-Key authentication

portalzuk_com_br_pdp · tools/call

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "portalzuk_com_br_pdp",
    "arguments": {
      "url": "https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343",
      "executionId": "exec_example_123"
    }
  }
}

Supported inputs

Conditional fields depend on the alternatives and constraints in the rule column. Fields marked unsupported are omitted.

Field	Type	Requirement	Rule	Default	Example
url URL extraction target. For some PLPs it can be omitted when API assembles URL from other fields.	string (URL)	Required	URL HTTPS from Portal Zuk under /imovel/, ending with the identifiers auctionId-lotId.	-	https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343
target Target source for extraction.	enum	Required	Always portalzuk.com.br.	-	portalzuk.com.br
type Extraction type: pdp, idp, plp, ilp, quote, review or places.	enum	Required	Always pdp.	-	pdp

Request examples

Details by batch URL

Send the public URL returned in the items[].url field of PLP. URL must be in /imovel/ and end with auctionId-lotId.

Details by batch URL

{
  "target": "portalzuk.com.br",
  "type": "pdp",
  "url": "https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343"
}

Response schema

Leaf paths and expected types. Field names and enum values are part of the API contract.

responseSchema

{
  "source": "\"portalzuk.com.br\"",
  "type": "\"pdp\"",
  "parser": "\"1.0.0\"",
  "requestUrl": "string (URL)",
  "canonicalUrl": "string (URL)",
  "extractedAt": "string (ISO datetime)",
  "auctionId": "integer",
  "lotId": "integer",
  "zukCode": "string",
  "lotNumber": "string",
  "title": "string",
  "propertyType": "string",
  "address.formatted": "string",
  "address.city": "string",
  "address.state": "string",
  "address.latitude": "number",
  "address.longitude": "number",
  "images[]": "string (URL)",
  "occupancyStatus": "string",
  "occupied": "boolean",
  "description": "string",
  "observations": "string",
  "visitation": "string",
  "registration": "string",
  "taxpayerId": "string",
  "lawsuitNumber": "string",
  "lawsuitUrl": "string (URL)",
  "features[].label": "string",
  "features[].value": "string",
  "auctionType": "string",
  "auctionRelationUrl": "string (URL)",
  "participationUrl": "string (URL)",
  "closingLabel": "string",
  "auctionRounds[].label": "string",
  "auctionRounds[].price": "number",
  "auctionRounds[].date": "string (ISO datetime)",
  "auctionRounds[].discountPercent": "number",
  "minimumBid": "number",
  "currentBid": "number",
  "minimumIncrement": "number",
  "discountPercent": "number",
  "commissionPercent": "number",
  "seller.name": "string",
  "seller.slug": "string",
  "paymentOptions[].label": "string",
  "paymentOptions[].maxInstallments": "integer",
  "installmentProposal": "string",
  "documents[].label": "string",
  "documents[].url": "string (URL)",
  "documents[].requiresLogin": "boolean"
}

Example response

Illustrative response. Product names, reviews and other source content retain their original language. Missing and null values do not imply zero stock, free shipping or zero reviews.

responseExample

{
  "source": "portalzuk.com.br",
  "type": "pdp",
  "parser": "1.0.0",
  "url": "https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343",
  "canonicalUrl": "https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343",
  "requestUrl": "https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343",
  "extractedAt": "2026-07-15T12:00:05.000Z",
  "auctionId": 36784,
  "lotId": 229343,
  "zukCode": "ZUK229343",
  "lotNumber": "1",
  "title": "Casa à venda em leilão",
  "propertyType": "Casa",
  "metaTitle": "Casa em leilão em Ribeirão Preto",
  "metaDescription": "Imóvel residencial disponível em leilão no Portal Zuk.",
  "address": {
    "formatted": "Rua Regina Aurea Barroso Reis, 96 - Residencial Greenville - Ribeirão Preto/SP",
    "street": "Rua Regina Aurea Barroso Reis, 96",
    "neighborhood": "Residencial Greenville",
    "city": "Ribeirão Preto",
    "state": "SP",
    "latitude": -21.1767,
    "longitude": -47.8208
  },
  "images": [
    "https://static.portalzuk.com.br/imovel/detalhe/229343-1.jpg"
  ],
  "occupancyStatus": "Imóvel desocupado",
  "occupied": false,
  "description": "Casa residencial com área construída, terreno e dependências descritas no edital.",
  "observations": "Consulte o edital e os documentos antes de participar.",
  "visitation": "Visitação mediante agendamento conforme as regras do leilão.",
  "registration": "Matrícula 123456 do 1º Cartório de Registro de Imóveis. Nº Contribuinte: 1234567",
  "taxpayerId": "1234567",
  "lawsuitNumber": "1001234-56.2025.8.26.0000",
  "lawsuitUrl": "https://www.portalzuk.com.br/documento/processo/229343",
  "features": [
    {
      "label": "Área construída",
      "value": "180,00 m²",
      "numericValue": 180
    }
  ],
  "auctionType": "judicial",
  "auctionRelationUrl": "https://www.portalzuk.com.br/leilao-de-imoveis/tl/residenciais/leilao-judicial",
  "participationUrl": "https://www.portalzuk.com.br/participar/36784/229343",
  "closingLabel": "Encerramento do leilão",
  "auctionRounds": [
    {
      "label": "1º Leilão",
      "price": 450000,
      "date": "2026-07-22T14:00:00.000Z",
      "dateLabel": "22/07/2026 às 14h",
      "discountPercent": 25
    }
  ],
  "minimumBid": 450000,
  "currentBid": 450000,
  "minimumIncrement": 5000,
  "discountPercent": 25,
  "commissionPercent": 5,
  "seller": {
    "name": "Caixa Econômica Federal",
    "url": "https://www.portalzuk.com.br/leilao-de-imoveis/v/caixa-economica-federal",
    "logoUrl": "https://static.portalzuk.com.br/comitentes/caixa.png",
    "slug": "caixa-economica-federal"
  },
  "paymentOptions": [
    {
      "label": "À vista ou em até 12x conforme edital",
      "maxInstallments": 12
    }
  ],
  "installmentProposal": "Propostas parceladas devem observar a entrada e os prazos indicados no edital.",
  "documents": [
    {
      "id": 12345,
      "label": "Edital do leilão",
      "url": "https://www.portalzuk.com.br/documento/edital/12345",
      "requiresLogin": false
    }
  ]
}

Complete field reference

Path	Type	Description	Example
address.city	string	City of property.	Ribeirão Preto
address.formatted	string	Full address displayed.	Rua Regina Aurea Barroso Reis, 96 - Residencial Greenville - Ribeirão Preto/SP
address.latitude	number	Latitude published on the page.	-21.1767
address.longitude	number	Longitude published on the page.	-47.8208
address.state	string	UF of the property.	SP
auctionId	integer	Auction identifier.	36784
auctionRelationUrl	string (URL)	Link to the modality listing.	https://www.portalzuk.com.br/leilao-de-imoveis/tl/residenciais/leilao-judicial
auctionRounds[].date	string (ISO datetime)	Normalized round date.	2026-07-22T14:00:00.000Z
auctionRounds[].discountPercent	number	Discount indicated for the round.	25
auctionRounds[].label	string	Round name.	1º Leilão
auctionRounds[].price	number	Minimum round value.	450000
auctionType	string	Standard auction type.	judicial
canonicalUrl	string (URL)	URL canonical declared by the page.	https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343
closingLabel	string	Closing text displayed.	Encerramento do leilão
commissionPercent	number	Commission percentage.	5
currentBid	number	Highest bid/current value when published.	450000
description	string	Property description.	Casa residencial com área construída, terreno e dependências descritas no edital.
discountPercent	number	Discount compared to evaluation.	25
documents[].label	string	Document name.	Edital do leilão
documents[].requiresLogin	boolean	Indicates whether access requires source authentication.	false
documents[].url	string (URL)	URL public document when available.	https://www.portalzuk.com.br/documento/edital/12345
extractedAt	string (ISO datetime)	Extraction instant.	2026-07-15T12:00:05.000Z
features[].label	string	Characteristic name.	Área construída
features[].value	string	Textual value of the characteristic.	180,00 m²
images[]	string (URL)	Image gallery.	https://static.portalzuk.com.br/imovel/detalhe/229343-1.jpg
installmentProposal	string	Conditions for installment proposal.	Propostas parceladas devem observar a entrada e os prazos indicados no edital.
lawsuitNumber	string	Court case number.	1001234-56.2025.8.26.0000
lawsuitUrl	string (URL)	Link related to the process.	https://www.portalzuk.com.br/documento/processo/229343
lotId	integer	Lot/property identifier.	229343
lotNumber	string	Auction lot number.	1
minimumBid	number	Lowest value identified in the rounds.	450000
minimumIncrement	number	Minimum bid increment.	5000
observations	string	Lot observations and reservations.	Consulte o edital e os documentos antes de participar.
occupancyStatus	string	Occupancy text displayed.	Imóvel desocupado
occupied	boolean	Standard occupancy indicator.	false
parser	"1.0.0"	Stable version of the API response format.	1.0.0
participationUrl	string (URL)	Public link for participation.	https://www.portalzuk.com.br/participar/36784/229343
paymentOptions[].label	string	Description of the payment method.	À vista ou em até 12x conforme edital
paymentOptions[].maxInstallments	integer	Maximum installments identified.	12
propertyType	string	Property type.	Casa
registration	string	Registration/registration text.	Matrícula 123456 do 1º Cartório de Registro de Imóveis. Nº Contribuinte: 1234567
requestUrl	string (URL)	Same value as `url`; never exposes the queried internal endpoint.	https://www.portalzuk.com.br/imovel/sp/ribeirao-preto/residencial-greenville/rua-regina-aurea-barroso-reis-96/36784-229343
seller.name	string	Name of the seller/client.	Caixa Econômica Federal
seller.slug	string	Seller slug for new searches.	caixa-economica-federal
source	"portalzuk.com.br"	Normalized extraction source.	portalzuk.com.br
taxpayerId	string	Tax number when identified.	1234567
title	string	Property title.	Casa à venda em leilão
type	"pdp"	Seam type PDP.	pdp
visitation	string	Visiting rules and information.	Visitação mediante agendamento conforme as regras do leilão.
zukCode	string	Internal code displayed by Portal Zuk.	ZUK229343

Errors and missing data

When supported by this operation, an entity not found upstream can return HTTP 200 with data: null and notFound: true. Check the documented response fields before interpreting an empty result. Source-specific behavior and exceptions are described above.

HTTP status	Error code	Meaning
400	`INVALID_PAYLOAD`	Invalid JSON or a request that violates the documented validation rules.
401	`UNAUTHORIZED`	Missing authorization or an invalid API key or token.
402	`INSUFFICIENT_CREDITS`	The account has insufficient credits for this operation.
403	`FORBIDDEN`	The account does not have access, or the API is temporarily disabled.
409	`EXECUTION_CONFLICT`	The execution identifier conflicts with an incompatible execution state.
429	`RATE_LIMIT_EXCEEDED / TOO_MANY_INFLIGHT_REQUESTS`	A rate limit or simultaneous request limit was exceeded.
5xx	`UPSTREAM_TIMEOUT / UPSTREAM_HTTP_ERROR / WORKER_FUNCTION_ERROR`	An upstream, worker or gateway failure. Failed requests follow the platform refund policy.

Other Portal Zuk operations

Search listings (PLP)