{
  "openapi": "3.0.3",
  "info": {
    "title": "Apibara Copart & IAAI Vehicle Auction API",
    "description": "Structured JSON API for Copart and IAAI vehicle auction data. Search auction vehicles, retrieve VIN and lot details, photos, prices, auction status, sale history, related vehicles, filters, locations, usage information, image proxy responses, and auction-to-port shipping prices.",
    "version": "1.0.1",
    "termsOfService": "https://apibara.tech/en/terms",
    "contact": {
      "name": "Apibara",
      "url": "https://apibara.tech/en/products/vehicle-auction-data-api",
      "email": "admin@apibara.tech"
    },
    "license": {
      "name": "Proprietary",
      "url": "https://apibara.tech/en/terms"
    }
  },
  "servers": [
    {
      "url": "https://apibara.tech/api/v1/vehicle-auction",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Vehicles",
      "description": "Search and retrieve vehicle auction records."
    },
    {
      "name": "Vehicle History",
      "description": "VIN and lot auction history."
    },
    {
      "name": "Related Vehicles",
      "description": "Related and similar auction vehicles."
    },
    {
      "name": "Filters",
      "description": "Available filters metadata."
    },
    {
      "name": "Locations",
      "description": "Auction facility and location search."
    },
    {
      "name": "Shipping",
      "description": "Auction-to-port delivery prices."
    },
    {
      "name": "URL Tools",
      "description": "Resolve vehicle details from auction URLs."
    },
    {
      "name": "Usage",
      "description": "API usage and plan limit information."
    },
    {
      "name": "Image Proxy",
      "description": "Proxy supported auction vehicle images."
    }
  ],
  "paths": {
    "/vehicles": {
      "get": {
        "tags": [
          "Vehicles"
        ],
        "summary": "List auction vehicles",
        "description": "Search, filter, and paginate Copart and IAAI vehicle auction records.",
        "operationId": "listAuctionVehicles",
        "parameters": [
          {
            "name": "s",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Search by lot number, VIN, or vehicle title.",
            "example": "BMW X5 / 1HGCM82633A123456 / 12345678"
          },
          {
            "name": "lot_status",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "All",
                "Timed",
                "Buy Now"
              ],
              "default": "All"
            },
            "description": "Lot status filter."
          },
          {
            "name": "lot_sub_status",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "Live",
                "Open",
                "Ended"
              ],
              "default": "Open"
            },
            "description": "Lot sub status filter."
          },
          {
            "name": "price_min",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Minimum price.",
            "example": 1000
          },
          {
            "name": "price_max",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Maximum price.",
            "example": 15000
          },
          {
            "name": "year_from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "description": "Minimum vehicle year.",
            "example": 2018
          },
          {
            "name": "year_to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "description": "Maximum vehicle year.",
            "example": 2024
          },
          {
            "name": "auction_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "enum": [
                0,
                1,
                2
              ],
              "default": 0
            },
            "description": "Numeric auction platform filter: 0 = all supported platforms, 1 = Copart, 2 = IAAI. Use either auction_type or platform in the same request.",
            "example": 1
          },
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "copart",
                "iaai"
              ]
            },
            "description": "Readable auction platform filter. Use copart or iaai. Use either platform or auction_type in the same request.",
            "example": "copart"
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle type.",
            "example": "AUTOMOBILE"
          },
          {
            "name": "make",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle make.",
            "example": "BMW"
          },
          {
            "name": "model",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle model.",
            "example": "X5"
          },
          {
            "name": "color",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "description": "Vehicle color. Multiple values are supported.",
            "example": [
              "Black",
              "White"
            ],
            "style": "form",
            "explode": true
          },
          {
            "name": "fuel_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Diesel",
                  "Hybrid",
                  "Electric",
                  "Flexible",
                  "Gasoline",
                  "All others"
                ]
              }
            },
            "description": "Fuel type. Multiple values are supported.",
            "style": "form",
            "explode": true,
            "example": [
              "Gasoline",
              "Hybrid"
            ]
          },
          {
            "name": "odometer_from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Minimum odometer value.",
            "example": 0
          },
          {
            "name": "odometer_to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Maximum odometer value.",
            "example": 120000
          },
          {
            "name": "engine_size_from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Minimum engine size.",
            "example": 2.0
          },
          {
            "name": "engine_size_to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Maximum engine size.",
            "example": 5.0
          },
          {
            "name": "engine_hp_from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Minimum engine horsepower.",
            "example": 150
          },
          {
            "name": "engine_hp_to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Maximum engine horsepower.",
            "example": 500
          },
          {
            "name": "transmission",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Manual",
                  "Unknown",
                  "Automatic"
                ]
              }
            },
            "description": "Transmission type. Multiple values are supported.",
            "style": "form",
            "explode": true,
            "example": [
              "Automatic"
            ]
          },
          {
            "name": "cylinders",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "integer"
              }
            },
            "description": "Number of cylinders. Multiple values are supported.",
            "example": [
              4,
              6
            ],
            "style": "form",
            "explode": true
          },
          {
            "name": "drive_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "AWD",
                  "FWD",
                  "RWD"
                ]
              }
            },
            "description": "Drive type. Multiple values are supported.",
            "style": "form",
            "explode": true,
            "example": [
              "AWD",
              "FWD"
            ]
          },
          {
            "name": "run_cond",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "STATIONARY",
                "NO INFORMATION",
                "RUNS AND DRIVES",
                "ENGINE START PROGRAM"
              ]
            },
            "description": "Run condition."
          },
          {
            "name": "damage",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Fire",
                  "Hail",
                  "Theft",
                  "Water",
                  "Chemical",
                  "Rollover",
                  "Mechanical",
                  "Vandalized",
                  "Repossession"
                ]
              }
            },
            "description": "Damage type. Multiple values are supported.",
            "style": "form",
            "explode": true,
            "example": [
              "Hail",
              "Mechanical"
            ]
          },
          {
            "name": "has_key",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "No",
                "All",
                "With"
              ]
            },
            "description": "Filter vehicles by key availability."
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Cursor for pagination.",
            "example": "next_cursor or prev_cursor"
          },
          {
            "name": "zip",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "ZIP code for location-based search.",
            "example": "33166"
          },
          {
            "name": "radius",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Search radius around ZIP.",
            "example": 50
          },
          {
            "name": "units",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "km",
                "mi"
              ],
              "default": "mi"
            },
            "description": "Distance units."
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20,
              "default": 20
            },
            "description": "Number of records per page. Maximum: 20.",
            "example": 20
          },
          {
            "name": "facility_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Auction facility ID.",
            "example": "136"
          },
          {
            "name": "loc_state",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Location state code.",
            "example": "FL"
          },
          {
            "name": "office_name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Auction office or branch name.",
            "example": "Miami"
          },
          {
            "name": "auction_date_from",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "description": "Auction date from.",
            "example": "2026-03-20"
          },
          {
            "name": "auction_date_to",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            },
            "description": "Auction date to.",
            "example": "2026-03-25"
          },
          {
            "name": "today_only",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "Return only vehicles with auctions today."
          },
          {
            "name": "sale_document_pending",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "Filter by pending sale document."
          },
          {
            "name": "sale_document_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Sale document type.",
            "example": "clean"
          },
          {
            "name": "seller_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "dealer",
                "finance",
                "insurance",
                "non_insurance"
              ]
            },
            "description": "Seller type."
          },
          {
            "name": "has_shipping_price",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "Return only vehicles with shipping price data."
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of vehicle auction records.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/vehicles/{slugVin}": {
      "get": {
        "tags": [
          "Vehicles"
        ],
        "summary": "Get vehicle details",
        "description": "Get vehicle auction details by VIN or lot number.",
        "operationId": "getVehicleDetails",
        "parameters": [
          {
            "name": "slugVin",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle identifier. Can be VIN or lot number.",
            "example": "WBAVL1C58FVY28848 or 78691915"
          }
        ],
        "responses": {
          "200": {
            "description": "Vehicle auction details.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleDetailsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/vehicles/{slugVin}/history": {
      "get": {
        "tags": [
          "Vehicle History"
        ],
        "summary": "Get vehicle auction history",
        "description": "Get auction history records for a vehicle by VIN or lot number.",
        "operationId": "getVehicleHistory",
        "parameters": [
          {
            "name": "slugVin",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle identifier. Can be VIN or lot number.",
            "example": "WBAVL1C58FVY28848 or 78691915"
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20,
              "default": 20
            },
            "description": "Number of records per page. Maximum: 20.",
            "example": 20
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Cursor for pagination.",
            "example": "next_cursor"
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated vehicle auction history records.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleHistoryResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/vehicles/{slugVin}/related": {
      "get": {
        "tags": [
          "Related Vehicles"
        ],
        "summary": "Get related vehicles",
        "description": "Get related or similar auction vehicles by VIN or lot number.",
        "operationId": "getRelatedVehicles",
        "parameters": [
          {
            "name": "slugVin",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle identifier. Can be VIN or lot number.",
            "example": "WBAVL1C58FVY28848 or 78691915"
          }
        ],
        "responses": {
          "200": {
            "description": "Related auction vehicle records.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleListResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/vehicles/filters": {
      "get": {
        "tags": [
          "Filters"
        ],
        "summary": "Get vehicle filters metadata",
        "description": "Get available filters metadata for vehicle auction search.",
        "operationId": "getVehicleFilters",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Available filters metadata.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FiltersResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/vehicles/{slugVin}/shipping": {
      "get": {
        "tags": [
          "Shipping"
        ],
        "summary": "Get shipping prices for a vehicle",
        "description": "Get auction-to-port shipping prices for a vehicle by VIN or lot number.",
        "operationId": "getVehicleShipping",
        "parameters": [
          {
            "name": "slugVin",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle identifier. Can be VIN or lot number.",
            "example": "WBAVL1C58FVY28848 or 78691915"
          },
          {
            "name": "ports",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Comma-separated list of destination ports to return.",
            "example": "Chicago,NY,Miami,Savannah,Norfolk,Houston,LA,Seattle,Moto_ATV"
          }
        ],
        "responses": {
          "200": {
            "description": "Shipping prices for the selected vehicle.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/locations": {
      "get": {
        "tags": [
          "Locations"
        ],
        "summary": "List auction locations",
        "description": "Search Copart and IAAI auction locations by platform, state, facility ID, text query, ZIP, and radius.",
        "operationId": "listAuctionLocations",
        "parameters": [
          {
            "name": "platform",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "iaai",
                "copart"
              ]
            },
            "description": "Auction platform."
          },
          {
            "name": "state",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "State code.",
            "example": "FL"
          },
          {
            "name": "facility_id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Facility ID.",
            "example": "136"
          },
          {
            "name": "q",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Search by facility name, city, state code, or ZIP.",
            "example": "Birmingham"
          },
          {
            "name": "zip",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "ZIP code for location-based search.",
            "example": "33166"
          },
          {
            "name": "radius",
            "in": "query",
            "required": false,
            "schema": {
              "type": "number"
            },
            "description": "Search radius around ZIP.",
            "example": 50
          },
          {
            "name": "units",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "km",
                "mi"
              ],
              "default": "mi"
            },
            "description": "Distance units."
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20,
              "default": 20
            },
            "description": "Number of records per page. Maximum: 20.",
            "example": 20
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of auction locations.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/shipping/auction-to-port": {
      "get": {
        "tags": [
          "Shipping"
        ],
        "summary": "Get auction-to-port shipping prices",
        "description": "Get delivery prices from auction location to one or more destination ports by VIN or lot number.",
        "operationId": "getAuctionToPortShipping",
        "parameters": [
          {
            "name": "vin",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle VIN.",
            "example": "5TFLA5DBXTX349827"
          },
          {
            "name": "lot_number",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Auction lot number.",
            "example": "78691915"
          },
          {
            "name": "ports",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Comma-separated list of destination ports to return.",
            "example": "Chicago,NY,Miami,Savannah,Norfolk,Houston,LA,Seattle,Moto_ATV"
          }
        ],
        "responses": {
          "200": {
            "description": "Auction-to-port shipping prices.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/vehicles/urltodetails": {
      "get": {
        "tags": [
          "URL Tools"
        ],
        "summary": "Get vehicle details from auction URL",
        "description": "Resolve vehicle auction details from a Copart or IAAI vehicle URL.",
        "operationId": "getVehicleDetailsFromUrl",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Vehicle URL.",
            "example": "https://www.copart.com/lot/51015256/clean-title-2014-cadillac-escalade-esv-platinum-me-windham"
          }
        ],
        "responses": {
          "200": {
            "description": "Vehicle details resolved from the URL.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VehicleDetailsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request. One or more parameters are invalid."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Resource not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/usage": {
      "get": {
        "tags": [
          "Usage"
        ],
        "summary": "Get API usage",
        "description": "Retrieve current API request usage and plan limit information.",
        "operationId": "getApiUsage",
        "parameters": [],
        "responses": {
          "200": {
            "description": "API usage and plan limit information.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    },
    "/image-proxy": {
      "get": {
        "tags": [
          "Image Proxy"
        ],
        "summary": "Proxy an auction vehicle image",
        "description": "Retrieve a supported auction vehicle image through the Apibara image proxy.",
        "operationId": "proxyAuctionImage",
        "parameters": [
          {
            "name": "url",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uri"
            },
            "description": "Source image URL.",
            "example": "https://example.com/vehicle-image.webp"
          }
        ],
        "responses": {
          "200": {
            "description": "Proxied image response.",
            "content": {
              "image/jpeg": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              },
              "image/png": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              },
              "image/webp": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "400": {
            "description": "Bad request or invalid image URL."
          },
          "401": {
            "description": "Unauthorized. Missing or invalid X-API-Key."
          },
          "404": {
            "description": "Image not found."
          },
          "429": {
            "description": "API quota exceeded or rate limit reached."
          },
          "500": {
            "description": "Internal server error."
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Apibara API key."
      }
    },
    "schemas": {
      "VehicleListResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Vehicle"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/CursorMeta"
          }
        },
        "required": [
          "data",
          "meta"
        ]
      },
      "VehicleDetailsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Vehicle"
          }
        }
      },
      "VehicleHistoryResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Vehicle"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/CursorMeta"
          }
        },
        "required": [
          "data",
          "meta"
        ]
      },
      "FiltersResponse": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "data": {
            "type": "object",
            "description": "Available filter values grouped by filter name.",
            "additionalProperties": true
          }
        }
      },
      "LocationsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AuctionLocation"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/CursorMeta"
          }
        },
        "required": [
          "data",
          "meta"
        ]
      },
      "ShippingResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingPrice"
            }
          }
        }
      },
      "Vehicle": {
        "type": "object",
        "description": "Normalized Copart or IAAI auction vehicle record.",
        "properties": {
          "platform": {
            "type": "string",
            "example": "iaai"
          },
          "lot_number": {
            "type": "string",
            "example": "45416833"
          },
          "vin": {
            "type": "string",
            "example": "2HKRM4H7XEH623608"
          },
          "title": {
            "type": "string",
            "example": "2014 HONDA CR-V EX-L"
          },
          "year": {
            "type": "integer",
            "example": 2014
          },
          "make": {
            "type": "string",
            "example": "HONDA"
          },
          "model": {
            "type": "string",
            "example": "CR-V"
          },
          "type": {
            "type": "string",
            "example": "AUTOMOBILE"
          },
          "color": {
            "type": "string",
            "example": "Black"
          },
          "fuel_type": {
            "type": "string",
            "example": "Gasoline"
          },
          "transmission": {
            "type": "string",
            "example": "Automatic"
          },
          "drive_type": {
            "type": "string",
            "example": "AWD"
          },
          "odometer": {
            "type": "number",
            "example": 120000
          },
          "damage": {
            "type": "string",
            "example": "Mechanical"
          },
          "auction": {
            "$ref": "#/components/schemas/AuctionInfo"
          },
          "pricing": {
            "$ref": "#/components/schemas/PricingInfo"
          },
          "location": {
            "$ref": "#/components/schemas/VehicleLocation"
          },
          "media": {
            "$ref": "#/components/schemas/MediaInfo"
          }
        },
        "additionalProperties": true
      },
      "AuctionInfo": {
        "type": "object",
        "properties": {
          "state": {
            "type": "string",
            "example": "open"
          },
          "auction_at": {
            "type": "string",
            "format": "date-time",
            "example": "2026-06-22T13:30:00+00:00"
          },
          "lot_status": {
            "type": "string",
            "example": "Timed"
          },
          "lot_sub_status": {
            "type": "string",
            "example": "Open"
          }
        },
        "additionalProperties": true
      },
      "PricingInfo": {
        "type": "object",
        "properties": {
          "current_bid_usd": {
            "type": "number",
            "example": 25
          },
          "buy_now_usd": {
            "type": "number",
            "nullable": true
          },
          "sale_price_usd": {
            "type": "number",
            "nullable": true
          }
        },
        "additionalProperties": true
      },
      "VehicleLocation": {
        "type": "object",
        "properties": {
          "display": {
            "type": "string",
            "example": "Englishtown (NJ)"
          },
          "state": {
            "type": "string",
            "example": "NJ"
          },
          "facility_id": {
            "type": "string",
            "example": "136"
          }
        },
        "additionalProperties": true
      },
      "MediaInfo": {
        "type": "object",
        "properties": {
          "thumbs_count": {
            "type": "integer",
            "example": 17
          },
          "has_360": {
            "type": "boolean",
            "example": true
          },
          "photos": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "additionalProperties": true
      },
      "AuctionLocation": {
        "type": "object",
        "properties": {
          "platform": {
            "type": "string",
            "example": "copart"
          },
          "facility_id": {
            "type": "string",
            "example": "136"
          },
          "name": {
            "type": "string",
            "example": "Miami South"
          },
          "city": {
            "type": "string",
            "example": "Miami"
          },
          "state": {
            "type": "string",
            "example": "FL"
          },
          "zip": {
            "type": "string",
            "example": "33166"
          },
          "latitude": {
            "type": "number",
            "example": 25.7617
          },
          "longitude": {
            "type": "number",
            "example": -80.1918
          }
        },
        "additionalProperties": true
      },
      "ShippingPrice": {
        "type": "object",
        "properties": {
          "port": {
            "type": "string",
            "example": "Miami"
          },
          "price": {
            "type": "number",
            "example": 350
          },
          "currency": {
            "type": "string",
            "example": "USD"
          }
        },
        "additionalProperties": true
      },
      "CursorMeta": {
        "type": "object",
        "properties": {
          "per_page": {
            "type": "integer",
            "minimum": 1,
            "maximum": 20,
            "example": 20
          },
          "next_cursor": {
            "type": "string",
            "nullable": true,
            "example": "eyJ2ZWhpY2xlcy5hZCI6IjIwMjYtMDctMTMgMTY6MzA6MDAiLCJ2ZWhpY2xlcy51cGRhdGVkX2F0IjoiMjAyNi0wNy0xMSAwODowOToyOSIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"
          },
          "prev_cursor": {
            "type": "string",
            "nullable": true,
            "example": null
          }
        },
        "additionalProperties": true,
        "description": "Cursor pagination metadata.",
        "required": [
          "per_page",
          "next_cursor",
          "prev_cursor"
        ]
      },
      "UsageResponse": {
        "type": "object",
        "description": "API usage and plan limit response.",
        "properties": {
          "data": {
            "type": "object",
            "description": "Usage information returned for the authenticated API key.",
            "additionalProperties": true
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": true
      }
    }
  },
  "externalDocs": {
    "description": "Apibara Vehicle Auction Data API documentation",
    "url": "https://apibara.tech/en/products/vehicle-auction-data-api/docs"
  }
}