Apibara Vehicle Auction Data

{'type': 'object', 'anyOf': [{'required': ['vin']}, {'required': ['lot_number']}], 'properties': {'vin': {'type': 'string', 'description': 'Vehicle Identification Number. Provide this or lot_number.'}, 'port': {'type': 'string', 'description': 'Optional destination port name supported by the shipping endpoint.'}, 'port_id': {'type': ['integer', 'string'], 'description': 'Optional destination port identifier when known.'}, 'lot_number': {'type': 'string', 'description': 'Auction lot number. Provide this or vin.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'properties': {}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'object', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'required': ['identifier'], 'properties': {'per_page': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Maximum related records to return. Effective limits are plan-dependent.'}, 'identifier': {'type': 'string', 'minLength': 1, 'description': 'VIN, lot number or slug_vin accepted by the canonical vehicle detail endpoint.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, 'meta': {'type': 'object', 'description': 'Pagination metadata. Treat cursor values as opaque.', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'required': ['identifier'], 'properties': {'include': {'type': 'array', 'items': {'enum': ['history', 'vin_lots'], 'type': 'string'}, 'maxItems': 2, 'description': 'Optional related data to embed in the vehicle detail result.', 'uniqueItems': True}, 'identifier': {'type': 'string', 'minLength': 1, 'description': 'VIN, lot number or slug_vin accepted by the canonical vehicle detail endpoint.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'object', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'properties': {'platform': {'enum': ['copart', 'iaai'], 'type': 'string', 'description': 'Optional readable auction-source selector. Omit to retrieve combined supported filter metadata.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'object', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'required': ['identifier'], 'properties': {'identifier': {'type': 'string', 'minLength': 1, 'description': 'VIN, lot number or slug_vin accepted by the canonical vehicle detail endpoint.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, 'meta': {'type': 'object', 'description': 'Pagination metadata. Treat cursor values as opaque.', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'properties': {'s': {'type': 'string', 'description': 'Free-text location search, such as a facility name, city or supported location term.'}, 'state': {'type': 'string', 'description': 'Optional state or region filter, for example FL.'}, 'country': {'type': 'string', 'description': 'Optional country filter supported by the locations endpoint.'}, 'platform': {'enum': ['copart', 'iaai'], 'type': 'string', 'description': 'Optional source selector: Copart or IAA / IAAI.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, 'meta': {'type': 'object', 'description': 'Pagination metadata. Treat cursor values as opaque.', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}

{'type': 'object', 'properties': {'s': {'type': 'string', 'description': 'Search by VIN, lot number or vehicle title/model text.'}, 'zip': {'type': 'string', 'description': 'ZIP/postal code used with radius for supported proximity search.'}, 'make': {'type': 'string', 'description': 'Make filter for GET /vehicles.'}, 'type': {'type': 'string', 'description': 'Vehicle type filter for GET /vehicles.'}, 'color': {'type': 'string', 'description': 'Color filter for GET /vehicles.'}, 'model': {'type': 'string', 'description': 'Model filter for GET /vehicles.'}, 'units': {'enum': ['mi', 'km'], 'type': 'string', 'description': 'Distance and odometer unit system: mi or km.'}, 'cursor': {'type': 'string', 'description': 'Opaque pagination cursor returned by the API. Send next_cursor back unchanged; do not decode or synthesize it.'}, 'damage': {'enum': ['Fire', 'Hail', 'Theft', 'Water', 'Chemical', 'Rollover', 'Mechanical', 'Vandalized', 'Repossession'], 'type': 'string', 'description': 'Primary damage category filter.'}, 'radius': {'type': 'integer', 'description': 'Search radius around zip, interpreted using the selected units.'}, 'series': {'type': 'string', 'description': 'Series / model family filter for GET /vehicles.'}, 'has_key': {'enum': ['No', 'All', 'With'], 'type': 'string', 'description': 'Key-availability filter using the documented values No, All or With.'}, 'year_to': {'type': 'integer', 'description': 'Year to filter for GET /vehicles.'}, 'per_page': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Requested page size. Effective maximum is subscription-plan dependent; common public plan limits are 20, 30 or 40 and custom plans may differ.'}, 'platform': {'enum': ['copart', 'iaai'], 'type': 'string', 'description': 'Readable auction-source selector: copart or iaai. Omit for combined supported sources.'}, 'run_cond': {'enum': ['STATIONARY', 'NO INFORMATION', 'RUNS AND DRIVES', 'ENGINE START PROGRAM'], 'type': 'string', 'description': 'Normalized run-condition filter.'}, 'upcoming': {'enum': ['all', 'only', 'without'], 'type': 'string', 'description': 'Upcoming selector: all=no upcoming restriction, only=upcoming eligible lots only, without=exclude upcoming lots.'}, 'body_type': {'oneOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}], 'description': 'Deprecated compatibility alias for body_style. A string or array is accepted; prefer body_style for new integrations.'}, 'cylinders': {'type': 'integer', 'description': 'Cylinders filter for GET /vehicles.'}, 'fuel_type': {'enum': ['Diesel', 'Hybrid', 'Electric', 'Flexible', 'Gasoline', 'All others'], 'type': 'string', 'description': 'Fuel type filter for GET /vehicles.'}, 'loc_state': {'type': 'string', 'description': 'Auction location state or region, for example FL.'}, 'price_max': {'type': 'number', 'description': 'Price max filter for GET /vehicles.'}, 'price_min': {'type': 'number', 'description': 'Price min filter for GET /vehicles.'}, 'year_from': {'type': 'integer', 'description': 'Year from filter for GET /vehicles.'}, 'body_style': {'oneOf': [{'type': 'string'}, {'type': 'array', 'items': {'type': 'string'}}], 'description': 'Filter by vehicle_specs.body_style. A string or array is accepted; multiple values are OR-ed. IAAI uses VehicleClass and Copart uses the source-backed Body Style field.'}, 'drive_type': {'enum': ['AWD', 'FWD', 'RWD'], 'type': 'string', 'description': 'Drive type filter for GET /vehicles.'}, 'generation': {'type': 'string', 'description': 'Generation filter for GET /vehicles.'}, 'lot_status': {'enum': ['All', 'Timed', 'Buy Now'], 'type': 'string', 'description': 'Auction mode filter: All, Timed or Buy Now.'}, 'today_only': {'type': 'boolean', 'description': 'When true, restrict results to the endpoint current-day auction logic.'}, 'engine_type': {'enum': ['I', 'V', 'W', 'B'], 'type': 'string', 'description': 'Engine type filter for GET /vehicles.'}, 'facility_id': {'type': 'string', 'description': 'Auction facility identifier used to restrict results to one supported facility.'}, 'odometer_to': {'type': 'number', 'description': 'Odometer to filter for GET /vehicles.'}, 'office_name': {'type': 'string', 'description': 'Auction office or branch name filter.'}, 'seller_type': {'enum': ['dealer', 'finance', 'insurance', 'non_insurance'], 'type': 'string', 'description': 'Normalized seller type: dealer, finance, insurance or non_insurance.'}, 'auction_type': {'enum': [0, 1, 2], 'type': 'integer', 'description': 'Numeric compatibility source selector: 0=all, 1=Copart, 2=IAAI. If both auction_type and platform are supplied, auction_type takes precedence; prefer platform for new integrations.'}, 'transmission': {'enum': ['Manual', 'Unknown', 'Automatic'], 'type': 'string', 'description': 'Transmission filter for GET /vehicles.'}, 'generation_id': {'type': 'string', 'description': 'Generation ID filter for GET /vehicles.'}, 'include_total': {'type': 'boolean', 'description': 'Include exact total filter for GET /vehicles.'}, 'odometer_from': {'type': 'number', 'description': 'Odometer from filter for GET /vehicles.'}, 'engine_size_to': {'type': 'number', 'description': 'Engine size to filter for GET /vehicles.'}, 'lot_sub_status': {'enum': ['Open', 'Live', 'Ended'], 'type': 'string', 'description': 'Normalized auction state: Open for active/open lots, Live for currently live supported lots, Ended for closed/ended lots.'}, 'auction_date_to': {'type': 'string', 'format': 'date', 'description': 'End auction date in YYYY-MM-DD format.'}, 'engine_size_from': {'type': 'number', 'description': 'Engine size from filter for GET /vehicles.'}, 'auction_date_from': {'type': 'string', 'format': 'date', 'description': 'Start auction date in YYYY-MM-DD format.'}, 'has_shipping_price': {'type': 'boolean', 'description': 'When true, return only vehicles with supported shipping-price data.'}, 'sale_document_type': {'type': 'string', 'description': 'Sale/title document type filter; values are source-backed and can vary.'}, 'sale_document_pending': {'type': 'boolean', 'description': 'When true, restrict results to records with a pending sale document state when supported.'}, 'updated_within_minutes': {'type': 'integer', 'maximum': 525600, 'minimum': 1, 'description': 'Incremental-sync window. Return records whose updated_at changed within this many minutes; supported range is 1..525600. Use with cursor pagination and an overlap window.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'data': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}}, 'meta': {'type': 'object', 'description': 'Pagination metadata. Treat cursor values as opaque.', 'additionalProperties': True}}, 'description': 'Structured JSON returned by the canonical Apibara Vehicle Auction Data API. Source-dependent fields may be null or absent.', 'additionalProperties': True}