{
  "openapi": "3.0.1",
  "info": {
    "title": "Leilão de Veículos Brasil: Copart, Superbid",
    "description": "Clean JSON of car, motorcycle and truck auction lots from 10 Brazilian sources: Copart, Superbid, Freitas, Sodré Santoro, Loop, VIP, Detran-SP and more. Current bid, year, mileage, location, salvage flag and optional FIPE discount. Filter by model, brand, state and price. No login or API key.",
    "version": "0.2",
    "x-build-id": "dUowmNheTPGExHWKL"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/allanmxr~brazil-vehicle-auctions-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-allanmxr-brazil-vehicle-auctions-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/allanmxr~brazil-vehicle-auctions-scraper/runs": {
      "post": {
        "operationId": "runs-sync-allanmxr-brazil-vehicle-auctions-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/allanmxr~brazil-vehicle-auctions-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-allanmxr-brazil-vehicle-auctions-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": {
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Vehicle names, for example \"onix\" or \"corolla xei\". A lot matches when it contains every word of at least one term (accents and case are ignored). Leave empty to list all vehicles, up to Max items.",
            "items": {
              "type": "string"
            }
          },
          "vehicleType": {
            "title": "Vehicle type",
            "enum": [
              "car",
              "motorcycle",
              "truck",
              "other"
            ],
            "type": "string",
            "description": "Cars, motorcycles, trucks (and buses) or other vehicles. Auction houses without that type are skipped.",
            "default": "car"
          },
          "brands": {
            "title": "Brands",
            "type": "array",
            "description": "Only lots of these brands. Leave empty for all brands.",
            "items": {
              "type": "string",
              "enum": [
                "ALFA ROMEO",
                "ASTON MARTIN",
                "AUDI",
                "BMW",
                "BYD",
                "CAOA CHERY",
                "CHERY",
                "CHEVROLET",
                "CITROEN",
                "DAF",
                "DAFRA",
                "DODGE",
                "EFFA",
                "FIAT",
                "FORD",
                "GEELY",
                "GWM",
                "HARLEY-DAVIDSON",
                "HONDA",
                "HYUNDAI",
                "IVECO",
                "JAC",
                "JAECOO",
                "JEEP",
                "KAWASAKI",
                "KIA",
                "LAND ROVER",
                "LEXUS",
                "LIFAN",
                "MAN",
                "MAZDA",
                "MERCEDES-BENZ",
                "MINI",
                "MITSUBISHI",
                "NISSAN",
                "PEUGEOT",
                "PORSCHE",
                "RAM",
                "RENAULT",
                "SCANIA",
                "SSANGYONG",
                "SUBARU",
                "SUZUKI",
                "TOYOTA",
                "TROLLER",
                "VOLKSWAGEN",
                "VOLVO",
                "YAMAHA"
              ]
            }
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of lots in the dataset, shared across the auction houses (each one contributes in turn, so one big house does not use up the limit). You are charged per lot returned.",
            "default": 100
          },
          "yearMin": {
            "title": "Minimum model year",
            "minimum": 1950,
            "type": "integer",
            "description": "Skip vehicles older than this model year. Lots whose year cannot be read are skipped when a year filter is set."
          },
          "yearMax": {
            "title": "Maximum model year",
            "minimum": 1950,
            "type": "integer",
            "description": "Skip vehicles newer than this model year."
          },
          "priceMin": {
            "title": "Minimum price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Compared with the current bid, or the starting price when there is no bid yet."
          },
          "priceMax": {
            "title": "Maximum price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Compared with the current bid, or the starting price when there is no bid yet."
          },
          "mileageMax": {
            "title": "Maximum mileage (km)",
            "minimum": 0,
            "type": "integer",
            "description": "Lots whose auction house does not publish the mileage are kept, check the mileageKm field."
          },
          "states": {
            "title": "States (UF)",
            "type": "array",
            "description": "Only lots located in these Brazilian states. Leave empty for the whole country.",
            "items": {
              "type": "string",
              "enum": [
                "AC",
                "AL",
                "AM",
                "AP",
                "BA",
                "CE",
                "DF",
                "ES",
                "GO",
                "MA",
                "MG",
                "MS",
                "MT",
                "PA",
                "PB",
                "PE",
                "PI",
                "PR",
                "RJ",
                "RN",
                "RO",
                "RR",
                "RS",
                "SC",
                "SE",
                "SP",
                "TO"
              ]
            }
          },
          "cities": {
            "title": "Cities",
            "type": "array",
            "description": "Only lots located in these cities, for example \"Campinas\" (accents and case are ignored).",
            "items": {
              "type": "string"
            }
          },
          "damage": {
            "title": "Accident history",
            "enum": [
              "all",
              "no_damage",
              "damaged_only"
            ],
            "type": "string",
            "description": "Lots with accident (sinistro), insurance recovery, flood or scrap history are flagged isSalvage = true. Pick which ones to keep.",
            "default": "all"
          },
          "auctionDateFrom": {
            "title": "Auction date from",
            "type": "string",
            "description": "Only lots whose auction ends on or after this date."
          },
          "auctionDateTo": {
            "title": "Auction date to",
            "type": "string",
            "description": "Only lots whose auction ends on or before this date."
          },
          "sources": {
            "title": "Auction houses",
            "type": "array",
            "description": "Which auction houses to scrape. VIP Leilões is off by default because it only allows about one request every 6 seconds (a full listing takes ~15 min); select it if you want it. Detran-SP is also off by default: about 80% of its lots are scrap, so select it when you want them.",
            "items": {
              "type": "string",
              "enum": [
                "copart",
                "superbid",
                "freitas",
                "sodre",
                "rogerio-menezes",
                "loop",
                "vip",
                "mega-leiloes",
                "palacio-leiloes",
                "detran-sp"
              ],
              "enumTitles": [
                "Copart Brasil",
                "Superbid",
                "Freitas Leiloeiro",
                "Sodre Santoro",
                "Rogerio Menezes",
                "Loop Leiloes",
                "VIP Leiloes",
                "Mega Leiloes",
                "Palacio dos Leiloes",
                "Detran-SP (Sumare Leiloes)"
              ]
            },
            "default": [
              "copart",
              "superbid",
              "freitas",
              "sodre",
              "rogerio-menezes",
              "loop",
              "mega-leiloes",
              "palacio-leiloes"
            ]
          },
          "includeFipe": {
            "title": "Add FIPE price comparison",
            "type": "boolean",
            "description": "Adds fipePrice, fipeModel and fipeDiscountPct from the public FIPE API (parallelum.com.br). When several FIPE models fit equally well, only fipePriceMin and fipePriceMax are filled. The free API allows about 1,000 requests a day.",
            "default": false
          },
          "minFipeDiscountPct": {
            "title": "Minimum discount below FIPE (%)",
            "minimum": 0,
            "type": "number",
            "description": "Only lots at least this far below the FIPE price, best first. Turns the FIPE comparison on and checks every candidate lot before applying Max items, so the run takes longer."
          },
          "fipeApiToken": {
            "title": "FIPE API token (optional)",
            "type": "string",
            "description": "Optional token from fipe.online to raise the FIPE API rate limit."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Only Sodre Santoro uses it (it needs a Brazilian residential IP). Copart and the other auction houses are read without a proxy.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "BR"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}