openapi: 3.0.0
servers:
  - url: https://marketcheck-prod.apigee.net/v2
info:
  description: One API serving data spanned across multiple verticals
  title: Marketcheck APIs
  version: "2.01"
  x-apisguru-categories:
    - ecommerce
  x-logo:
    url: https://twitter.com/MarketcheckAPIs/profile_image?size=original
  x-origin:
    - format: openapi
      url: https://new-verticals-dot-marketcheck-gcp.uc.r.appspot.com/api-docs
      version: "3.0"
  x-providerName: apigee.net
  x-serviceName: marketcheck-cars
security:
  - authorizeEndpoint: []
paths:
  /car/dealer/inventory/active:
    get:
      description: Get dealers active inventory
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/car_vins"
        - $ref: "#/components/parameters/car_taxonomy_vins"
        - $ref: "#/components/parameters/mm"
        - $ref: "#/components/parameters/ymm"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/dealer_name"
        - $ref: "#/components/parameters/dealership_group_name"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/include_relevant_links"
        - $ref: "#/components/parameters/inventory_count_range"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/powertrain_type"
        - $ref: "#/components/parameters/min_photo_links"
        - $ref: "#/components/parameters/min_photo_links_cached"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: List of all cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Get dealers active inventory
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/car/recall/{vin}":
    get:
      description: Get a particular recall information for a vin
      operationId: getRecallHistory
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/inpath_full_vin"
        - description: Page number to fetch the results for the given criteria. Default is 1.
          in: query
          name: page
          required: false
          schema:
            format: number
            type: number
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: Reacll info for the given vin
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Recall info by vin
      tags:
        - Recall Search
    x-swagger-router-controller: history
  /client/configure/get:
    get:
      description: get client filters
      operationId: get
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: To filter listing on Country in which they are listed
          in: query
          name: country
          required: true
          schema:
            enum:
              - US
              - CA
              - UK
            type: string
      responses:
        "200":
          content:
            text/csv:
              examples:
                response:
                  value: |-
                    rule_type,field,value,factor
                    exclude,source,arnoldclark.com,
          description: Successfully get client filters
      summary: get client filters
      tags:
        - client filters
    x-swagger-router-controller: client_filters
  /client/configure/set:
    post:
      description: set client filters
      operationId: set
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: To filter listing on Country in which they are listed
          in: query
          name: country
          required: true
          schema:
            enum:
              - US
              - CA
              - UK
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                csvfile:
                  description: csv file with filters
                  format: binary
                  type: string
                  x-mimetype: text/csv
              required:
                - csvfile
              type: object
        required: true
      responses:
        "200":
          description: Successfully set client filters
      summary: set client filters
      tags:
        - client filters
    x-swagger-router-controller: client_filters
  "/crm_check/car/{vin}":
    get:
      description: Check whether particular vin has had a listing after stipulated date or not
      operationId: crmCheck
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/inpath_full_vin"
        - description: sale date to check whether after this listing has appeared or not. Must be 8 character long, with YYYYMMDD format
          in: query
          name: sale_date
          required: true
          schema:
            format: string
            minLength: 8
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CRMResponse"
          description: CRM check for given vin
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: CRM check of a particular vin
      tags:
        - CRM Cleanse API
      x-swagger-router-controller: history
  "/dealer/car/uk/{id}":
    get:
      description: Get a particular dealer's information by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Dealer id to get all the dealer info attributes
          in: path
          name: id
          required: true
          schema:
            format: string
            type: string
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Dealer"
          description: Dealer for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Dealer by id
      tags:
        - Dealer API
      x-swagger-router-controller: search
  "/dealer/car/{id}":
    get:
      description: Get a particular dealer's information by its id
      operationId: getDealer
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Dealer id to get all the dealer info attributes
          in: path
          name: id
          required: true
          schema:
            format: string
            type: string
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Dealer"
          description: Dealer for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Dealer by id
      tags:
        - Dealer API
      x-swagger-router-controller: search
  "/dealer/heavy-equipment/{id}":
    get:
      description: Get a particular dealer's information by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Dealer id to get all the dealer info attributes
          in: path
          name: id
          required: true
          schema:
            format: string
            type: string
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Dealer"
          description: Dealer for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Dealer by id
      tags:
        - Dealer API
      x-swagger-router-controller: search
  "/dealer/motorcycle/{id}":
    get:
      description: Get a particular dealer's information by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Dealer id to get all the dealer info attributes
          in: path
          name: id
          required: true
          schema:
            format: string
            type: string
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Dealer"
          description: Dealer for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Dealer by id
      tags:
        - Dealer API
      x-swagger-router-controller: search
  "/dealer/rv/{id}":
    get:
      description: Get a particular dealer's information by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Dealer id to get all the dealer info attributes
          in: path
          name: id
          required: true
          schema:
            format: string
            type: string
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Dealer"
          description: Dealer for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Dealer by id
      tags:
        - Dealer API
      x-swagger-router-controller: search
  /dealers/car:
    get:
      description: The dealers API returns a list of dealers around a given point and radius.
      operationId: dealerSearch
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/non_default_country"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/listing_count_range"
        - $ref: "#/components/parameters/inventory_url"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DealersResponse"
          description: List of dealers for the search
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Find car dealers around
      tags:
        - Dealer API
    x-swagger-router-controller: search
  /dealers/car/uk:
    get:
      description: The dealers API returns a list of dealers around a given point and radius.
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/non_default_country"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/city"
        - description: To filter listing on county in which they are listed
          in: query
          name: county
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: state
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/listing_count_range"
        - $ref: "#/components/parameters/inventory_url"
        - description: To filter listing on postal code around which they are listed
          in: query
          name: postal_code
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DealersResponse"
          description: List of dealers for the search
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Find car dealers around
      tags:
        - Dealer API
    x-swagger-router-controller: search
  /dealers/heavy-equipment:
    get:
      description: The dealers API returns a list of dealers around a given point and radius.
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/non_default_country"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/listing_count_range"
        - $ref: "#/components/parameters/inventory_url"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DealersResponse"
          description: List of dealers for the search
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Find car dealers around
      tags:
        - Dealer API
    x-swagger-router-controller: search
  /dealers/motorcycle:
    get:
      description: The dealers API returns a list of dealers around a given point and radius.
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/non_default_country"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/listing_count_range"
        - $ref: "#/components/parameters/inventory_url"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DealersResponse"
          description: List of dealers for the search
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Find car dealers around
      tags:
        - Dealer API
    x-swagger-router-controller: search
  /dealers/rv:
    get:
      description: The dealers API returns a list of dealers around a given point and radius.
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/non_default_country"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/listing_count_range"
        - $ref: "#/components/parameters/inventory_url"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DealersResponse"
          description: List of dealers for the search
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Find car dealers around
      tags:
        - Dealer API
    x-swagger-router-controller: search
  "/decode/car/epi/{vin}/specs":
    get:
      description: Get the basic information on specifications for a car identified by a valid VIN from EPI's decoder
      operationId: decodeViaEPI
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/inpath_full_vin"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Build"
          description: Basic sepcifications details about the car
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: EPI VIN Decoder
      tags:
        - VIN Decoder API
      x-swagger-router-controller: vin_decoder
  "/decode/car/neovin/{vin}/specs":
    get:
      description: Get the basic information on specifications for a car identified by a valid VIN from NeoVIN decoder
      operationId: decodeViaNeoVIN
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/inpath_full_vin"
        - description: Boolean variable to indicate wheather to include generic data as well in response
          in: query
          name: include_generic
          required: false
          schema:
            default: false
            type: boolean
        - description: Decode VIN on the fly instead of cached response
          in: query
          name: force_decode
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NeoVIN"
          description: Basic sepcifications details about the car
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: NeoVIN Decoder
      tags:
        - VIN Decoder API
      x-swagger-router-controller: vin_decoder
  "/decode/car/{vin}/specs":
    get:
      description: Get the basic information on specifications for a car identified by a valid VIN
      operationId: decode
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: The VIN to identify the car. Must be a valid 17 char VIN
          in: path
          name: vin
          required: true
          schema:
            format: string
            minLength: 17
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Build"
          description: Basic sepcifications details about the car
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: VIN Decoder
      tags:
        - VIN Decoder API
      x-swagger-router-controller: vin_decoder
  "/history/car/uk/{vrm}":
    get:
      description: The history API returns online listing history for a car identified by its VRM. History listings are sorted in the descending order of the listing date / last seen date
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/inpath_vrm"
        - description: Page number to fetch the results for the given criteria. Default is 1.
          in: query
          name: page
          required: false
          schema:
            format: number
            type: number
        - description: Flag to indicate whether to include duplicate historical records as well in the response
          in: query
          name: include_duplicates
          required: false
          schema:
            type: boolean
        - $ref: "#/components/parameters/sort_order"
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: "#/components/schemas/HistoricalListing"
                type: array
          description: Online listing history for the given vrm
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Get a cars online listing history
      tags:
        - Cars History API
    x-swagger-router-controller: history
  "/history/car/{vin}":
    get:
      description: The history API returns online listing history for a car identified by its VIN. History listings are sorted in the descending order of the listing date / last seen date
      operationId: getCarHistory
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/inpath_full_vin"
        - description: List of fields to fetch, in case the default fields list in the response is to be trimmed down
          in: query
          name: fields
          required: false
          schema:
            format: string
            type: string
        - description: Page number to fetch the results for the given criteria. Default is 1.
          in: query
          name: page
          required: false
          schema:
            format: number
            type: number
        - description: Flag to indicate whether to include duplicate historical records as well in the response
          in: query
          name: include_duplicates
          required: false
          schema:
            type: boolean
        - $ref: "#/components/parameters/sort_order"
      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: "#/components/schemas/HistoricalListing"
                type: array
          description: Online listing history for the given vin
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Get a cars online listing history
      tags:
        - Cars History API
    x-swagger-router-controller: history
  "/image/cache/car/{listingID}/{imageID}":
    get:
      description: Fetch the cached car image
      operationId: getCachedImage
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: ID of the listing to fetch cached images for
          in: path
          name: listingID
          required: true
          schema:
            type: string
        - description: ID of the image to fetch
          in: path
          name: imageID
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CacheImageResponse"
          description: Cached image of the car
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Fetch cached image
      tags:
        - Car Cached Image
    x-swagger-router-controller: search
  "/listing/car/auction/{id}":
    get:
      description: Get a particular auction listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
        - $ref: "#/components/parameters/include_relevant_links"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Listing"
          description: Listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/auction/{id}/extra":
    get:
      description: Get listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text Listings attributes for Listing with the given id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/auction/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: ListingMedia for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/fsbo/{id}":
    get:
      description: Get a particular private party listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
        - $ref: "#/components/parameters/include_relevant_links"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Listing"
          description: Listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/fsbo/{id}/extra":
    get:
      description: Get listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text Listings attributes for Listing with the given id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/fsbo/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: ListingMedia for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/uk/{id}":
    get:
      description: Get a particular dealer listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Listing"
          description: Listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/uk/{id}/extra":
    get:
      description: Get listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text Listings attributes for Listing with the given id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/uk/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: ListingMedia for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/{id}":
    get:
      description: Get a particular dealer listing by its id
      operationId: getListing
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
        - $ref: "#/components/parameters/include_relevant_links"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Listing"
          description: Listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/{id}/extra":
    get:
      description: Get listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text Listings attributes for Listing with the given id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/car/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: ListingMedia for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - Car Search
    x-swagger-router-controller: search
  "/listing/heavy-equipment/{id}":
    get:
      description: Get a particular Heavy equipment listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HeavyEquipmentsListing"
          description: Heavy equipment listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Heavy equipment listing by id
      tags:
        - Heavy Equipment Search
    x-swagger-router-controller: search
  "/listing/heavy-equipment/{id}/extra":
    get:
      description: Get Heavy equipment listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: Heavy equipment ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text Heavy equipment Listings attributes for Listing with the given id
      tags:
        - Heavy Equipment Search
    x-swagger-router-controller: search
  "/listing/heavy-equipment/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: Listing Media for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - Heavy Equipment Search
    x-swagger-router-controller: search
  "/listing/motorcycle/{id}":
    get:
      description: Get a particular Motorcycle listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MotorcycleListing"
          description: Motorcycle listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Motorcycle listing by id
      tags:
        - Motorcycle Search
    x-swagger-router-controller: search
  "/listing/motorcycle/{id}/extra":
    get:
      description: Get Motorcycle listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: Motorcycle ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text Motorcycle Listings attributes for Listing with the given id
      tags:
        - Motorcycle Search
    x-swagger-router-controller: search
  "/listing/motorcycle/{id}/media":
    get:
      description: Get Motorcycle listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: Motorcycle listing media for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Motorcycle listing media by id
      tags:
        - Motorcycle Search
    x-swagger-router-controller: search
  "/listing/rv/uk/{id}":
    get:
      description: Get a particular RV listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RVListing"
          description: RV listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: RV listing by id
      tags:
        - RV Search
    x-swagger-router-controller: search
  "/listing/rv/uk/{id}/extra":
    get:
      description: Get RV listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: RV ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text RV Listings attributes for Listing with the given id
      tags:
        - RV Search
    x-swagger-router-controller: search
  "/listing/rv/uk/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: Listing Media for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - RV Search
    x-swagger-router-controller: search
  "/listing/rv/{id}":
    get:
      description: Get a particular RV listing by its id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RVListing"
          description: RV listing for the given id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: RV listing by id
      tags:
        - RV Search
    x-swagger-router-controller: search
  "/listing/rv/{id}/extra":
    get:
      description: Get RV listing options, features, seller comments
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingExtraAttributes"
          description: RV ListingAttributes for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Long text RV Listings attributes for Listing with the given id
      tags:
        - RV Search
    x-swagger-router-controller: search
  "/listing/rv/{id}/media":
    get:
      description: Get listing media (photo, photos) by id
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListingMedia"
          description: Listing Media for the given listing id
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Listing media by id
      tags:
        - RV Search
    x-swagger-router-controller: search
  /mds/car:
    get:
      description: Get the basic information on specifications for a car identified by a valid VIN
      operationId: getMDS
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: VIN to decode
          in: query
          name: vin
          required: false
          schema:
            format: string
            minLength: 10
            type: string
        - description: Exact parameter
          in: query
          name: exact
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - description: Radius around the search location (Unit - Miles)
          in: query
          name: radius
          schema:
            format: int32
            type: integer
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/msa_code"
        - description: Debug parameter
          in: query
          name: debug
          required: false
          schema:
            default: false
            type: boolean
        - description: To fetch sold vins
          in: query
          name: include_sold
          required: false
          schema:
            default: false
            type: boolean
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/dealership_group_name"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/engine_size_range"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Mds"
          description: Provides Market Days supply for year make model or trim combination
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Market Days Supply
      tags:
        - Cars Market API
      x-swagger-router-controller: mds
  /popular/cars:
    get:
      description: Get make model wise top 50 popular cars on national, state, city level
      operationId: getPopularCars
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: State level sales count
          in: query
          name: state
          required: false
          schema:
            format: string
            type: string
        - description: City level sales count, pipe seperated like city_state=jacksonville|FL
          in: query
          name: city_state
          required: false
          schema:
            format: string
            type: string
        - description: Inventory type for which popular count is to be searched
          in: query
          name: car_type
          required: true
          schema:
            enum:
              - new
              - used
            format: string
            type: string
        - description: Country for which the popular cars are to be searched
          in: query
          name: country
          required: false
          schema:
            default: us
            enum:
              - us
              - ca
              - US
              - CA
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PopularCars"
          description: List of most popular top 50 cars
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Get make model wise top 50 popular cars on national, state, city level
      tags:
        - Cars Market API
      x-swagger-router-controller: market
  /predict/car/price:
    get:
      description: Predict car price based on it's specifications
      operationId: predictCarPrice
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Predict price for a VIN
          in: query
          name: vin
          schema:
            type: string
        - description: Car condition
          in: query
          name: car_type
          required: true
          schema:
            enum:
              - used
              - new
            type: string
        - description: Car manufacturing year
          in: query
          name: year
          schema:
            type: integer
        - description: Car's make
          in: query
          name: make
          schema:
            type: string
        - description: Car's model
          in: query
          name: model
          schema:
            type: string
        - description: Car's trim
          in: query
          name: trim
          schema:
            type: string
        - description: Boolean to indicate car is certified or not
          in: query
          name: is_certified
          required: false
          schema:
            type: boolean
        - description: Boolean to indicate car is carfax one owner or not
          in: query
          name: carfax_1_owner
          required: false
          schema:
            type: boolean
        - description: Boolean to indicate car has clean title or not
          in: query
          name: carfax_clean_title
          required: false
          schema:
            type: boolean
        - description: Base exterior color of the car
          in: query
          name: base_exterior_color
          required: false
          schema:
            type: string
        - description: Base interior color of the car
          in: query
          name: base_interior_color
          required: false
          schema:
            type: string
        - description: Transmission on the car
          in: query
          name: transmission
          schema:
            enum:
              - Manual
              - Automatic
            type: string
        - description: Drivetrain on the car
          in: query
          name: drivetrain
          schema:
            enum:
              - 4WD
              - AWD
              - FWD
              - RWD
            type: string
        - description: Engine Size of the car
          in: query
          name: engine_size
          required: false
          schema:
            type: number
        - description: Engine Block of the car
          in: query
          name: engine_block
          required: false
          schema:
            enum:
              - I
              - V
              - H
            type: string
        - description: Number of cylinders in the vehicle
          in: query
          name: cylinders
          schema:
            type: integer
        - description: Number of doors in the vehicle
          in: query
          name: doors
          schema:
            type: integer
        - description: Highway mileage
          in: query
          name: highway_mpg
          schema:
            type: integer
        - description: City mileage of the car
          in: query
          name: city_mpg
          schema:
            type: integer
        - description: Latitude component of the location
          in: query
          name: latitude
          schema:
            type: number
        - description: Longitude component of the location
          in: query
          name: longitude
          schema:
            type: number
        - description: miles vehicle has driven in total
          in: query
          name: miles
          schema:
            type: integer
        - description: Location zip
          in: query
          name: zip
          schema:
            type: string
        - description: Country for which car price will be predicted
          in: query
          name: country
          schema:
            default: us
            enum:
              - us
              - ca
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PricePrediction"
          description: Predicted price of the car along with it's specifications
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Predict car price based on it's specifications
      tags:
        - Cars Market API
    x-swagger-router-controller: market
  /predict/car/uk/fmv:
    get:
      description: Predict fare value of car for UK based on YMMT & miles
      operationId: fareValue
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Predict price for a VRM
          in: query
          name: vrm
          schema:
            type: string
        - description: Car manufacturing year
          in: query
          name: year
          schema:
            type: integer
        - description: Car's make
          in: query
          name: make
          schema:
            type: string
        - description: Car's model
          in: query
          name: model
          schema:
            type: string
        - description: Car's variant
          in: query
          name: variant
          schema:
            type: string
        - description: miles vehicle has driven in total
          in: query
          name: miles
          schema:
            type: integer
        - description: Postal code of the car
          in: query
          name: postal_code
          schema:
            type: string
        - description: Radius around the search location (Unit - Miles)
          in: query
          name: radius
          schema:
            format: int32
            maximum: 100
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FareValue"
          description: Predict fare value of car for UK based on YMMT & miles
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Predict fare value of car for UK based on YMMT & miles
      tags:
        - Cars Market API
    x-swagger-router-controller: market
  /predict/car/uk/price:
    get:
      description: Predict car price for UK based on it's specifications
      operationId: predictUkCarPrice
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Predict price for a VRM
          in: query
          name: vrm
          schema:
            type: string
        - description: Car manufacturing year
          in: query
          name: year
          schema:
            type: integer
        - description: Car's make
          in: query
          name: make
          schema:
            type: string
        - description: Car's model
          in: query
          name: model
          schema:
            type: string
        - description: Car's trim
          in: query
          name: trim
          schema:
            type: string
        - description: Base exterior color of the car
          in: query
          name: base_exterior_color
          required: false
          schema:
            type: string
        - description: Transmission on the car
          in: query
          name: transmission
          schema:
            enum:
              - Manual
              - Automatic
            type: string
        - description: Drivetrain on the car
          in: query
          name: drivetrain
          schema:
            type: string
        - description: Engine Size of the car
          in: query
          name: engine_size
          required: false
          schema:
            format: double
            type: number
        - description: Number of cylinders in the vehicle
          in: query
          name: cylinders
          schema:
            type: integer
        - description: Number of doors in the vehicle
          in: query
          name: doors
          schema:
            type: integer
        - description: Fuel type of the car
          in: query
          name: fuel_type
          schema:
            type: string
        - description: Highway mileage
          in: query
          name: highway_mpg
          schema:
            format: double
            type: number
        - description: City mileage of the car
          in: query
          name: city_mpg
          schema:
            format: double
            type: number
        - description: Combiined mileage of the car
          in: query
          name: combined_mpg
          schema:
            format: double
            type: number
        - description: Latitude component of the location
          in: query
          name: latitude
          schema:
            type: number
        - description: Longitude component of the location
          in: query
          name: longitude
          schema:
            type: number
        - description: miles vehicle has driven in total
          in: query
          name: miles
          schema:
            type: integer
        - description: Location zip
          in: query
          name: zip
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PricePrediction"
          description: Predicted price of the car along with it's specifications
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Predict car price for UK based on it's specifications
      tags:
        - Cars Market API
    x-swagger-router-controller: market
  /sales/car:
    get:
      description: Get a sales count for city, state or national level by make, model, year, trim or taxonomy vin
      operationId: getSalesCount
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Inventory type for which sales count is to be searched, default is used
          in: query
          name: car_type
          required: false
          schema:
            default: used
            enum:
              - new
              - used
            format: string
            type: string
        - description: Make for which sales count is to be searched
          in: query
          name: make
          required: false
          schema:
            format: string
            type: string
        - description: Make-Model for which sales count is to be searched, pipe seperated like mm=ford|f-150
          in: query
          name: mm
          required: false
          schema:
            format: string
            type: string
        - description: Year-Make-Model for which sales count is to be searched, pipe seperated like ymm=2015|ford|f-150
          in: query
          name: ymm
          required: false
          schema:
            format: string
            type: string
        - description: Year-Make-Model-Trim for which sales count is to be searched, pipe seperated like ymmt=2015|ford|f-150|platinum
          in: query
          name: ymmt
          required: false
          schema:
            format: string
            type: string
        - description: taxonomy_vin for which sales count is to be searched
          in: query
          name: taxonomy_vin
          required: false
          schema:
            format: string
            type: string
        - description: State level sales count
          in: query
          name: state
          required: false
          schema:
            format: string
            type: string
        - description: City level sales count, pipe seperated like city_state=jacksonville|FL
          in: query
          name: city_state
          required: false
          schema:
            format: string
            type: string
        - description: VIN that will be transformed to taxonomy_vin
          in: query
          name: vin
          required: false
          schema:
            format: string
            type: string
        - description: Country for which the sales records are to be searched
          in: query
          name: country
          required: false
          schema:
            default: us
            enum:
              - us
              - ca
              - US
              - CA
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Sales"
          description: Sales count for given parameters
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Get sales count by make, model, year, trim or taxonomy vin
      tags:
        - Cars Market API
      x-swagger-router-controller: market
  /search/car/active:
    get:
      description: |-
        This endpoint is the meat of the API and serves many purposes. This API produces a list of currently active cars from the market for the given search criteria. The API results are limited to allow pagination upto 10000 rows. 
         The search API facilitates the following use cases - 
        1. Search Cars around a given geo-point within a given radius 
        2. Search cars for a specific year / make / model or combination of these 
        3. Search cars matching multiple year, make, model combinatins in the same search request
        4. Filter results by most car specification attributes
        5. Search for similar cars by VIN or Taxonomy VIN 
        6. Filter cars within a given price / miles / days on market (dom) range
        7. Specify a sort order for the results on price / miles / dom / listed date 
        8. Search cars for a given City / State combination 
        9. Get Facets to build the search drill downs 
        10. Get Market averages for price/miles/dom for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/car_vins"
        - $ref: "#/components/parameters/car_taxonomy_vins"
        - $ref: "#/components/parameters/mm"
        - $ref: "#/components/parameters/ymm"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/car_source"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/include_relevant_links"
        - $ref: "#/components/parameters/inventory_count_range"
        - $ref: "#/components/parameters/car_dealer_id"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/powertrain_type"
        - $ref: "#/components/parameters/price_change"
        - $ref: "#/components/parameters/price_change_range"
        - $ref: "#/components/parameters/active_inventory_date_range"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/high_value_features"
        - $ref: "#/components/parameters/min_photo_links"
        - $ref: "#/components/parameters/min_photo_links_cached"
        - $ref: "#/components/parameters/client_filters"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: List of all cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active car listings for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/car/active/rank:
    post:
      description: Computer rank for car listings based on inputs provided.Weights for ranking parameters can also be provided.
      operationId: searchAndRankCar
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/car_vins"
        - $ref: "#/components/parameters/car_taxonomy_vins"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/rank_miles_range"
        - $ref: "#/components/parameters/rank_price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/inventory_type"
        - description: Page number to fetch the results for the given criteria. Default is 1.
          in: query
          name: page
          required: false
          schema:
            format: number
            type: number
      requestBody:
        $ref: "#/components/requestBodies/CarRankRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CarRankResponse"
          description: Rank listings based on inputs provided.
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Compute relative rank for car listings.
      tags:
        - Rank Car Listings
    x-swagger-router-controller: search
  /search/car/active/rank/listings:
    post:
      description: Computer rank for car listings based on inputs provided.Weights for ranking parameters can also be provided.
      operationId: rankCar
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
      requestBody:
        $ref: "#/components/requestBodies/CarRankRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CarRankResponse"
          description: Rank listings based on inputs provided.
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Compute relative rank for car listings.
      tags:
        - Rank Car Listings
    x-swagger-router-controller: search
  /search/car/auction/active:
    get:
      description: |-
        This API produces a list of currently active auction cars from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows. 
         The search API facilitates the following use cases - 
        1. Search Cars around a given geo-point within a given radius 
        2. Search cars for a specific year / make / model or combination of these 
        3. Search cars matching multiple year, make, model combinatins in the same search request
        4. Filter results by most car specification attributes
        5. Search for similar cars by VIN or Taxonomy VIN 
        6. Filter cars within a given price / miles / days on market (dom) range
        7. Specify a sort order for the results on price / miles / dom / listed date 
        8. Search cars for a given City / State combination 
        9. Get Facets to build the search drill downs 
        10. Get Market averages for price/miles/dom for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/car_vins"
        - $ref: "#/components/parameters/car_taxonomy_vins"
        - $ref: "#/components/parameters/mm"
        - $ref: "#/components/parameters/ymm"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/car_source"
        - $ref: "#/components/parameters/car_dealer_id"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/include_relevant_links"
        - $ref: "#/components/parameters/inventory_count_range"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/in_transit"
        - description: To filter on title type
          in: query
          name: title_type
          required: false
          schema:
            enum:
              - clean
              - salvage
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: title_type_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/min_photo_links"
        - $ref: "#/components/parameters/min_photo_links_cached"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: List of all auction cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active auction car listings for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/car/auto-complete:
    get:
      description: Auto-complete the inputs of your end users
      operationId: autoComplete
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Field name for which you want auto-completion
          in: query
          name: field
          required: true
          schema:
            enum:
              - ymm
              - mm
              - make
              - model
              - trim
              - body_type
              - body_subtype
              - vehicle_type
              - transmission
              - drivetrain
              - fuel_type
              - exterior_color
              - interior_color
              - engine
              - engine_size
              - engine_block
              - state
              - city
            format: string
            type: string
        - description: Input entered so far
          in: query
          name: input
          required: true
          schema:
            format: string
            type: string
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/car_source"
        - $ref: "#/components/parameters/car_dealer_id"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/car_type"
        - description: Flag to indicate whether to include non vin listing terms in results or not. Default is false to avoid un-normalised terms from non vin listings out of results
          in: query
          name: include_non_vin_listings
          required: false
          schema:
            default: "false"
            enum:
              - "true"
              - "false"
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: is_non_vin_listing_is
            transformConstraints:
              - transformer: boolToFlag
                type: string
        - description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          schema:
            default: true
            type: boolean
        - description: Boolean variable to indicate wheather to include term counts as well in response
          in: query
          name: term_counts
          required: false
          schema:
            default: false
            type: boolean
        - description: Sort the response, either by index or count(default)
          in: query
          name: sort_by
          required: false
          schema:
            default: index
            enum:
              - index
              - count
            type: string
        - description: seller type for autocomplete
          in: query
          name: seller_type
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: seller_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/inventory_count_range"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/facet_min_count"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchAutoCompleteResponse"
          description: Unique terms available in given field for auto completion
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: API for auto-completion of inputs
      tags:
        - Car Search
      x-swagger-router-controller: search
  /search/car/fsbo/active:
    get:
      description: |-
        This API produces a list of currently active FSBO cars from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows. 
         The search API facilitates the following use cases - 
        1. Search Cars around a given geo-point within a given radius 
        2. Search cars for a specific year / make / model or combination of these 
        3. Search cars matching multiple year, make, model combinatins in the same search request
        4. Filter results by most car specification attributes
        5. Search for similar cars by VIN or Taxonomy VIN 
        6. Filter cars within a given price / miles / days on market (dom) range
        7. Specify a sort order for the results on price / miles / dom / listed date 
        8. Search cars for a given City / State combination 
        9. Get Facets to build the search drill downs 
        10. Get Market averages for price/miles/dom for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/car_vins"
        - $ref: "#/components/parameters/car_taxonomy_vins"
        - $ref: "#/components/parameters/mm"
        - $ref: "#/components/parameters/ymm"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/car_source"
        - $ref: "#/components/parameters/car_dealer_id"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/include_relevant_links"
        - $ref: "#/components/parameters/inventory_count_range"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/exclude_dealer_listings"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/min_photo_links"
        - $ref: "#/components/parameters/min_photo_links_cached"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: List of all FSBO cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active private party car listings for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/car/incentive/oem:
    get:
      description: |-
        This endpoint is the meat of the API and serves many purposes. This API produces a list of currently active oem incentive from the market for the given search criteria. The API results are limited to allow pagination upto 10000 rows. 
         The search API facilitates the following use cases - 
        1. Search Cars around a given geo-point within a given radius 
        2. Search cars for a specific year / make / model or combination of these 
        3. Search cars matching multiple year, make, model combinatins in the same search request
        4. Filter results by most car specification attributes
        5. Search for similar cars by VIN or Taxonomy VIN 
        6. Filter cars within a given price / miles / days on market (dom) range
        7. Specify a sort order for the results on price / miles / dom / listed date 
        8. Search cars for a given City / State combination 
        9. Get Facets to build the search drill downs 
        10. Get Market averages for price/miles/dom for your search
      operationId: oemSearch
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: The type of the incentive
          in: query
          name: offer_type
          required: false
          schema:
            enum:
              - lease
              - finance
              - cash
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: offer_type
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - description: MSRP range to filter listings with the msrp in the range given. Range to be given in the format - min-max e.g. 1000-5000
          in: query
          name: msrp
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 1000000
                defaultMin: 500
                transformer: parseInt
                type: integer
        - description: APR range to filter listings with the msrp in the range given. Range to be given in the format - min-max e.g. 1000-5000
          in: query
          name: apr
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: apr
            transformConstraints:
              - defaultMax: 20
                defaultMin: 0
                transformer: parseFloat
                type: integer
        - description: To filter listing on Monthly payment amount, usually populated in Lease offers
          in: query
          name: monthly
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: monthly
            transformConstraints:
              - defaultMax: 500
                defaultMin: 100
                transformer: parseInt
                type: integer
        - description: To filter listing on monthly amount to be paid by customer for every $1000 financed at the advertised APR rate
          in: query
          name: monthly_per_thousand
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: monthly_per_thousand
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - description: To filter listing on down payment offer on car
          in: query
          name: down_payment
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: down_payment
            transformConstraints:
              - defaultMax: 2000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on total amount due at signing, that usually includes first month payment, down payment, acquisition fee etc
          in: query
          name: due_at_signing
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: due_at_signing
            transformConstraints:
              - defaultMax: 2000
                defaultMin: 500
                transformer: parseInt
                type: integer
        - description: To filter listing on security deposit required for the offer
          in: query
          name: security_deposit
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: "-"
            targetAlias: security_deposit
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on disposition fee of the car
          in: query
          name: disposition_fee
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: disposition_fee
            transformConstraints:
              - defaultMax: 500
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on acquisition fee of the car
          in: query
          name: acquisition_fee
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: acquisition_fee
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on offer duration in months
          in: query
          name: duration
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: duration
            transformConstraints:
              - defaultMax: 100
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on any contribution from dealer's side
          in: query
          name: dealer_contribution
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: dealer_contribution
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Mileage Charge Range range to filter listings with the msrp in the range given. Range to be given in the format - min-max e.g. 100-1000
          in: query
          name: mileage_charge
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: mileage_charge
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseFloat
                type: integer
        - description: To filter listing on mileage charge limit the offer is valid up to under the default clauses
          in: query
          name: mileage_charge_limit
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: mileage_charge_limit
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on cashback amounts listed in offer
          in: query
          name: cashback_amount
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: cashback_amount
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on the demographic or any other entity for whom this cashback offer is for. Not all target groups are identified but the most common ones are tagged like Military, Grad students Current owners etc
          in: query
          name: cashback_target_group
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: cashback_target_group
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on amount at the lease end to pay for buying the car
          in: query
          name: lease_end_purchase_option
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: lease_end_purchase_option
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on net capitalised cost of the car
          in: query
          name: net_capitalised_cost
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: net_capitalised_cost
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: To filter listing on gross capitalised cost of the car
          in: query
          name: gross_capitalised_cost
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: gross_capitalised_cost
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on gross capitalised cost of the car
          in: query
          name: total_monthly_payment
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: "-"
            targetAlias: total_monthly_payment
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/search_text"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: List of all oem incentive listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets oem incentive listings for the given search criteria
      tags:
        - OEM Incentive Search
    x-swagger-router-controller: search
  /search/car/recents:
    get:
      description: This API produces a list of recently active (past 90 days) cars from the market for the given search criteria
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - description: Radius around the search location (Unit - Miles)
          in: query
          name: radius
          schema:
            format: int32
            maximum: 100
            minimum: 0
            type: integer
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/car_vins"
        - $ref: "#/components/parameters/car_taxonomy_vins"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/highway_mpg_range"
        - $ref: "#/components/parameters/city_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/dealer_name"
        - $ref: "#/components/parameters/dealership_group_name"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - description: sold parameter to fetch only sold listings
          in: query
          name: sold
          required: false
          schema:
            type: boolean
        - $ref: "#/components/parameters/include_relevant_links"
        - $ref: "#/components/parameters/expired"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/active_inventory_date_range"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/price_change_range"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchResponse"
          description: List of all cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets Recent car listings for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/car/uk/active:
    get:
      description: Search cars for sale in UK
      operationId: search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/uk_append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/postal_code"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_type"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/variant"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_uk_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/county"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - description: CO2 emissions
          in: query
          name: co2_emissions
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: co2_emissions
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/insurance_group"
        - description: Vehicle Registration Mark
          in: query
          name: vehicle_registration_mark
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: vehicle_registration_mark
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Vehicle registration date range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623
          in: query
          name: vehicle_registration_date_range
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: "-"
            targetAlias: vehicle_registration_date_range
            transformConstraints:
              - transformer: parseDate
                type: date
        - $ref: "#/components/parameters/num_owners"
        - $ref: "#/components/parameters/inventory_count_range"
        - $ref: "#/components/parameters/car_source"
        - $ref: "#/components/parameters/car_dealer_id"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/write_off_category"
        - $ref: "#/components/parameters/exclude_write_off_category"
        - $ref: "#/components/parameters/fca_status"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/vrm"
        - $ref: "#/components/parameters/powertrain_type"
        - $ref: "#/components/parameters/client_filters"
        - $ref: "#/components/parameters/boost"
        - $ref: "#/components/parameters/car_location_seller_name"
        - $ref: "#/components/parameters/car_location_street"
        - $ref: "#/components/parameters/car_location_city"
        - $ref: "#/components/parameters/car_location_county"
        - $ref: "#/components/parameters/car_location_zip"
        - $ref: "#/components/parameters/car_location_latitude"
        - $ref: "#/components/parameters/car_location_longitude"
        - $ref: "#/components/parameters/price_change"
        - $ref: "#/components/parameters/price_change_range"
        - $ref: "#/components/parameters/active_inventory_date_range"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/uvc_id"
        - $ref: "#/components/parameters/uk_highway_mpg_range"
        - $ref: "#/components/parameters/uk_city_mpg_range"
        - $ref: "#/components/parameters/uk_combined_mpg_range"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/min_photo_links"
        - $ref: "#/components/parameters/min_photo_links_cached"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/ulez_compliant"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UKSearchResponse"
          description: List of all cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active car listings in UK for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/car/uk/recents:
    get:
      description: This API produces a list of recently active (past 90 days) cars from the market for the given search criteria
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/append_api_key"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - description: Radius around the search location (Unit - Miles)
          in: query
          name: radius
          schema:
            format: int32
            maximum: 100
            minimum: 0
            type: integer
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/car_include_lease"
        - $ref: "#/components/parameters/car_include_finance"
        - $ref: "#/components/parameters/lease_term"
        - $ref: "#/components/parameters/lease_down_payment"
        - $ref: "#/components/parameters/lease_emp"
        - $ref: "#/components/parameters/finance_loan_term"
        - $ref: "#/components/parameters/finance_loan_apr"
        - $ref: "#/components/parameters/finance_emp"
        - $ref: "#/components/parameters/finance_down_payment"
        - $ref: "#/components/parameters/finance_down_payment_per"
        - $ref: "#/components/parameters/car_car_type"
        - $ref: "#/components/parameters/carfax_1_owner"
        - $ref: "#/components/parameters/carfax_clean_title"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/ymmt"
        - $ref: "#/components/parameters/match"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_aspiration"
        - $ref: "#/components/parameters/engine_block"
        - $ref: "#/components/parameters/uk_highway_mpg_range"
        - $ref: "#/components/parameters/uk_city_mpg_range"
        - $ref: "#/components/parameters/uk_combined_mpg_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/dom_range"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/first_seen_at_source_range"
        - $ref: "#/components/parameters/first_seen_at_mc_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/first_seen_at_source_days"
        - $ref: "#/components/parameters/first_seen_at_mc_days"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/include_non_vin_listings"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/car_uk_country"
        - $ref: "#/components/parameters/car_plot"
        - $ref: "#/components/parameters/car_nodedup"
        - $ref: "#/components/parameters/car_dedup"
        - $ref: "#/components/parameters/owned"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/dealer_name"
        - $ref: "#/components/parameters/dealership_group_name"
        - $ref: "#/components/parameters/trim_o"
        - $ref: "#/components/parameters/trim_r"
        - $ref: "#/components/parameters/dom_active_range"
        - $ref: "#/components/parameters/dom_180_range"
        - $ref: "#/components/parameters/exclude_certified"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/dealer_type"
        - $ref: "#/components/parameters/photo_links"
        - $ref: "#/components/parameters/photo_links_cached"
        - $ref: "#/components/parameters/stock_no"
        - description: sold parameter to fetch only sold listings
          in: query
          name: sold
          required: false
          schema:
            type: boolean
        - $ref: "#/components/parameters/include_relevant_links"
        - $ref: "#/components/parameters/expired"
        - $ref: "#/components/parameters/exclude_dealer_ids"
        - $ref: "#/components/parameters/exclude_sources"
        - $ref: "#/components/parameters/in_transit"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/insurance_group"
        - $ref: "#/components/parameters/vrm"
        - $ref: "#/components/parameters/num_owners"
        - $ref: "#/components/parameters/variant"
        - $ref: "#/components/parameters/postal_code"
        - $ref: "#/components/parameters/write_off_category"
        - $ref: "#/components/parameters/fca_status"
        - $ref: "#/components/parameters/active_inventory_date_range"
        - $ref: "#/components/parameters/engine_size_range"
        - $ref: "#/components/parameters/price_change_range"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UKSearchResponse"
          description: List of all cars listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets Recent UK car listings for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/heavy-equipment/active:
    get:
      description: |-
        This endpoint provides search on heavy equipment inventory. This API produces a list of currently active heavy equipments from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows. 
         The search API facilitates the following use cases - 
        1. Search heavy equipments around a given geo-point within a given radius 
        2. Search heavy equipments for a specific year / make / model or combination of these 
        3. Search heavy equipments matching multiple year, make, model combinatins in the same search request
        4. Filter results by most heavy equipment specification attributes
        5. Filter heavy equipments within a given price / miles range
        6. Specify a sort order for the results on price / miles / listed date 
        7. Search heavy equipments for a given City / State combination 
        8. Get Facets to build the search drill downs 
        9. Get Market averages for price/miles for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/search_text"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/inventory_type"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/dealer_name"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/body_type"
        - description: To filter heavy equipments on their category
          in: query
          name: category
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: category
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter heavy equipments on their sub-category
          in: query
          name: sub_category
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: sub_category
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Hours used range to filter heavy equipments with the their usage in the range given. Range to be given in the format - min-max e.g. 1000-5000
          in: query
          name: hours_used_range
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: "-"
            targetAlias: hours_used
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HeavyEquipmentsSearchResponse"
          description: List of all heavy equipment listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active heavy equipment listings for the given search criteria
      tags:
        - Heavy Equipment Search
    x-swagger-router-controller: search
  /search/heavy-equipment/auto-complete:
    get:
      description: Auto-complete the inputs of your end users
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Field name for which you want auto-completion
          in: query
          name: field
          required: true
          schema:
            enum:
              - make
              - model
              - trim
              - body_type
              - transmission
              - drivetrain
              - fuel_type
              - exterior_color
              - interior_color
              - engine
              - category
              - sub_category
              - state
              - city
            format: string
            type: string
        - description: Input entered so far
          in: query
          name: input
          required: true
          schema:
            format: string
            type: string
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/inventory_type"
        - description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          schema:
            default: true
            type: boolean
        - description: Boolean variable to indicate wheather to include term counts as well in response
          in: query
          name: term_counts
          required: false
          schema:
            default: false
            type: boolean
        - description: Sort the response, either by index or count(default)
          in: query
          name: sort_by
          required: false
          schema:
            default: index
            enum:
              - index
              - count
            type: string
        - description: seller type for autocomplete
          in: query
          name: seller_type
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: seller_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/facet_min_count"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchAutoCompleteResponse"
          description: Unique terms available in given field for auto completion
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: API for auto-completion of inputs
      tags:
        - Heavy Equipment Search
      x-swagger-router-controller: search
  /search/motorcycle/active:
    get:
      description: |-
        This endpoint provides search on motorcycle inventory. This API produces a list of currently active motorcycles from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows. 
         The search API facilitates the following use cases - 
        1. Search motorcycles around a given geo-point within a given radius 
        2. Search motorcycles for a specific year / make / model or combination of these 
        3. Search motorcycles matching multiple year, make, model combinatins in the same search request
        4. Filter results by most motorcycle specification attributes
        5. Search for similar motorcycles by VIN or Taxonomy VIN 
        6. Filter motorcycles within a given price / miles range
        7. Specify a sort order for the results on price / miles / listed date 
        8. Search motorcycles for a given City / State combination 
        9. Get Facets to build the search drill downs 
        10. Get Market averages for price/miles for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/search_text"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/vin"
        - description: Taxonomy VIN of the motorcycle
          in: query
          name: taxonomy_vin
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: taxonomy_vin
            transformConstraints:
              - maxLength: 10
                transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/inventory_type"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/color"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MotorcycleSearchResponse"
          description: List of all motorcycles listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active motorcycle listings for the given search criteria
      tags:
        - Motorcycle Search
    x-swagger-router-controller: search
  /search/motorcycle/auto-complete:
    get:
      description: Auto-complete the inputs of your end users
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Field name for which you want auto-completion
          in: query
          name: field
          required: true
          schema:
            enum:
              - make
              - model
              - trim
              - body_type
              - vehicle_type
              - transmission
              - drivetrain
              - fuel_type
              - color
              - engine
              - state
              - city
            format: string
            type: string
        - description: Input entered so far
          in: query
          name: input
          required: true
          schema:
            format: string
            type: string
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/inventory_type"
        - description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          schema:
            default: true
            type: boolean
        - description: Boolean variable to indicate wheather to include term counts as well in response
          in: query
          name: term_counts
          required: false
          schema:
            default: false
            type: boolean
        - description: Sort the response, either by index or count(default)
          in: query
          name: sort_by
          required: false
          schema:
            default: index
            enum:
              - index
              - count
            type: string
        - description: seller type for autocomplete
          in: query
          name: seller_type
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: seller_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/facet_min_count"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchAutoCompleteResponse"
          description: Unique terms available in given field for auto completion
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: API for auto-completion of inputs
      tags:
        - Motorcycle Search
      x-swagger-router-controller: search
  /search/rv/active:
    get:
      description: |-
        This endpoint provides search on RV inventory. This API produces a list of currently active RV from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows. 
         The search API facilitates the following use cases - 
        1. Search RV around a given geo-point within a given radius 
        2. Search RV for a specific year / make / model or combination of these 
        3. Search RV matching multiple year, make, model combinatins in the same search request
        4. Filter results by most RV specification attributes
        5. Filter RV within a given price / miles range
        6. Specify a sort order for the results on price / miles / listed date 
        7. Search RV for a given City / State combination 
        8. Get Facets to build the search drill downs 
        9. Get Market averages for price/miles for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/search_text"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/model_o"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/inventory_type"
        - $ref: "#/components/parameters/stock_no"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/dealer_name"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/transmission"
        - description: Filter RV listings on class
          in: query
          name: class
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: class
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/msa_code"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - description: Filter RV listings on slideouts
          in: query
          name: slideouts
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: slideouts
            transformConstraints:
              - transformer: parseInt
                type: integer
        - description: length range to filter listings with the length in the range given. Range to be given in the format - min-max e.g. 50-200
          in: query
          name: length_range
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: "-"
            targetAlias: length_fs
            transformConstraints:
              - defaultMax: 200
                defaultMin: 1
                transformer: parseInt
                type: integer
        - description: Filter RV listings on length
          in: query
          name: length
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: length
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/fresh_water_capacity"
        - $ref: "#/components/parameters/sleeps"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/number_of_awnings"
        - $ref: "#/components/parameters/doors"
        - $ref: "#/components/parameters/gvwr"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RVSearchResponse"
          description: List of all RV listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active RV listings for the given search criteria
      tags:
        - RV Search
    x-swagger-router-controller: search
  /search/rv/auto-complete:
    get:
      description: Auto-complete the inputs of your end users
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Field name for which you want auto-completion
          in: query
          name: field
          required: true
          schema:
            enum:
              - make
              - model
              - trim
              - class
              - transmission
              - fuel_type
              - exterior_color
              - interior_color
              - engine
              - state
              - city
            format: string
            type: string
        - description: Input entered so far
          in: query
          name: input
          required: true
          schema:
            format: string
            type: string
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/color"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/inventory_type"
        - description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          schema:
            default: true
            type: boolean
        - description: Boolean variable to indicate wheather to include term counts as well in response
          in: query
          name: term_counts
          required: false
          schema:
            default: false
            type: boolean
        - description: Sort the response, either by index or count(default)
          in: query
          name: sort_by
          required: false
          schema:
            default: index
            enum:
              - index
              - count
            type: string
        - description: seller type for autocomplete
          in: query
          name: seller_type
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: seller_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/facet_min_count"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchAutoCompleteResponse"
          description: Unique terms available in given field for auto completion
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: API for auto-completion of inputs
      tags:
        - RV Search
      x-swagger-router-controller: search
  /search/rv/uk/active:
    get:
      description: |-
        This endpoint provides search on RV inventory. This API produces a list of currently active RV from the market for the given search criteria. The API results are limited to allow pagination upto 5000 rows. 
         The search API facilitates the following use cases - 
        1. Search RV around a given geo-point within a given radius 
        2. Search RV for a specific year / make / model or combination of these 
        3. Search RV matching multiple year, make, model combinatins in the same search request
        4. Filter results by most RV specification attributes
        5. Filter RV within a given price / miles range
        6. Specify a sort order for the results on price / miles / listed date 
        7. Search RV for a given City / State combination 
        8. Get Facets to build the search drill downs 
        9. Get Market averages for price/miles for your search
      parameters:
        - $ref: "#/components/parameters/api_key"
        - $ref: "#/components/parameters/price_range"
        - $ref: "#/components/parameters/miles_range"
        - $ref: "#/components/parameters/msrp_range"
        - $ref: "#/components/parameters/year_range"
        - $ref: "#/components/parameters/search_text"
        - $ref: "#/components/parameters/latitude"
        - $ref: "#/components/parameters/longitude"
        - $ref: "#/components/parameters/radius"
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/source"
        - $ref: "#/components/parameters/dealer_name"
        - $ref: "#/components/parameters/dealer_id"
        - $ref: "#/components/parameters/exterior_color"
        - $ref: "#/components/parameters/interior_color"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/fuel_type"
        - description: Filter RV listings on category
          in: query
          name: category
          required: false
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: category_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/state"
        - $ref: "#/components/parameters/city"
        - $ref: "#/components/parameters/county"
        - description: To filter listing on postal code around which they are listed
          in: query
          name: postal_code
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: zip
            transformConstraints:
              - regex: \s
                replace: ""
                transformer: regexReplace
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/zip"
        - $ref: "#/components/parameters/sort_by"
        - $ref: "#/components/parameters/sort_order"
        - $ref: "#/components/parameters/rows"
        - $ref: "#/components/parameters/start"
        - $ref: "#/components/parameters/facets"
        - $ref: "#/components/parameters/range_facets"
        - $ref: "#/components/parameters/facet_sort"
        - $ref: "#/components/parameters/stats"
        - $ref: "#/components/parameters/last_seen_range"
        - $ref: "#/components/parameters/first_seen_range"
        - $ref: "#/components/parameters/last_seen_days"
        - $ref: "#/components/parameters/first_seen_days"
        - $ref: "#/components/parameters/base_exterior_color"
        - $ref: "#/components/parameters/base_interior_color"
        - $ref: "#/components/parameters/seating_capacity"
        - $ref: "#/components/parameters/cylinders"
        - $ref: "#/components/parameters/doors"
        - description: To filter rv on mtplm
          in: query
          name: mtplm
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: mtplm_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter rv on their sub-category
          in: query
          name: sub_category
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: subcategory_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter rv on their availability_status
          in: query
          name: availability_status
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: availability_status_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter rv on their berths
          in: query
          name: berths
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: berth_is
            transformConstraints:
              - transformer: parseInt
                type: integer
        - $ref: "#/components/parameters/inventory_type"
        - description: width range to filter listings on width in the range given. Range to be given in the format - min-max e.g. 4-8
          in: query
          name: width_range
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: "-"
            targetAlias: width_fs
            transformConstraints:
              - defaultMax: 100
                defaultMin: 1
                transformer: parseFloat
                type: integer
        - description: width range to filter listings on exterior_length in the range given. Range to be given in the format - min-max e.g. 4-8
          in: query
          name: exterior_length_range
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: "-"
            targetAlias: exterior_length_fs
            transformConstraints:
              - defaultMax: 1000000
                defaultMin: 1
                transformer: parseFloat
                type: integer
        - description: width range to filter listings on interior_length in the range given. Range to be given in the format - min-max e.g. 4-8
          in: query
          name: interior_length_range
          required: false
          schema:
            format: string
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: "-"
            targetAlias: interior_length_fs
            transformConstraints:
              - defaultMax: 1000000
                defaultMin: 1
                transformer: parseFloat
                type: integer
        - description: To filter rv on their drive_type
          in: query
          name: drive_type
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: drive_type_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter rv on their steering
          in: query
          name: steering
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: steering_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter rv on their chassis
          in: query
          name: chassis
          schema:
            type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ","
            targetAlias: chassis_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - $ref: "#/components/parameters/transmission"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UKRVSearchResponse"
          description: List of all RV listings matching the search & filter criteria
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Gets active RV listings for the given search criteria
      tags:
        - RV Search
    x-swagger-router-controller: search
  /specs/car/auto-complete:
    get:
      description: Auto-complete the inputs of your end users, not from active set but from taxonomy (decoder database)
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Field name for which you want auto-completion
          in: query
          name: field
          required: true
          schema:
            enum:
              - make
              - model
              - trim
              - body_type
              - body_subtype
              - vehicle_type
              - transmission
              - drivetrain
              - fuel_type
              - engine
              - engine_size
              - engine_block
            format: string
            type: string
        - description: Input entered so far
          in: query
          name: input
          required: true
          schema:
            format: string
            type: string
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_block"
        - description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          schema:
            default: true
            type: boolean
        - $ref: "#/components/parameters/facet_min_count"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SpecsAutoCompleteResponse"
          description: Unique terms available in given field for auto completion
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: API for auto-completion of inputs based on taxonomy
      tags:
        - VIN Decoder API
      x-swagger-router-controller: search
  /specs/car/terms:
    get:
      description: Facets on taxonomy
      operationId: getTaxonomyTerms
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Comma separated list of fields to get terms for
          in: query
          name: field
          required: true
          schema:
            format: string
            type: string
        - $ref: "#/components/parameters/year"
        - $ref: "#/components/parameters/make"
        - $ref: "#/components/parameters/model"
        - $ref: "#/components/parameters/trim"
        - $ref: "#/components/parameters/body_type"
        - $ref: "#/components/parameters/body_subtype"
        - $ref: "#/components/parameters/vehicle_type"
        - $ref: "#/components/parameters/transmission"
        - $ref: "#/components/parameters/drivetrain"
        - $ref: "#/components/parameters/fuel_type"
        - $ref: "#/components/parameters/engine"
        - $ref: "#/components/parameters/engine_size"
        - $ref: "#/components/parameters/engine_block"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SpecsAutoCompleteResponse"
          description: List of unique terms for specified fields
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: API for getting terms from taxonomy
      tags:
        - VIN Decoder API
      x-swagger-router-controller: vin_decoder
  /stats/car:
    get:
      description: National, state and city level stats for price, miles and dom
      operationId: getDailyStats
      parameters:
        - $ref: "#/components/parameters/api_key"
        - description: Country for which the stats are to be searched
          in: query
          name: country
          required: false
          schema:
            default: us
            enum:
              - us
              - ca
            format: string
            type: string
        - description: Inventory type for which stats are to be searched, default is used
          in: query
          name: car_type
          required: false
          schema:
            default: used
            enum:
              - new
              - used
            format: string
            type: string
        - description: Year, Make, Model of the car, Separated by pipe e.g. ymm=2015|ford|f-150
          in: query
          name: ymm
          required: false
          schema:
            format: string
            type: string
        - description: Year, Make, Model, Trim of the car, Separated by pipe e.g. ymmt=2015|ford|f-150|platinum
          in: query
          name: ymmt
          required: false
          schema:
            format: string
            type: string
        - description: Taxonomy vin for referance to find stats of similar cars
          in: query
          name: taxonomy_vin
          required: false
          schema:
            format: string
            type: string
        - description: VIN that will be transformed to taxonomy_vin
          in: query
          name: vin
          required: false
          schema:
            format: string
            type: string
        - description: State level stats
          in: query
          name: state
          required: false
          schema:
            format: string
            type: string
        - description: City level stats, pipe seperated like city_state=jacksonville|FL
          in: query
          name: city_state
          required: false
          schema:
            format: string
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DailyStats"
          description: Data with Market averages and stats
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Error
      summary: Price, Miles and Days on Market stats
      tags:
        - Cars Market API
      x-swagger-router-controller: market
components:
  parameters:
    active_inventory_date_range:
      description: date range to filter listings that were active within given date range. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623
      in: query
      name: active_inventory_date_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        transformConstraints:
          - transformer: parseDate
            type: date
    api_key:
      description: The API Authentication Key. Mandatory with all API calls.
      in: query
      name: api_key
      schema:
        type: string
    append_api_key:
      description: Flag on whether to include api_key in response API urls (if any)
      in: query
      name: append_api_key
      schema:
        default: true
        type: boolean
    base_exterior_color:
      description: Base exterior color to match. Valid filter values are those that our Search facets API returns for unique base exterior colors. You can pass in multiple base interior color values comma separated
      in: query
      name: base_exterior_color
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: base_exterior_color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    base_interior_color:
      description: Base interior color to match. Valid filter values are those that our Search facets API returns for unique base interior colors. You can pass in multiple base interior color values comma separated
      in: query
      name: base_interior_color
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: base_interior_color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    body_subtype:
      description: Body subtype to filter the listings on. Valid filter values are those that our Search facets API returns for unique body subtypes. You can pass in multiple body subtype values comma separated
      in: query
      name: body_subtype
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: body_subtype
        transformConstraints:
          - transformer: caseTransformer
            type: string
    body_type:
      description: To filter listing on their body type
      in: query
      name: body_type
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: body_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    boost:
      description: Flag to sort listings based on client filter score in solr
      in: query
      name: boost
      required: false
      schema:
        default: true
        enum:
          - true
          - false
        type: boolean
    car_car_type:
      description: Car type. Allowed values are - new / used / certified
      in: query
      name: car_type
      required: false
      schema:
        enum:
          - new
          - used
          - certified
        type: string
    car_country:
      description: To filter listing on Country in which they are listed
      in: query
      name: country
      schema:
        default: US
        enum:
          - US
          - CA
          - us
          - ca
          - all
          - ALL
        type: string
    car_dealer_id:
      description: Dealer id to filter the listings.
      in: query
      name: dealer_id
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: seed_id
        transformConstraints:
          - transformer: parseInt
            type: integer
        widgetExclusive: true
    car_dedup:
      description: If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source
      in: query
      name: dedup
      required: false
      schema:
        type: boolean
    car_include_finance:
      description: Boolean param to search for listings that include finance options in them
      in: query
      name: include_finance
      required: false
      schema:
        type: boolean
    car_include_lease:
      description: Boolean param to search for listings that include leasing options in them
      in: query
      name: include_lease
      required: false
      schema:
        type: boolean
    car_location_city:
      description: Filter cars on city
      in: query
      name: car_location_city
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: car_city_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    car_location_county:
      description: Filter cars on county
      in: query
      name: car_location_county
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: car_county_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    car_location_latitude:
      description: Latitude component of car location
      in: query
      name: car_location_latitude
      schema:
        format: double
        type: number
    car_location_longitude:
      description: Longitude component of car location
      in: query
      name: car_location_longitude
      schema:
        format: double
        type: number
    car_location_seller_name:
      description: Filter cars on seller name
      in: query
      name: car_location_seller_name
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: car_dealership_name_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    car_location_street:
      description: Filter cars on street name
      in: query
      name: car_location_street
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: car_street_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    car_location_zip:
      description: To filter listing on car ZIP around which they are listed
      in: query
      name: car_location_zip
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: car_zip_ss
        transformConstraints:
          - regex: \s
            replace: ""
            transformer: regexReplace
          - transformer: caseTransformer
            type: string
    car_nodedup:
      description: If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin
      in: query
      name: nodedup
      required: false
      schema:
        type: boolean
    car_plot:
      description: If plot has value true results in around 25k coordinates with limited fields to plot respective graph
      in: query
      name: plot
      required: false
      schema:
        type: boolean
    car_seller_type:
      description: Seller type to filter cars on. Valid filter values are those that our Search facets API returns for unique seller types. You can pass in multiple seller type values comma separated.
      in: query
      name: seller_type
      required: false
      schema:
        default: dealer
        format: string
        type: string
    car_source:
      description: To filter listing on their source only for widget requests
      in: query
      name: source
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: source
        transformConstraints:
          - transformer: urlTransformer
            type: string
        widgetExclusive: true
    car_taxonomy_vins:
      description: Comma separated list of 10 letters excert from the 17 letter VIN. The 10 letters to be picked up from the 17 letter VIN are - first 8 letters and the 10th and 11th letter. E.g. For a VIN - 1FTFW1EF3EKE57182 the taxonomy vin would be - 1FTFW1EFEK  A taxonomy VIN identified a build of a car and could be used to filter our cars of a particular build. This is an alternative to the vin or ymmt parameters to the search API.
      in: query
      name: taxonomy_vins
      required: false
      schema:
        type: string
    car_type:
      description: Car type. Allowed values are - new / used
      in: query
      name: car_type
      required: false
      schema:
        enum:
          - new
          - used
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: in
        targetAlias: inventory_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    car_uk_country:
      description: To filter listing on Country in which they are listed
      in: query
      name: country
      schema:
        default: uk
        enum:
          - uk
          - england
          - scotland
          - northan ireland
          - wales
        type: string
    car_vins:
      description: Comma separated list of 17 digit vins to search the matching cars for. Only 10 VINs allowed per request. If the request contains more than 10 VINs the first 10 VINs will be considered. Could be used as a More Like This or Similar Vehicles search for the given VINs. Ths vins parameter is an alternative to taxonomy_vins or ymmt parameters available with the search API. vins and taxonomy_vins parameters could be used to filter our cars with the exact build represented by the vins or taxonomy_vins whereas ymmt is a top level filter that does not filter cars by the build attributes like doors, drivetrain, cylinders, body type, body subtype, vehicle type etc
      in: query
      name: vins
      required: false
      schema:
        type: string
    car_vrms:
      description: Comma separated list of vrms to search the matching cars for. Only 10 VRMs allowed per request. If the request contains more than 10 VRMs the first 10 VRMs will be considered. Could be used as a More Like This or Similar Vehicles search for the given VRMs.
      in: query
      name: vrms
      required: false
      schema:
        type: string
    carfax_1_owner:
      description: Indicates whether car has had only one owner or not
      in: query
      name: carfax_1_owner
      required: false
      schema:
        enum:
          - "true"
          - "false"
        type: string
    carfax_clean_title:
      description: Indicates whether car has clean ownership records
      in: query
      name: carfax_clean_title
      required: false
      schema:
        enum:
          - "true"
          - "false"
        type: string
    city:
      description: To filter listing on City in which they are listed
      in: query
      name: city
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: city
        transformConstraints:
          - transformer: caseTransformer
            type: string
    city_mpg_range:
      description: City mileage range to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: city_mpg_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: city_mpg
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseInt
            type: integer
    client_filters:
      description: Flag to add explicit filters set on client level in solr
      in: query
      name: client_filters
      required: false
      schema:
        default: true
        enum:
          - true
          - false
        type: boolean
    color:
      description: Color of the vehicle
      in: query
      name: color
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    country:
      description: To filter listing on Country in which they are listed
      in: query
      name: country
      schema:
        default: US
        enum:
          - US
          - CA
          - us
          - ca
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: country
        transformConstraints:
          - maxLength: 2
            transformer: caseTransformer
            type: string
    county:
      description: To filter listing on county in which they are listed
      in: query
      name: county
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: county
        transformConstraints:
          - transformer: caseTransformer
            type: string
    cylinders:
      description: To filter listing on their cylinders
      in: query
      name: cylinders
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: cylinders
        transformConstraints:
          - transformer: caseTransformer
            type: string
    dealer_id:
      description: Dealer id to filter the listings.
      in: query
      name: dealer_id
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: seed_id
        transformConstraints:
          - transformer: parseInt
            type: integer
    dealer_name:
      description: Filter listings on dealer_name
      in: query
      name: dealer_name
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: seller_name
        transformConstraints:
          - transformer: caseTransformer
            type: string
    dealer_type:
      description: Filter based on dealer type independant or franchise
      in: query
      name: dealer_type
      required: false
      schema:
        enum:
          - franchise
          - independent
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: in
        separator: ","
        targetAlias: dealer_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    dealership_group_name:
      description: Name of the dealership group to search for
      in: query
      name: dealership_group_name
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: dealership_group_name_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    dom_180_range:
      description: Last 180 Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50
      in: query
      name: dom_180_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: dom_180_is
        transformConstraints:
          - defaultMax: 30
            defaultMin: 0
            transformer: parseInt
            type: integer
    dom_active_range:
      description: Active Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50
      in: query
      name: dom_active_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: dom_active_is
        transformConstraints:
          - defaultMax: 30
            defaultMin: 0
            transformer: parseInt
            type: integer
    dom_range:
      description: Days on Market range to filter cars with the DOM within the given range. Range to be given in the format - min-max e.g. 10-50
      in: query
      name: dom_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: dom_is
        transformConstraints:
          - defaultMax: 30
            defaultMin: 0
            transformer: parseInt
            type: integer
    doors:
      description: Doors to filter the cars on. Valid filter values are those that our Search facets API returns for unique doors. You can pass in multiple doors values comma separated
      in: query
      name: doors
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: doors_is
        transformConstraints:
          - min: 1
            transformer: parseInt
            type: integer
    drivetrain:
      description: To filter listing on their drivetrain
      in: query
      name: drivetrain
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: drivetrain
        transformConstraints:
          - transformer: caseTransformer
            type: string
    engine:
      description: To filter listing on their engine
      in: query
      name: engine
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: engine
        transformConstraints:
          - transformer: caseTransformer
            type: string
    engine_aspiration:
      description: Engine Aspiration to match. Valid filter values are those that our Search facets API returns for unique Engine Aspirations. You can pass in multiple Engine aspirations values comma separated
      in: query
      name: engine_aspiration
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: engine_aspiration
        transformConstraints:
          - transformer: caseTransformer
            type: string
    engine_block:
      description: Engine Block to match. Valid filter values are those that our Search facets API returns for unique Engine Block. You can pass in multiple Engine Block values comma separated
      in: query
      name: engine_block
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: engine_block_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    engine_size:
      description: Engine Size to match. Valid filter values are those that our Search facets API returns for unique engine size. You can pass in multiple engine size values comma separated
      in: query
      name: engine_size
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: engine_size
        transformConstraints:
          - transformer: caseTransformer
            type: string
    engine_size_range:
      description: Engine size range to filter listings with engine size in the given range. Range to be given in the format - min-max e.g. 1.0-2
      in: query
      name: engine_size_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: engine_size_ss
        transformConstraints:
          - defaultMax: 100
            defaultMin: 0
            transformer: parseFloat
            type: integer
    exclude_certified:
      description: Boolean param to exclude certified cars from search results
      in: query
      name: exclude_certified
      required: false
      schema:
        type: boolean
    exclude_dealer_ids:
      description: A list of dealer ids to exclude from result
      in: query
      name: exclude_dealer_ids
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        targetAlias: seed_id
        transformConstraints:
          - transformer: parseInt
            type: integer
    exclude_dealer_listings:
      description: A list of fsbo listings to exclude from result
      in: query
      name: exclude_dealer_listings
      required: false
      schema:
        type: boolean
      x-field-config:
        isConfigurable: true
        operator: equals
        targetAlias: exclude_dealer_listings_is
        transformConstraints:
          - transformer: boolToFlag
            type: string
    exclude_sources:
      description: A list of sources to exclude from result
      in: query
      name: exclude_sources
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        targetAlias: source
        transformConstraints:
          - transformer: urlTransformer
            type: string
    exclude_write_off_category:
      description: To exclude write off category
      in: query
      name: exclude_write_off_category
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: -write_off_category_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
        widgetExclusive: true
    expired:
      description: Boolean falg to either fetch only the expired listings or active ones
      in: query
      name: expired
      required: false
      schema:
        enum:
          - "true"
          - "false"
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: in
        targetAlias: is_expired_listing
        transformConstraints:
          - transformer: boolToFlag
            type: string
    exterior_color:
      description: Exterior color to match. Valid filter values are those that our Search facets API returns for unique exterior colors. You can pass in multiple exterior color values comma separated
      in: query
      name: exterior_color
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: exterior_color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    facet_min_count:
      description: Provide minimum count value for facets
      in: query
      name: facet_min_count
      required: false
      schema:
        default: 1
        format: number
        type: number
    facet_sort:
      description: Control sort order of facets with this parameter with default sort being on count, Other available sort is alphabetical sort, which can be obtained by using index as value for this param
      in: query
      name: facet_sort
      required: false
      schema:
        default: count
        enum:
          - count
          - index
        type: string
    facets:
      description: The comma separated list of fields for which facets are requested. Facets could be requested in addition to the listings for the search. Please note - The API calls with lots of facet fields may take longer to respond.
      in: query
      name: facets
      required: false
      schema:
        type: string
    fca_status:
      description: To filter on fca status
      in: query
      name: fca_status
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: fca_status_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
        widgetExclusive: true
    finance_down_payment:
      description: Search listings with exact down payment in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment=30-60
      in: query
      name: finance_down_payment
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: f_down_pay_fs
        transformConstraints:
          - defaultMax: 10000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    finance_down_payment_per:
      description: Search listings with exact down payment percentage in finance offers, or inside a range with min and max seperated by a dash like finance_down_payment_per=30-60
      in: query
      name: finance_down_payment_per
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: f_down_pay_per_fs
        transformConstraints:
          - defaultMax: 20
            defaultMin: 1
            transformer: parseInt
            type: integer
    finance_emp:
      description: Search listings with finance offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like finance_emp=30-60
      in: query
      name: finance_emp
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: f_emi_fs
        transformConstraints:
          - defaultMax: 3000
            defaultMin: 10
            transformer: parseInt
            type: integer
    finance_loan_apr:
      description: Search listings with finance offers exactly matching loans Annual Percentage Rate, or inside a range with min and max seperated by a dash like finance_loan_apr=30-60
      in: query
      name: finance_loan_apr
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: loan_apr_fs
        transformConstraints:
          - defaultMax: 12
            defaultMin: 1
            transformer: parseInt
            type: integer
    finance_loan_term:
      description: Search listings with exact finance loan term, or inside a range with min and max seperated by a dash like finance_loan_term=30-60
      in: query
      name: finance_loan_term
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: loan_term_is
        transformConstraints:
          - defaultMax: 48
            defaultMin: 12
            transformer: parseInt
            type: integer
    first_seen_at_mc_days:
      description: First seen at MC days range to filter listings with the first seen at MC in the range given. Range to be given in the format - min-max e.g. 25-12
      in: query
      name: first_seen_at_mc_days
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: first_scraped_at_dts
        transformConstraints:
          - nowBound: true
            transformer: parseDate
            type: date
    first_seen_at_mc_range:
      description: First seen at MC date range to filter listings with the first seen at MC in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623
      in: query
      name: first_seen_at_mc_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: first_scraped_at_dts
        transformConstraints:
          - transformer: parseDate
            type: date
    first_seen_at_source_days:
      description: First seen at source days range to filter listings with the first seen at source in the range given. Range to be given in the format - min-max e.g. 25-12
      in: query
      name: first_seen_at_source_days
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: relisted_at_date_dts
        transformConstraints:
          - nowBound: true
            transformer: parseDate
            type: date
    first_seen_at_source_range:
      description: First seen at source date range to filter listings with the first seen at source in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623
      in: query
      name: first_seen_at_source_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: relisted_at_date_dts
        transformConstraints:
          - transformer: parseDate
            type: date
    first_seen_days:
      description: First seen days range to filter listings with the first seen in the range given. Range to be given in the format - min-max e.g. 25-12
      in: query
      name: first_seen_days
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: scraped_at
        transformConstraints:
          - nowBound: true
            transformer: parseDate
            type: date
    first_seen_range:
      description: First seen date range to filter listings with the first seen in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623
      in: query
      name: first_seen_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: scraped_at
        transformConstraints:
          - transformer: parseDate
            type: date
    fresh_water_capacity:
      description: To filter on fresh water capacity of vehicle
      in: query
      name: fresh_water_capacity
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: fresh_water_capacity_fs
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 0
            transformer: parseInt
            type: integer
    fuel_type:
      description: To filter listing on their fuel type
      in: query
      name: fuel_type
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: fuel_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    gvwr:
      description: To filter on the maximum total weight of your vehicle
      in: query
      name: gvwr
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: gvwr_fs
        transformConstraints:
          - defaultMax: 1000000
            defaultMin: 100
            transformer: parseInt
            type: integer
    high_value_features:
      description: To filter listings on their high_value_features. Results will be intersection of provided HVFs
      in: query
      name: high_value_features
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: multi-in
        separator: ","
        targetAlias: high_value_features_mv
        transformConstraints:
          - caseSelector: 2
            isSolrMultivalued: true
            transformer: caseTransformer
            type: string
    highway_mpg_range:
      description: Highway mileage range to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: highway_mpg_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: highway_mpg
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseInt
            type: integer
    id:
      description: Listing id to get all the listing attributes
      in: path
      name: id
      required: true
      schema:
        format: string
        type: string
    in_transit:
      description: A boolean to filter in transit vehicles
      in: query
      name: in_transit
      required: false
      schema:
        enum:
          - "true"
          - "false"
        type: string
      x-field-config:
        isConfigurable: false
        isMultiValued: false
        operator: equals
        targetAlias: in_transit_ss
        transformConstraints:
          - transformer: boolToFlag
            type: string
    include_non_vin_listings:
      description: To include non vin listings. Default is false
      in: query
      name: include_non_vin_listings
      required: false
      schema:
        default: false
        type: boolean
    include_relevant_links:
      description: To include_relevant_links. Default is true
      in: query
      name: include_relevant_links
      required: false
      schema:
        default: false
        type: boolean
    inpath_full_vin:
      description: The VIN to identify the car. Must be a valid 17 char VIN
      in: path
      name: vin
      required: true
      schema:
        format: string
        minLength: 10
        type: string
    inpath_vrm:
      description: The VRM to identify the car.
      in: path
      name: vrm
      required: true
      schema:
        format: string
        type: string
    insurance_group:
      description: Insurance Group
      in: query
      name: insurance_group
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: insurance_group
        transformConstraints:
          - transformer: caseTransformer
            type: string
    interior_color:
      description: Interior color to match. Valid filter values are those that our Search facets API returns for unique interior colors. You can pass in multiple interior color values comma separated
      in: query
      name: interior_color
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: interior_color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    inventory_count_range:
      description: Inventory count range to filter listings with count of total listings in dealers inventory. Range to be given in the format - min-max e.g. 10-50
      in: query
      name: inventory_count_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: inventory_count_is
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 0
            transformer: parseInt
            type: integer
    inventory_type:
      description: To filter listing on their condition. Either used or new
      in: query
      name: inventory_type
      schema:
        enum:
          - used
          - new
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: in
        targetAlias: inventory_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    inventory_url:
      description: inventory_url of dealer to be searched
      in: query
      name: inventory_url
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: website
        transformConstraints:
          - transformer: urlTransformer
            type: string
    last_seen_days:
      description: Last seen days range to filter listings with the last seen in the range given. Range to be given in the format - min-max e.g. 25-12
      in: query
      name: last_seen_days
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: status_date
        transformConstraints:
          - nowBound: true
            transformer: parseDate
            type: date
    last_seen_range:
      description: Last seen date range to filter listings with the last seen in the range given. Range to be given in the format [YYYYMMDD] - min-max e.g. 20190523-20190623
      in: query
      name: last_seen_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: status_date
        transformConstraints:
          - transformer: parseDate
            type: date
    latitude:
      description: Latitude component of location
      in: query
      name: latitude
      schema:
        format: double
        type: number
    lease_down_payment:
      description: Search listings with exact down payment in lease offers, or inside a range with min and max seperated by a dash like lease_down_payment=30-60
      in: query
      name: lease_down_payment
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: l_down_pay_fs
        transformConstraints:
          - defaultMax: 5000
            defaultMin: 100
            transformer: parseInt
            type: integer
    lease_emp:
      description: Search listings with lease offers exactly matching Estimated Monthly Payment(EMI), or inside a range with min and max seperated by a dash like lease_emp=30-60
      in: query
      name: lease_emp
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: l_emi_fs
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 100
            transformer: parseInt
            type: integer
    lease_term:
      description: Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60
      in: query
      name: lease_term
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        separator: "-"
        targetAlias: lease_term_is
        transformConstraints:
          - defaultMax: 48
            defaultMin: 12
            transformer: parseInt
            type: integer
    listing_count_range:
      description: To filter dealers based on their inventory size. Range can be given in the format - min-max e.g. 50-100
      in: query
      name: listing_count_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: listing_count
        transformConstraints:
          - defaultMax: 500
            defaultMin: 10
            transformer: parseInt
            type: integer
    longitude:
      description: Longitude component of location
      in: query
      name: longitude
      schema:
        format: double
        type: number
    make:
      description: To filter listings on their make
      in: query
      name: make
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: make
        transformConstraints:
          - transformer: caseTransformer
            type: string
    match:
      description: Comma separated list of Year, Make, Model, Trim fields. For example - year,make,model,trim fields for which user wants to do an exact match
      in: query
      name: match
      required: false
      schema:
        type: string
    miles_range:
      description: Miles range to filter listings with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: miles_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: miles
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    min_photo_links:
      description: Filter listings based by number of photo links within given range
      in: query
      name: min_photo_links
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: photo_links_count_is
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseFloat
            type: integer
    min_photo_links_cached:
      description: Filter listings based by number of cached photo links within given range
      in: query
      name: min_photo_links_cached
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: cached_photo_links_count_is
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseFloat
            type: integer
    mm:
      description: Make-Model concatenated string. To help passing the results of auto-complete API on mm field, use this parameter and pass in the selected value as is
      in: query
      name: mm
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: equals
        targetAlias: mm
        transformConstraints:
          - transformer: caseTransformer
            type: string
    model:
      description: To filter listings on their model
      in: query
      name: model
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: model
        transformConstraints:
          - transformer: caseTransformer
            type: string
    model_o:
      description: To filter listings on their model orig (as described on the webpage)
      in: query
      name: model_o
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: model_o
        transformConstraints:
          - transformer: caseTransformer
            type: string
    msa_code:
      description: To filter listing on msa code in which they are listed
      in: query
      name: msa_code
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: msa_code
    msrp_range:
      description: MSRP range to filter listings with the msrp in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: msrp_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: msrp
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    nhtsa_recall_number:
      description: nhtsa_recall_number to match. You can pass in multiple nhtsa_recall_number values comma separated
      in: query
      name: nhtsa_recall_number
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: nhtsa_recall_number
        transformConstraints:
          - transformer: caseTransformer
            type: string
    non_default_country:
      description: To filter listing on Country in which they are listed
      in: query
      name: country
      schema:
        enum:
          - US
          - CA
          - us
          - ca
          - uk
          - england
          - scotland
          - northan ireland
          - wales
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: country
        transformConstraints:
          - transformer: caseTransformer
            type: string
    num_owners:
      description: Number of owners. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: num_owners
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: num_owners
        transformConstraints:
          - defaultMax: 5
            defaultMin: 1
            transformer: parseInt
            type: integer
    number_of_awnings:
      description: To filter on number_of_awnings
      in: query
      name: number_of_awnings
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: number_of_awnings_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    owned:
      description: Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself
      in: query
      name: owned
      required: false
      schema:
        type: boolean
    photo_links:
      description: A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them
      in: query
      name: photo_links
      required: false
      schema:
        type: boolean
    photo_links_cached:
      description: A boolean indicating whether to include only those listings that have photo_links_cached in search results, And discard those that don't have them
      in: query
      name: photo_links_cached
      required: false
      schema:
        type: boolean
    postal_code:
      description: To filter listing on postal code around which they are listed
      in: query
      name: postal_code
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: postal_code
        transformConstraints:
          - regex: \s
            replace: ""
            transformer: regexReplace
          - transformer: caseTransformer
            type: string
    powertrain_type:
      description: To filter on powertrain_type
      in: query
      name: powertrain_type
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: powertrain_type_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    price_change:
      description: Query to filter listings based on their positive and negative price change
      in: query
      name: price_change
      required: false
      schema:
        enum:
          - positive
          - negative
        type: string
    price_change_range:
      description: Price change range to filter listings with price change within given price_change_range. Range to be given in the format - min-max e.g. 10-500
      in: query
      name: price_change_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "|"
        targetAlias: price_change_fs
        transformConstraints:
          - defaultMax: 100000000
            defaultMin: -100000000
            transformer: parseInt
            type: integer
    price_range:
      description: Price range to filter listings with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: price_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: price
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    radius:
      description: Radius around the search location (Unit - Miles)
      in: query
      name: radius
      schema:
        format: int32
        maximum: 7000
        minimum: 0
        type: integer
    range_facets:
      description: The comma separated list of numeric fields for which range facets are requested. Range facets could be requested in addition to the listings for the search. Please note - The API calls with lots of range facet fields may take longer to respond.
      in: query
      name: range_facets
      required: false
      schema:
        type: string
    rank_miles_range:
      description: Miles range to filter listings with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: miles_range
      required: false
      schema:
        default: 1-
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: miles
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    rank_price_range:
      description: Price range to filter listings with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: price_range
      required: false
      schema:
        default: 1-
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: price
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    rows:
      description: Number of results to return. Default is 10. Max is 50
      in: query
      name: rows
      required: false
      schema:
        default: 10
        format: int32
        minimum: 0
        type: integer
    search_text:
      description: To search a substring across entire document
      in: query
      name: search_text
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: equals
        targetAlias: long_text_copy_field
    seating_capacity:
      description: To filter on vehicle seating capacity
      in: query
      name: seating_capacity
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: std_seating_capacity_ss
        transformConstraints:
          - transformer: parseInt
            type: integer
    sleeps:
      description: To filter data based on sleeps
      in: query
      name: sleeps
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: sleeps_is
        transformConstraints:
          - defaultMax: 300
            defaultMin: 0
            transformer: parseInt
            type: integer
    sort_by:
      description: Sort by field. Default sort field is distance from the given point
      in: query
      name: sort_by
      required: false
      schema:
        format: string
        type: string
    sort_order:
      description: Sort order - asc or desc. Default sort order is asc
      in: query
      name: sort_order
      required: false
      schema:
        enum:
          - asc
          - desc
          - ASC
          - DESC
        format: string
        type: string
    source:
      description: To filter listing on their source
      in: query
      name: source
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: source
        transformConstraints:
          - transformer: urlTransformer
            type: string
    start:
      description: Page number to fetch the results for the given criteria. Default is 0. Pagination is allowed only till first 10000 results for the search and sort criteria. The page value can be only between 1 to 10000/rows
      in: query
      name: start
      required: false
      schema:
        default: 0
        format: int32
        minimum: 0
        type: integer
    state:
      description: To filter listing on State in which they are listed
      in: query
      name: state
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: state
        transformConstraints:
          - maxLength: 2
            transformer: caseTransformer
            type: string
    stats:
      description: The list of fields for which stats need to be generated based on the matching listings for the search criteria. The stats consists of mean, max, average and count of listings based on which the stats are calculated for the field. Stats could be requested in addition to the listings for the search. Please note - The API calls with the stats fields may take longer to respond.
      in: query
      name: stats
      required: false
      schema:
        type: string
    stock_no:
      description: To filter listing on their stock number on lot
      in: query
      name: stock_no
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: stock_no
        transformConstraints:
          - transformer: caseTransformer
            type: string
    transmission:
      description: To filter listing on their transmission
      in: query
      name: transmission
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: transmission
        transformConstraints:
          - transformer: caseTransformer
            type: string
    trim:
      description: To filter listing on their trim
      in: query
      name: trim
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: trim
        transformConstraints:
          - transformer: caseTransformer
            type: string
    trim_o:
      description: Filter listings on web scraped trim
      in: query
      name: trim_o
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: trim_orig
        transformConstraints:
          - transformer: caseTransformer
            type: string
    trim_r:
      description: Filter trim on custom possible matches
      in: query
      name: trim_r
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: trim_r_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    uk_append_api_key:
      description: Flag on whether to include api_key in response API urls (if any)
      in: query
      name: append_api_key
      schema:
        default: false
        type: boolean
    uk_city_mpg_range:
      description: City mileage range for UK to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: city_mpg_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: city_mpg
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseFloat
            type: integer
    uk_combined_mpg_range:
      description: Combined mileage range for UK to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: combined_mpg_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: combined_mpg
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseFloat
            type: integer
    uk_highway_mpg_range:
      description: Highway mileage range for UK to filter listings with the mileage in the range given. Range to be given in the format - min-max e.g. 1000-5000
      in: query
      name: highway_mpg_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: highway_mpg
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseFloat
            type: integer
    ulez_compliant:
      description: Filter listings based on drive into ultra low emmition zone
      in: query
      name: ulez_compliant
      required: false
      schema:
        type: boolean
    uvc_id:
      description: To filter on uvc id
      in: query
      name: uvc_id
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: uvc_id_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    variant:
      description: To filter listing on their variant
      in: query
      name: variant
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: variant
        transformConstraints:
          - transformer: caseTransformer
            type: string
    vehicle_type:
      description: To filter listing on their vehicle type
      in: query
      name: vehicle_type
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: vehicle_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    vin:
      description: To filter listing on their VIN
      in: query
      name: vin
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: vin
        transformConstraints:
          - maxLength: 17
            transformer: caseTransformer
            type: string
    vrm:
      description: To filter on vrm
      in: query
      name: vrm
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: vehicle_registration_mark_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    write_off_category:
      description: write off category
      in: query
      name: write_off_category
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: write_off_category_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
        widgetExclusive: true
    year:
      description: To filter listing on their year
      in: query
      name: year
      schema:
        minLength: 4
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: year
        transformConstraints:
          - max: 2121
            min: 1800
            transformer: parseInt
            type: integer
    year_range:
      description: Year range to filter listings with the year in the range given. Range to be given in the format - min-max e.g. 2019-2021
      in: query
      name: year_range
      required: false
      schema:
        format: string
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: "-"
        targetAlias: year
        transformConstraints:
          - defaultMax: 2100
            defaultMin: 1900
            transformer: parseInt
            type: integer
    ymm:
      description: Year-Make-Model concatenated string. To help passing the results of auto-complete API on ymm field, use this parameter and pass in the selected value as is
      in: query
      name: ymm
      required: false
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: equals
        targetAlias: ymm
        transformConstraints:
          - transformer: caseTransformer
            type: string
    ymmt:
      description: Comma separated list of Year, Make, Model, Trim combinations. Each combination needs to have the year,make,model, trim values separated by a pipe '|' character in the form year|make|model|trim. e.g. 2010|Audi|A5,2014|Nissan|Sentra|S 6MT,|Honda|City|   You could just provide strings of the form - 'year|make||' or 'year|make|model' or '|make|model|' combinations. Individual year / make / model filters provied with the API calls will take precedence over the Year, Make, Model, Trim combinations. The Make, Model, Trim values must be valid values as per the Marketcheck Vin Decoder. If you are using a separate vin decoder then look at using the 'vins' or 'taxonomy_vins' parameter to the search api instead the year|make|model|trim combinations.
      in: query
      name: ymmt
      required: false
      schema:
        type: string
    zip:
      description: To filter listing on ZIP around which they are listed
      in: query
      name: zip
      schema:
        type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ","
        targetAlias: zip
        transformConstraints:
          - regex: \s
            replace: ""
            transformer: regexReplace
          - transformer: caseTransformer
            type: string
  requestBodies:
    CarRankRequest:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CarRankRequest"
      description: Inputs needed for ranking a group of car listings
      required: true
  schemas:
    Averages:
      properties:
        age:
          description: Average age of the car
          type: number
        dom:
          description: Average Days on Market value for the car based on all listings found in the Marketcheck database for this car
          type: number
        miles:
          description: Mean miles value for the car
          type: number
        msrp:
          description: Mean msrp value for the car
          type: number
        price:
          description: Mean price value for the car
          type: number
        units:
          description: No of units for this car on the market
          type: number
      type: object
    BaseListing:
      description: Minimal set of attributes describing a listing
      properties:
        base_ext_color:
          description: Base exterior color of the car
          type: string
        base_int_color:
          description: Base interior color of the car
          type: string
        build:
          $ref: "#/components/schemas/Build"
        carfax_1_owner:
          description: Flag to indicate whether listing is carfax_1_owner
          type: boolean
        carfax_clean_title:
          description: Flag to indicate whether listing is carfax_clean_title
          type: boolean
        data_source:
          description: Data source of the listing
          type: string
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dist:
          description: Distance of the car's location from the specified user lcoation
          format: double
          type: number
        dom:
          description: Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car
          type: integer
        dom_180:
          description: Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car
          type: integer
        dom_active:
          description: Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car
          type: integer
        exterior_color:
          description: Exterior color of the car
          type: string
        financing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingFinance"
          type: array
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        in_transit:
          description: in_transit of the listing
          type: boolean
        interior_color:
          description: Interior color of the car
          type: string
        inventory_type:
          description: Inventory type of car
          type: string
        is_certified:
          description: Certified car
          type: integer
        is_translated:
          description: is_translated of the listing
          type: boolean
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        leasing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingLease"
          type: array
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the car
          type: integer
        model_code:
          description: model_code of the listing
          type: string
        msrp:
          description: MSRP for the car
          type: integer
        price:
          description: Asking price for the car
          type: integer
        price_change_percent:
          description: Percentage difference between the cars's current price and ref_price i.e. last reported price
          format: double
          type: number
        ref_miles:
          description: Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date
          type: string
        ref_miles_dt:
          description: The date at which the last miles was reported online. This is earlier to last_seen_date
          type: integer
        ref_price:
          description: Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date
          type: string
        ref_price_dt:
          description: The date at which the last price was reported online. This is earlier to last_seen_date
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the car
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of car in dealers inventory
          type: string
        title_type:
          description: title_type of the listing
          type: string
        vdp_url:
          description: Vehicle Details Page url of the specific car
          type: string
        vin:
          description: VIN for the car
          type: string
      type: object
    BasePopular:
      description: Single popular car in array
      properties:
        city:
          description: City
          type: string
        counts:
          description: Number of sold listings of this model
          type: string
        dom_stats:
          $ref: "#/components/schemas/SalesStats"
        inventoryType:
          description: Inventory type
          type: string
        make:
          description: Make name
          type: string
        miles_stats:
          $ref: "#/components/schemas/SalesStats"
        model:
          description: Model name
          type: string
        price_stats:
          $ref: "#/components/schemas/SalesStats"
        state:
          description: State
          type: string
      type: object
    Build:
      description: Describes the Car specification
      properties:
        antibrake_sys:
          description: Antibrake system of the car
          type: string
        body_subtype:
          description: Body subtype of the car
          type: string
        body_type:
          description: Body type of the car
          type: string
        city_miles:
          description: City miles of the car
          type: string
        city_mpg:
          description: City Mileage in MPG
          type: integer
        cylinders:
          description: No of cylinders of the car
          type: integer
        doors:
          description: No of doors of the car
          type: integer
        drivetrain:
          description: Drivetrain of the car
          type: string
        engine:
          description: Engine of the car
          type: string
        engine_aspiration:
          description: Engine aspiration of the car
          type: string
        engine_block:
          description: Engine block of the car
          type: string
        engine_measure:
          description: Engine block of the car
          type: string
        engine_size:
          description: Engine size of the car
          format: double
          type: number
        fuel_type:
          description: Fuel type of the car
          type: string
        highway_miles:
          description: Highway miles of the car
          type: string
        highway_mpg:
          description: Highway Mileage in MPG
          type: integer
        made_in:
          description: Made in of the car
          type: string
        make:
          description: Car Make
          type: string
        model:
          description: Car model
          type: string
        opt_seating:
          description: opt seating of the car
          type: string
        overall_height:
          description: Overall height of the car
          type: string
        overall_length:
          description: Overall length of the car
          type: string
        overall_width:
          description: Overall width of the car
          type: string
        powertrain_type:
          description: powertrain_type of the car
          type: string
        short_trim:
          description: Short trim of the car
          type: string
        std_seating:
          description: Std seating of the car
          type: string
        steering_type:
          description: Steering type of the car
          type: string
        tank_size:
          description: Tank size of the car
          type: string
        transmission:
          description: Transmission of the car
          type: string
        trim:
          description: Trim of the car
          type: string
        trim_r:
          description: Trim_r of the car
          type: string
        vehicle_type:
          description: Vehicle type of the car
          type: string
        year:
          description: Year of the Car
          type: integer
      type: object
    CRMResponse:
      properties:
        for_sale:
          description: Boolean to indicate whether given vin has had listing after given date or not
          type: string
      type: object
    CacheImageResponse:
      description: Cached JPEG image
      format: binary
      type: string
    CarListingRank:
      description: Ranking query response
      properties:
        ranked_listing:
          items:
            $ref: "#/components/schemas/Listing"
          type: object
      type: object
    CarLocation:
      properties:
        city:
          description: City of the car
          type: string
        county:
          description: County of the car
          type: string
        latitude:
          description: Latitude component of car location
          type: string
        longitude:
          description: Longitude component of car location
          type: string
        seller_name:
          description: Seller name of the car
          type: string
        street:
          description: Street address of the car
          type: string
        zip:
          description: Zip/Postal code of the car
          type: string
      type: object
    CarRankCriteria:
      description: Ranking query request
      properties:
        carfax_1_owner:
          default: 0.9
          description: Flag to indicate whether listing is carfax_1_owner.Weight for this is ranking process between 0-1.
          type: number
        carfax_clean_title:
          default: 0.9
          description: Flag to indicate whether listing is carfax_clean_title.Weight for this is ranking process between 0-1
          type: number
        dom:
          default: 0.9
          description: Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car.Weight for this is ranking process between 0-1
          type: number
        dom_180:
          default: 0.9
          description: Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car.Weight for this is ranking process between 0-1
          type: number
        dom_active:
          default: 0.9
          description: Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car.Weight for this is ranking process between 0-1
          type: number
        is_certified:
          default: 1
          description: Certified car.Weight for this is ranking process between 0-1
          type: number
        miles:
          default: 0.9
          description: Odometer reading / reported miles usage for the car.Weight for this is ranking process between 0-1
          type: number
        price:
          default: 0.9
          description: Asking price for the vehicle. Weight for this is ranking process between 0-1.
          type: number
      type: object
    CarRankRequest:
      description: Ranking query request
      properties:
        listing_ids:
          items:
            description: MC active listing id
            type: string
          type: array
        ranking_criteria:
          items:
            $ref: "#/components/schemas/CarRankCriteria"
          type: object
      type: object
    CarRankResponse:
      description: Ranking query response
      properties:
        num_ranked:
          description: The number of listings ranked
          type: integer
        ranked_listings:
          items:
            $ref: "#/components/schemas/CarListingRank"
          type: array
      type: object
    CarSearchFacets:
      properties:
        base_exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        base_interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        body_subtype:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        body_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        carfax_1_owner:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        carfax_clean_title:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        cylinders:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        data_source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_id:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        doors:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        drivetrain:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine_aspiration:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine_block:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine_size:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fuel_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        make:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        model:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name_o:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        state:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        transmission:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        trim:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        trim_o:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        trim_r:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        vehicle_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        year:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
      type: object
    CarSearchRangeFacets:
      properties:
        dom:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        dom_180:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        dom_active:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        finance_down_payment:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        finance_emp:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        finance_loan_apr:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        finance_loan_term:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        lease_down_payment:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        lease_emp:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        lease_term:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        miles:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        msrp:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        price:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
      type: object
    CarSearchStats:
      properties:
        dom:
          $ref: "#/components/schemas/StatsItem"
        dom_180:
          $ref: "#/components/schemas/StatsItem"
        dom_active:
          $ref: "#/components/schemas/StatsItem"
        finance_down_payment:
          $ref: "#/components/schemas/StatsItem"
        finance_down_payment_per:
          $ref: "#/components/schemas/StatsItem"
        finance_emp:
          $ref: "#/components/schemas/StatsItem"
        finance_loan_apr:
          $ref: "#/components/schemas/StatsItem"
        finance_loan_term:
          $ref: "#/components/schemas/StatsItem"
        lease_down_payment:
          $ref: "#/components/schemas/StatsItem"
        lease_emp:
          $ref: "#/components/schemas/StatsItem"
        lease_term:
          $ref: "#/components/schemas/StatsItem"
        miles:
          $ref: "#/components/schemas/StatsItem"
        msrp:
          $ref: "#/components/schemas/StatsItem"
        price:
          $ref: "#/components/schemas/StatsItem"
      type: object
    ClientFiltersRequest:
      description: A client filters request
      properties:
        list:
          items:
            description: List of string values for given field
            type: string
          type: array
      required:
        - list
      type: object
    ComparisonPoint:
      properties:
        dealer_indicator:
          description: Deal Indicator
          type: string
        fair_deal_price:
          description: Fair Deal Price
          type: number
        similar_vehicles_count:
          description: Similar Vehicles Count
          type: number
        vin_price:
          description: Price for Vin
          type: number
      type: object
    CompetitorsCarDetails:
      properties:
        avg_market_value:
          description: Estimated market value
          type: string
        miles:
          description: mileage of car
          type: string
        name:
          description: Current car name
          type: string
        price:
          description: price of car
          type: string
      type: object
    CompetitorsPoint:
      properties:
        current_car:
          $ref: "#/components/schemas/CompetitorsCarDetails"
        same_car_models:
          items:
            $ref: "#/components/schemas/CompetitorsSameCars"
          type: array
        similar_car_models:
          items:
            $ref: "#/components/schemas/CompetitorsSimilarCars"
          type: array
      type: object
    CompetitorsSameCars:
      properties:
        avg_market_value:
          description: Estimated market value of year make model combination
          type: number
        avg_miles:
          description: Mileage of year make model combination
          type: number
        avg_price:
          description: Price of year make model combination
          type: number
        name:
          description: ymm_comb_name
          type: string
      type: object
    CompetitorsSimilarCars:
      properties:
        avg_market_value:
          description: Average market value of year make model combination
          type: number
        avg_miles:
          description: Average mileage of year make model combination
          type: number
        avg_price:
          description: Average price of year make model combination
          type: number
        name:
          description: ymm_comb_name
          type: string
      type: object
    DailyStats:
      properties:
        dom:
          $ref: "#/components/schemas/DailyStatsNestedJson"
        miles_stats:
          $ref: "#/components/schemas/DailyStatsNestedJson"
        price_stats:
          $ref: "#/components/schemas/DailyStatsNestedJson"
        units_for_sale:
          description: Number of units of this car for sale on the market
          type: number
      type: object
    DailyStatsNestedJson:
      description: All nested JSON of stats
      properties:
        interquartile_range:
          description: Interquartile range
          type: number
        mean:
          description: Mean
          type: number
        median:
          description: Median
          type: number
        population_standard_deviation:
          description: population standard deviation
          type: number
        standard_deviation:
          description: Standard Deviation
          type: number
        trimmed_mean:
          description: Trimmed Mean
          type: number
        variance:
          description: variance
          type: number
      type: object
    Dealer:
      properties:
        city:
          description: City of the dealer
          type: string
        country:
          description: country of the dealer
          type: string
        data_source:
          description: Datasource of the dealer
          type: string
        dealer_type:
          description: Type of dealer (franchise/independent)
          type: string
        dealership_group_name:
          description: Dealership group name of dealer
          type: string
        distance:
          description: Distance of dealer from given location
          format: double
          type: number
        id:
          description: The unique id associated with the dealer in the Marketcheck database
          type: string
        inventory_url:
          description: Website of the dealer
          type: string
        latitude:
          description: Latutide for the dealer location
          type: string
        listing_count:
          description: Listing count of the dealer
          type: integer
        location_ll:
          description: location_ll for the dealer location
          type: string
        longitude:
          description: Longitude for the dealer location
          type: string
        seller_email:
          description: Contact email of the dealer
          type: string
        seller_name:
          description: Name of the dealer
          type: string
        seller_phone:
          description: Contact no of the dealer
          type: string
        state:
          description: State of the dealer
          type: string
        status:
          description: Status of the dealer
          type: string
        street:
          description: Street of the dealer
          type: string
        zip:
          description: Zip of the dealer
          type: string
      type: object
    DealerLandingPage:
      description: Describes the dealer landing page (SRP) HTML object
      properties:
        crawled_at:
          description: The timestamp indicating the time when the SRP was cached
          type: number
        html:
          description: The HTML string for the listing web page
          type: string
        srp_url:
          description: The URL of the SRP
          type: string
      type: object
    DealerRating:
      properties:
        city:
          description: City of the dealer
          type: string
        latitude:
          description: Latutide for the dealer location
          type: string
        longitude:
          description: Longitude for the dealer location
          type: string
        name:
          description: Name of the dealer
          type: string
        overall_rating:
          description: Overall rating of the dealership on scale 1-5
          type: number
        rating_components:
          items:
            $ref: "#/components/schemas/RatingComponents"
          type: array
        state:
          description: State of the dealer
          type: string
        street:
          description: Street of the dealer
          type: string
        zip:
          description: Zip of the dealer
          type: string
      type: object
    DealerReview:
      properties:
        city:
          description: City of the dealer
          type: string
        latitude:
          description: Latutide for the dealer location
          type: string
        longitude:
          description: Longitude for the dealer location
          type: string
        name:
          description: Name of the dealer
          type: string
        overall_reviews:
          description: Overall reviews of the dealership
          type: number
        review_components:
          items:
            $ref: "#/components/schemas/ReviewComponents"
          type: array
        state:
          description: State of the dealer
          type: string
        street:
          description: Street of the dealer
          type: string
        zip:
          description: Zip of the dealer
          type: string
      type: object
    DealersResponse:
      description: Dealers Response
      properties:
        dealers:
          items:
            $ref: "#/components/schemas/Dealer"
          type: array
        num_found:
          description: number of dealers found
          type: integer
      type: object
    DepreciationPoint:
      properties:
        similar_models:
          items:
            $ref: "#/components/schemas/DepreciationStats"
          type: array
      type: object
    DepreciationStats:
      properties:
        current_value:
          description: Price of year make model combination
          type: number
        five_year_from_now:
          description: price after five year from now
          type: number
        five_year_from_now_percent:
          description: price depreciation percent after five year from now
          type: number
        name:
          description: ymm_comb_name
          type: string
        one_year_from_now:
          description: price after one year from now
          type: number
        one_year_from_now_percent:
          description: price depreciation percent after one year from now
          type: number
        two_year_from_now:
          description: price after two year from now
          type: number
        two_year_from_now_percent:
          description: price depreciation percent after two year from now
          type: number
      type: object
    Economy:
      properties:
        ghg_emissions_indicator:
          description: Contains text like bad|Good|Very Good| Excellent
          type: string
        ghg_emissions_rating:
          description: Show vehicle impact on climate change in terms of greeenhouse gases. This rating will be in the range of 1 - 10
          type: number
        smog_indicator:
          description: Contains text like bad|Good|Very Good| Excellent
          type: string
        smog_rating:
          description: Shows vehicle's emissions of pollutants known to cause smog and other forms of air pollution. This rating will be in the range of 1 - 10
          type: number
      type: object
    Error:
      properties:
        code:
          description: Error code
          type: integer
        message:
          description: Error message
          type: string
      type: object
    FacetItem:
      properties:
        count:
          description: Facet item count
          type: integer
        item:
          description: Facet item
          type: string
      type: object
    FareValue:
      description: Fare value of a car
      example:
        avg_days_to_sold_local: 32
        avg_days_to_sold_national: 42
        fmv_local: 13854
        fmv_national: 13915
      properties:
        avg_days_to_sold_local:
          description: Average days to sold of car around given postal code & radius
          type: integer
        avg_days_to_sold_national:
          description: Average days to sold of car for all available listings
          type: integer
        fmv_local:
          description: Fare value calculated for all available listing around given postal code & radius
          type: integer
        fmv_national:
          description: Fare value calculated for all available listing
          type: integer
      type: object
    FuelEfficiency:
      properties:
        annual_miles:
          description: Annual Miles of Car
          type: number
        city_mileage:
          description: City Mileage in MPG
          type: string
        combined_mileage:
          description: Combined Mileage
          type: string
        highway_mileage:
          description: Highway Mileage in MPG
          type: string
        monthly_fuel_expense:
          description: Monthly fuel expense
          type: number
      type: object
    GetClientFiltersResponse:
      description: A client filters response
      properties:
        list:
          description: Description of operation
          type: string
        status:
          description: status code of operation
          type: integer
      type: object
    HeavyEquipmentsBaseListing:
      description: Base heavy equipment listing
      properties:
        build:
          $ref: "#/components/schemas/HeavyEquipmentsBuild"
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dist:
          description: Distance of the quipments's location from the specified user lcoation
          format: double
          type: number
        dp_url:
          description: Details Page url of the specific heavy equipment
          type: string
        exterior_color:
          description: Exterior color of the heavy equipment
          type: string
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the heavy equipment
          type: string
        inventory_type:
          description: Inventory type of heavy equipment
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the heavy equipment
          type: integer
        msrp:
          description: MSRP for the heavy equipment
          type: integer
        price:
          description: Asking price for the heavy equipment
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the heavy equipment
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of heavy equipment in dealers inventory
          type: string
        vin:
          description: VIN for the heavy equipment
          type: string
      type: object
    HeavyEquipmentsBuild:
      description: Describes the Heavy Equipments specification
      properties:
        body_type:
          description: Body type of the heavy equipment
          type: string
        category:
          description: Heavy equipment category
          type: string
        condition:
          description: Heavy equipment condition
          type: string
        drivetrain:
          description: Drivetrain of the heavy equipment
          type: string
        engine:
          description: Engine of the heavy equipment
          type: string
        fuel_type:
          description: Fuel type of the heavy equipment
          type: string
        make:
          description: Heavy equipment Make
          type: string
        model:
          description: Heavy equipment model
          type: string
        sub_category:
          description: Heavy equipment sub_category
          type: string
        transmission:
          description: Transmission of the heavy equipment
          type: string
        trim:
          description: Trim of the heavy equipment
          type: string
        year:
          description: Year of the heavy equipment
          type: integer
      type: object
    HeavyEquipmentsListing:
      description: Represents a full list of attributes available with Marketcheck for a car
      properties:
        build:
          $ref: "#/components/schemas/RVBuild"
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dp_url:
          description: Details Page url of the specific heavy equipment
          type: string
        exterior_color:
          description: Exterior color of the heavy equipment
          type: string
        extra:
          $ref: "#/components/schemas/ListingNestExtraAttributes"
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the heavy equipment
          type: string
        inventory_type:
          description: Inventory type of heavy equipment
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the heavy equipment
          type: integer
        msrp:
          description: MSRP for the heavy equipment
          type: integer
        price:
          description: Asking price for the heavy equipment
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the heavy equipment
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of heavy equipment in dealers inventory
          type: string
        vin:
          description: VIN for the heavy equipment
          type: string
      type: object
    HeavyEquipmentsSearchFacets:
      properties:
        body_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        category:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        cylinders:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_id:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        drivetrain:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fuel_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        inventory_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        make:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        model:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        state:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        sub_category:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        transmission:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        trim:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        year:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
      type: object
    HeavyEquipmentsSearchRangeFacets:
      properties:
        hours_used:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        miles:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        price:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
      type: object
    HeavyEquipmentsSearchResponse:
      description: Heavy Equipments search query response
      properties:
        facets:
          items:
            $ref: "#/components/schemas/HeavyEquipmentsSearchFacets"
          type: object
        listings:
          items:
            $ref: "#/components/schemas/HeavyEquipmentsBaseListing"
          type: array
        num_found:
          description: The number of listings found
          type: integer
        range_facets:
          items:
            $ref: "#/components/schemas/HeavyEquipmentsSearchRangeFacets"
          type: object
        stats:
          items:
            $ref: "#/components/schemas/HeavyEquipmentsSearchStats"
          type: object
      type: object
    HeavyEquipmentsSearchStats:
      properties:
        hours_used:
          $ref: "#/components/schemas/StatsItem"
        miles:
          $ref: "#/components/schemas/StatsItem"
        price:
          $ref: "#/components/schemas/StatsItem"
      type: object
    HistoricalListing:
      description: Represents a car history entry
      properties:
        carfax_1_owner:
          description: Flag to indicate whether listing is carfax_1_owner
          type: boolean
        carfax_clean_title:
          description: Flag to indicate whether listing is carfax_clean_title
          type: boolean
        city:
          description: City of the listing
          type: string
        data_source:
          description: Data source of the listing
          type: string
        dealer_id:
          description: Unique MC assigned dealers id for the listing
          type: integer
        dom:
          description: Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car
          type: integer
        dom_180:
          description: Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car
          type: integer
        dom_active:
          description: Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car
          type: integer
        exterior_color:
          description: Exterior color of the car
          type: string
        financing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingFinance"
          type: array
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the car
          type: string
        inventory_type:
          description: Inventory type of car
          type: string
        is_certified:
          description: Certified car
          type: integer
        is_searchable:
          description: Flag to indicate listing is marked searchable or not
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        latitude:
          description: Latitude of the listing
          type: string
        leasing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingLease"
          type: array
        longitude:
          description: Longitude of the listing
          type: string
        miles:
          description: Odometer reading / reported miles usage for the car
          type: integer
        msrp:
          description: MSRP for the car
          type: integer
        price:
          description: Asking price for the car
          type: integer
        ref_miles:
          description: Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date
          type: string
        ref_miles_dt:
          description: The date at which the last miles was reported online. This is earlier to last_seen_date
          type: integer
        ref_price:
          description: Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date
          type: string
        ref_price_dt:
          description: The date at which the last price was reported online. This is earlier to last_seen_date
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          type: integer
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_name:
          description: Seller name of the listing from the Marketcheck database
          type: string
        seller_name_o:
          description: Seller name of the listing from the Marketcheck database
          type: string
        seller_type:
          description: Seller type for the car
          type: string
        source:
          description: Source domain of the listing
          type: string
        state:
          description: State of the listing
          type: string
        status_date:
          description: Timestamp of status date
          type: integer
        stock_no:
          description: Stock number of car in dealers inventory
          type: string
        street:
          description: Street of the listing
          type: string
        trim_r:
          description: Trim of the car
          type: string
        vdp_url:
          description: Vehicle Details Page url of the specific car
          type: string
        vin:
          description: VIN for the car
          type: string
        zip:
          description: Zip of the listing
          type: string
      type: object
    Listing:
      description: Represents a full list of attributes available with Marketcheck for a car
      properties:
        base_ext_color:
          description: Base exterior color of the car
          type: string
        base_int_color:
          description: Base interior color of the car
          type: string
        build:
          $ref: "#/components/schemas/Build"
        carfax_1_owner:
          description: Flag to indicate whether listing is carfax_1_owner
          type: boolean
        carfax_clean_title:
          description: Flag to indicate whether listing is carfax_clean_title
          type: boolean
        data_source:
          description: Data source of the listing
          type: string
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dom:
          description: Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car
          type: integer
        dom_180:
          description: Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car
          type: integer
        dom_active:
          description: Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car
          type: integer
        exterior_color:
          description: Exterior color of the car
          type: string
        extra:
          $ref: "#/components/schemas/ListingNestExtraAttributes"
        financing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingFinance"
          type: array
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        first_seen_at_mc:
          description: Listing first seen at first scraped at MC timestamp
          type: integer
        first_seen_at_mc_date:
          description: Listing first seen at first scraped at MC date
          type: string
        first_seen_at_source:
          description: Listing first seen at source relisted timestamp
          type: integer
        first_seen_at_source_date:
          description: Listing first seen at source relisted date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the car
          type: string
        inventory_type:
          description: Inventory type of car
          type: string
        is_certified:
          description: Certified car
          type: integer
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        leasing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingLease"
          type: array
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the car
          type: integer
        msrp:
          description: MSRP for the car
          type: integer
        price:
          description: Asking price for the car
          type: integer
        price_change_percent:
          description: Percentage difference between the cars's current price and ref_price i.e. last reported price
          format: double
          type: number
        rank:
          description: Relative rank of the listing determined by ranking service
          type: integer
        ref_miles:
          description: Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date
          type: string
        ref_miles_dt:
          description: The date at which the last miles was reported online. This is earlier to last_seen_date
          type: integer
        ref_price:
          description: Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date
          type: string
        ref_price_dt:
          description: The date at which the last price was reported online. This is earlier to last_seen_date
          type: integer
        score:
          description: Score of the ranked listing as per the ranking criteria determined by ranking service
          format: double
          type: number
        scraped_at:
          description: Listing last seen at date timestamp
          type: integer
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the car
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of car in dealers inventory
          type: string
        vdp_url:
          description: Vehicle Details Page url of the specific car
          type: string
        vehicle_registration_mark:
          description: " Vehicle Registration Mark of the car"
          type: string
        vin:
          description: VIN for the car
          type: string
      type: object
    ListingDebugAttributes:
      properties:
        cycle_id:
          description: Cycle id
          type: number
        robot_id:
          description: Robot id
          type: number
        scraped_at:
          description: Scraped date and time
          type: string
        taxonomy_vin:
          description: Taxonomy vin
          type: string
        template_id:
          description: Template id
          type: number
        user_id:
          description: User id
          type: number
      type: object
    ListingExtraAttributes:
      properties:
        dealer_added_f:
          description: List of dealer added features available with the car
          items:
            type: string
          type: array
        electronics_f:
          description: List of electronic features available with the car
          items:
            type: string
          type: array
        exterior_f:
          description: List of exterior features available with the car
          items:
            type: string
          type: array
        features:
          description: List of Features available with the car
          items:
            type: string
          type: array
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_f:
          description: List of interior features available with the car
          items:
            type: string
          type: array
        options:
          description: Installed Options of the car
          items:
            type: string
          type: array
        safety_f:
          description: List of safety features available with the car
          items:
            type: string
          type: array
        seller_cmts:
          description: Seller comment for the car
          type: string
        standard_f:
          description: List of standard features available with the car
          items:
            type: string
          type: array
        technical_f:
          description: List of technical features available with the car
          items:
            type: string
          type: array
      type: object
    ListingFinance:
      properties:
        down_payment:
          description: Down payment for this finance offer
          format: double
          type: number
        down_payment_percentage:
          description: down payment percentage for this finance offer
          format: double
          type: number
        estimated_monthly_payment:
          description: estimated monthly payment for this finance offer
          format: double
          type: number
        loan_apr:
          description: Loan APR for this finance offer
          format: double
          type: number
        loan_term:
          description: Loan term for this finance offer
          type: integer
      type: object
    ListingLease:
      properties:
        down_payment:
          description: Down payment for this lease offer
          format: double
          type: number
        estimated_monthly_payment:
          description: estimated monthly payment for this lease offer
          format: double
          type: number
        lease_term:
          description: Lease term for this lease offer
          format: integer
          type: integer
      type: object
    ListingMedia:
      properties:
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        photo_links:
          description: A list of photo urls for the car
          items:
            type: string
          type: array
        photo_url:
          description: Single photo url of the car
          type: string
      type: object
    ListingNestExtraAttributes:
      properties:
        dealer_added_f:
          description: List of dealer added features available with the car
          items:
            type: string
          type: array
        electronics_f:
          description: List of electronic features available with the car
          items:
            type: string
          type: array
        exterior_f:
          description: List of exterior features available with the car
          items:
            type: string
          type: array
        features:
          description: List of Features available with the car
          items:
            type: string
          type: array
        interior_f:
          description: List of interior features available with the car
          items:
            type: string
          type: array
        options:
          description: Installed Options of the car
          items:
            type: string
          type: array
        safety_f:
          description: List of safety features available with the car
          items:
            type: string
          type: array
        seller_comments:
          description: Seller comments for the car
          type: string
        standard_f:
          description: List of standard features available with the car
          items:
            type: string
          type: array
        technical_f:
          description: List of technical features available with the car
          items:
            type: string
          type: array
      type: object
    ListingNestMedia:
      properties:
        photo_links:
          description: A list of photo urls for the car
          items:
            type: string
          type: array
        photo_links_cached:
          description: A list of cached photo urls for the car
          items:
            type: string
          type: array
      type: object
    ListingVDP:
      description: Describes the VDP (Vehicle Details Page) HTML object
      properties:
        crawled_at:
          description: The timestamp indicating the time when the VDP was cached
          type: number
        html:
          description: The HTML string for the listing web page
          type: string
        vdp_url:
          description: The URL of the VDP
          type: string
      type: object
    Location:
      description: Represents a location
      properties:
        city:
          description: City of the listing
          type: string
        latitude:
          description: Latitude component of the location
          format: double
          type: number
        longitude:
          description: Longitude component of the location
          format: double
          type: number
        state:
          description: State of the listing
          type: string
        zip:
          description: Zip of the listing
          type: string
      type: object
    MakeModel:
      properties:
        make:
          type: string
        model:
          type: string
      type: object
    Mds:
      description: Describes Market days supply results for year make model trim combination
      properties:
        make:
          description: Make of vin provided
          type: string
        mds:
          description: Provides Market days supply count
          type: integer
        model:
          description: Model of vin provided
          type: string
        sold_vins:
          description: Sold vins array
          items:
            description: Sold vins array
            type: string
          type: array
        total_active_cars_for_ymmt:
          description: Active cars for ymmt combination
          type: integer
        total_cars_sold_in_last_45_days:
          description: Cars sold in last 45 days
          type: integer
        trim:
          description: Trim of vin provided
          type: string
        year:
          description: Year of vin provided
          type: integer
      type: object
    MotorcycleBaseListing:
      description: Base motorcycle listing
      properties:
        build:
          $ref: "#/components/schemas/MotorcycleBuild"
        color:
          description: Color of the motorcycle
          type: string
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dist:
          description: Distance of the motorcycle's location from the specified user lcoation
          format: double
          type: number
        dp_url:
          description: Details Page url of the specific motorcycle
          type: string
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        inventory_type:
          description: Inventory type of motorcycle
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the motorcycle
          type: integer
        msrp:
          description: MSRP for the motorcycle
          type: integer
        price:
          description: Asking price for the motorcycle
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the motorcycle
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of motorcycle in dealers inventory
          type: string
        vin:
          description: VIN for the Motorcycle
          type: string
      type: object
    MotorcycleBuild:
      description: Describes the Motorcycle specification
      properties:
        body_type:
          description: Body type of the motorcycle
          type: string
        cylinders:
          description: No of cylinders of the motorcycle
          type: integer
        drivetrain:
          description: Drivetrain of the motorcycle
          type: string
        dry_weight:
          description: Dry weight of motorcycle
          type: string
        engine:
          description: Engine of the motorcycle
          type: string
        fuel_type:
          description: Fuel type of the motorcycle
          type: string
        made_in:
          description: Made in of the motorcycle
          type: string
        make:
          description: Motorcycle Make
          type: string
        model:
          description: Motorcycle model
          type: string
        transmission:
          description: Transmission of the motorcycle
          type: string
        trim:
          description: Trim of the motorcycle
          type: string
        vehicle_type:
          description: Vehicle type of the motorcycle
          type: string
        year:
          description: Year of the motorcycle
          type: integer
      type: object
    MotorcycleListing:
      description: Represents a full list of attributes available with Marketcheck for a car
      properties:
        build:
          $ref: "#/components/schemas/MotorcycleBuild"
        color:
          description: Color of the motorcycle
          type: string
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dp_url:
          description: Details Page url of the specific motorcycle
          type: string
        extra:
          $ref: "#/components/schemas/ListingNestExtraAttributes"
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        inventory_type:
          description: Inventory type of motorcycle
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the motorcycle
          type: integer
        msrp:
          description: MSRP for the motorcycle
          type: integer
        price:
          description: Asking price for the motorcycle
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the motorcycle
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of motorcycle in dealers inventory
          type: string
        vin:
          description: VIN for the Motorcycle
          type: string
      type: object
    MotorcycleSearchFacets:
      properties:
        body_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        cylinders:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_id:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        drivetrain:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fuel_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        inventory_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        make:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        model:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        state:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        transmission:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        trim:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        vehicle_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        year:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
      type: object
    MotorcycleSearchRangeFacets:
      properties:
        miles:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        price:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
      type: object
    MotorcycleSearchResponse:
      description: Motorcycle search query response
      properties:
        facets:
          items:
            $ref: "#/components/schemas/MotorcycleSearchFacets"
          type: object
        listings:
          items:
            $ref: "#/components/schemas/MotorcycleBaseListing"
          type: array
        num_found:
          description: The number of listings found
          type: integer
        range_facets:
          items:
            $ref: "#/components/schemas/MotorcycleSearchRangeFacets"
          type: object
        stats:
          items:
            $ref: "#/components/schemas/MotorcycleSearchStats"
          type: object
      type: object
    MotorcycleSearchStats:
      properties:
        miles:
          $ref: "#/components/schemas/StatsItem"
        price:
          $ref: "#/components/schemas/StatsItem"
      type: object
    NeoVIN:
      description: Describes the NeoVIN specification
      properties:
        available_options_details:
          description: Listing of all options and packages with detailed equipment identified that could have been installed on the vehicle
          type: object
        body_subtype:
          description: Body subtype (cab) of the vehicle
          type: string
        body_type:
          description: Body type of the vehicle
          type: string
        city_mpg:
          description: City miles per gallon
          format: double
          type: number
        combined_msrp:
          description: Calculated combination of base MSRP with the delivery charges and the installed options MSRP
          format: double
          type: number
        created_at:
          description: vin first decoded at timestamp
          type: integer
        created_at_date:
          description: vin first decoded at date
          type: string
        decode_version:
          description: This will represent if previous vin decode values are updated
          type: integer
        delivery_charges:
          description: Manufacturer defined delivery charges
          format: double
          type: number
        doors:
          description: Number of doors on the vehicle
          type: integer
        drivetrain:
          description: Identified drivetrain of the vehicle
          type: string
        engine:
          description: Base identification of the number of cylinders and configuration of the installed engine on the vehicle
          type: string
        exterior_color:
          description: The manufacturer defined option code and name for the exterior color of the vehicle
          type: object
        features:
          description: Normalized feature set of equipment identified that have been identified as installed on the vehicle, including whether that item was standard to the version of the vehicle or was added as an installed option
          type: object
        fuel_type:
          description: Identified Fuel type of the vehicle
          type: string
        height:
          description: Overall height of the vehicle (in)
          format: double
          type: number
        highway_mpg:
          description: Highway miles per gallon
          format: double
          type: number
        installed_equipment:
          description: Detailed equipment identified as installed on the vehicle, including whether that item was standard to the version of the vehicle or was added as an installed option
          type: object
        installed_options_details:
          description: Listing of all options and packages with detailed equipment identified that have been identified as installed on the vehicle
          type: object
        installed_options_msrp:
          description: Calculated combination of the MSRP for the installed options and packages
          format: double
          type: number
        interior_color:
          description: The manufacturer defined option code and name for the interior color of the vehicle
          type: object
        length:
          description: Overall length of the vehicle (in)
          format: double
          type: number
        listing_confidence:
          description: Identification of primary source data used for trim and installed colors and options
          type: string
        make:
          description: Make of the vehicle
          type: string
        manufacturer_code:
          description: Manufacturer code of the vehicle
          type: string
        model:
          description: Model of the vehicle
          type: string
        msrp:
          description: Base MSRP as defined for the defined version of that vehicle with no options installed
          format: double
          type: number
        options_packages:
          description: Option and package codes installed on the vehicle
          type: string
        package_code:
          description: Extracted manufacturer package code related to selection of the vehicle version (where available / applicable)
          type: string
        package_description:
          description: Extracted manufacturer package code description (where available / applicable)
          type: string
        seating_capacity:
          description: Identified seating capacity of the vehicle
          format: double
          type: number
        squish_vin:
          description: Vin prefix identification used in the decoding of the vehicle
          type: string
        transmission:
          description: Identified installed Transmission of the vehicle
          type: string
        transmission_confidence:
          description: Identification of confidence related to the selection of the installed transmission
          type: string
        transmission_description:
          description: The description of the installed transmission
          type: string
        trim:
          description: Trim of the vehicle
          type: string
        trim_confidence:
          description: Identification of confidence related to the selection of the trim
          type: string
        updated_at:
          description: vin last decoded at timestamp
          type: integer
        updated_at_date:
          description: vin last decoded at date
          type: string
        version:
          description: Version Name of the vehicle
          type: string
        version_confidence:
          description: Identification of confidence related to the selection of the vehicle version
          type: string
        vin:
          description: 17 char long VIN of the vehicle
          type: string
        weight:
          description: Gross vehicle weight (lbs)
          format: double
          type: number
        width:
          description: Overall width of the vehicle (in)
          format: double
          type: number
        year:
          description: Model Year of the vehicle
          type: integer
      type: object
    NestDealer:
      properties:
        city:
          description: City of the dealer
          type: string
        country:
          description: country of the dealer
          type: string
        county:
          description: county of the dealer
          type: string
        dealer_type:
          description: Type of dealer (franchise/independent)
          type: string
        dealership_group_name:
          description: dealership_group_name of dealer
          type: string
        id:
          description: The unique id associated with the dealer in the Marketcheck database
          type: integer
        latitude:
          description: Latutide for the dealer location
          type: string
        longitude:
          description: Longitude for the dealer location
          type: string
        msa_code:
          description: msa_code of the dealer
          type: string
        name:
          description: Name of the dealer
          type: string
        phone:
          description: Contact no of the dealer
          type: string
        seller_email:
          description: Contact email of the dealer
          type: string
        state:
          description: State of the dealer
          type: string
        street:
          description: Street of the dealer
          type: string
        website:
          description: Website of the dealer
          type: string
        zip:
          description: Zip of the dealer
          type: string
      type: object
    PlotPoint:
      properties:
        dom:
          description: DOM
          type: number
        id:
          description: Listing id
          type: string
        miles:
          description: Miles
          type: number
        msrp:
          description: Msrp
          type: number
        price:
          description: Price
          type: number
        seller_name:
          description: Seller name
          type: string
        vin:
          description: Vin
          type: string
      type: object
    PopularCars:
      description: Top 50 popular cars
      properties:
        new_top50:
          description: Array of all new top 50 cars
          items:
            $ref: "#/components/schemas/BasePopular"
          type: array
        used_top50:
          description: Array of all used top 50 cars
          items:
            $ref: "#/components/schemas/BasePopular"
          type: array
      type: object
    PopularityItem:
      properties:
        color:
          description: Color depending upon left and right analysis numbers
          type: string
        delta_percent:
          description: Delta percent
          type: number
        difference:
          description: Difference depending upon left and right analysis
          type: number
        left:
          description: Left side rating for above description (2016 ford F-150 Lariat)
          type: number
        right:
          description: Right side rating for above description (All Other Cars)
          type: number
        text:
          description: "Description for which popularity should be show eg: 2016 ford F-150 Lariat vs All Other Cars"
          type: string
        thumbs:
          description: Thumbs up/down depending upon left and right analysis numbers
          type: string
      type: object
    PredictedSpecs:
      description: Specs of predicted vehicle
      example:
        base_exterior_color: Black
        base_interior_color: Brown
        carfax_1_owner: false
        carfax_clean_title: false
        city_mpg: 18
        cylinders: 6
        doors: 4
        drivetrain: 4WD
        engine_block: V
        engine_size: 2.7
        highway_mpg: 23
        is_certified: false
        latitude: 44.71164
        longitude: -92.851607
        make: ford
        miles: 28741
        model: f-150
        transmission: Automatic
        trim: xlt
        year: 2018
      properties:
        base_exterior_color:
          description: Base exterior color of vehicle
          type: string
        base_interior_color:
          description: base interior color of vehicle
          type: string
        carfax_1_owner:
          description: Indicates whether car has had only one owner or not
          type: boolean
        carfax_clean_title:
          description: Indicates whether car has clean ownership records
          type: boolean
        city_mpg:
          description: City mileage
          format: double
          type: number
        cylinders:
          description: Number of cylinders
          type: integer
        doors:
          description: Number of doors
          type: integer
        drivetrain:
          description: Drivetrain of the vehicle
          type: string
        engine_block:
          description: Engine block of the vehicle
          type: string
        engine_size:
          description: Engine size
          format: double
          type: number
        highway_mpg:
          description: Highway mileage
          format: double
          type: number
        is_certified:
          description: Certified vehicle
          type: boolean
        latitude:
          description: Latutide for the vehicle location
          format: double
          type: number
        longitude:
          description: Longitude for the vehicle location
          format: double
          type: number
        make:
          description: make
          type: string
        miles:
          description: Miles
          type: integer
        model:
          description: model
          type: string
        transmission:
          description: transmission
          type: string
        trim:
          description: trim
          type: string
        year:
          description: year
          type: integer
      type: object
    PricePrediction:
      description: Predicted price of a car
      example:
        predicted_price: 37998
        price_range:
          lower_bound: 32913
          upper_bound: 44358
        specs:
          base_exterior_color: Black
          base_interior_color: Brown
          carfax_1_owner: false
          carfax_clean_title: false
          city_mpg: 18
          cylinders: 6
          doors: 4
          drivetrain: 4WD
          engine_block: V
          engine_size: 2.7
          highway_mpg: 23
          is_certified: false
          latitude: 44.71164
          longitude: -92.851607
          make: ford
          miles: 28741
          model: f-150
          transmission: Automatic
          trim: xlt
          year: 2018
      properties:
        predicted_price:
          description: Actual predicted price of a car
          type: integer
        price_range:
          description: Price range around the predicted price, estimating the error in predicted price
          properties:
            lower_bound:
              description: Lower bound
              type: integer
            upper_bound:
              description: Upper bound
              type: integer
          type: object
        specs:
          $ref: "#/components/schemas/PredictedSpecs"
      type: object
    RVBaseListing:
      description: Base RV listing
      properties:
        build:
          $ref: "#/components/schemas/RVBuild"
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dist:
          description: Distance of the RV's location from the specified user lcoation
          format: double
          type: number
        dp_url:
          description: Details Page url of the specific RV
          type: string
        exterior_color:
          description: Exterior color of the RV
          type: string
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the RV
          type: string
        inventory_type:
          description: Inventory type of RV
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the RV
          type: integer
        msrp:
          description: MSRP for the RV
          type: integer
        price:
          description: Asking price for the RV
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the RV
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of RV in dealers inventory
          type: string
        vin:
          description: VIN for the RV
          type: string
      type: object
    RVBuild:
      description: Describes the RV specification
      properties:
        area:
          description: Area of the RV
          type: string
        class:
          description: Class of the RV
          type: string
        engine:
          description: Engine of the RV
          type: string
        fuel_type:
          description: Fuel type of the RV
          type: string
        gvwr:
          description: Gross Vehicle Weight Ratio of RV
          type: string
        length:
          description: Length of the RV
          type: string
        made_in:
          description: Made in of the RV
          type: string
        make:
          description: RV Make
          type: string
        model:
          description: RV model
          type: string
        sleeps:
          description: Sleeps of the RV
          type: string
        slideouts:
          description: Slideouts of the RV
          type: string
        transmission:
          description: Transmission of the RV
          type: string
        year:
          description: Year of the RV
          type: integer
      type: object
    RVListing:
      description: Represents a full list of attributes available with Marketcheck for a car
      properties:
        build:
          $ref: "#/components/schemas/RVBuild"
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dp_url:
          description: Details Page url of the specific RV
          type: string
        exterior_color:
          description: Exterior color of the RV
          type: string
        extra:
          $ref: "#/components/schemas/ListingNestExtraAttributes"
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the RV
          type: string
        inventory_type:
          description: Inventory type of RV
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the RV
          type: integer
        msrp:
          description: MSRP for the RV
          type: integer
        price:
          description: Asking price for the RV
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the RV
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of RV in dealers inventory
          type: string
        vin:
          description: VIN for the RV
          type: string
      type: object
    RVSearchFacets:
      properties:
        area:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        awnings:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        class:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_id:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fuel_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        inventory_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        length:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        make:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        model:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        sleeps:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        slideouts:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        state:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        transmission:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        year:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
      type: object
    RVSearchResponse:
      description: RV search query response
      properties:
        facets:
          items:
            $ref: "#/components/schemas/RVSearchFacets"
          type: object
        listings:
          items:
            $ref: "#/components/schemas/RVBaseListing"
          type: array
        num_found:
          description: The number of listings found
          type: integer
        range_facets:
          items:
            $ref: "#/components/schemas/MotorcycleSearchRangeFacets"
          type: object
        stats:
          items:
            $ref: "#/components/schemas/MotorcycleSearchStats"
          type: object
      type: object
    RangeFacetItem:
      properties:
        after:
          description: Number of listings that have field value after range end
          type: integer
        before:
          description: Number of listings that have field value before range start
          type: integer
        between:
          description: Number of listings that have field value between range start and range end
          type: integer
        counts:
          items:
            properties:
              count:
                type: integer
              lower_bound:
                type: integer
              upper_bound:
                type: integer
            type: object
          type: array
        end:
          description: The end of range
          type: integer
        gap:
          description: The range gap applied for range faceting
          type: integer
        start:
          description: The start of range
          type: integer
      type: object
    RatingComponents:
      properties:
        actual_rating:
          description: rating of car on that condition
          type: number
        rating_condition:
          description: Specifices rating condition parameter
          type: string
      type: object
    ReviewComponents:
      properties:
        actual_review:
          description: review of car given by current user
          type: string
        user_name:
          description: Name of user who has given review
          type: string
        user_rating:
          description: rating for dealer given by user ranging from 1-5
          type: number
      type: object
    SafetyRating:
      description: Describes the Safety Ratings of current listing
      properties:
        driver_front_rating:
          description: Driver front rating of the Listing on scale 1-5
          type: number
        driver_side_rating:
          description: Driver Side rating of the Listing on scale 1-5
          type: number
        overall_rating:
          description: Overall rating of the Listing on scale 1-5
          type: number
        passenger_front_rating:
          description: Passenger front rating of the Listing on scale 1-5
          type: number
        roll_over_rating:
          description: Roll Over rating of the Listing on scale 1-5
          type: number
      type: object
    Sales:
      description: Sales count query response
      properties:
        city:
          description: City
          type: string
        counts:
          description: Sales count
          type: integer
        cpo:
          description: cpo sales count
          type: integer
        dom_stats:
          $ref: "#/components/schemas/SalesStats"
        inventory_type:
          description: inventory_type
          type: string
        make:
          description: Make
          type: string
        miles_stats:
          $ref: "#/components/schemas/SalesStats"
        model:
          description: model
          type: string
        non-cpo:
          description: Non-cpo sales count
          type: integer
        price_stats:
          $ref: "#/components/schemas/SalesStats"
        state:
          description: State
          type: string
        taxonomy_vin:
          description: taxonomy_vin
          type: string
        trim:
          description: trim
          type: string
        year:
          description: year
          type: string
      type: object
    SalesStats:
      description: Sales stats response
      properties:
        absolute_mean_deviation:
          description: absolute_mean_deviation
          type: number
        iqr:
          description: iqr
          type: number
        mean:
          description: mean
          type: number
        median:
          description: median
          type: number
        population_standard_deviation:
          description: population_standard_deviation
          type: number
        standard_deviation:
          description: standard_deviation
          type: number
        trimmed_mean:
          description: trimmed_mean
          type: number
        variance:
          description: variance
          type: number
        weighted_mean:
          description: weighted_mean
          type: number
      type: object
    SearchAutoCompleteResponse:
      description: Search auto complete query response
      properties:
        terms:
          items:
            properties:
              count:
                description: The number of listings with item as value for given field
                type: integer
              item:
                description: The actual term that either has prefix or contains given input
                type: string
            type: object
          type: array
      type: object
    SearchResponse:
      description: Search query response
      properties:
        facets:
          $ref: "#/components/schemas/CarSearchFacets"
        listings:
          items:
            $ref: "#/components/schemas/BaseListing"
          type: array
        num_found:
          description: The number of listings found
          type: integer
        range_facets:
          $ref: "#/components/schemas/CarSearchRangeFacets"
        stats:
          $ref: "#/components/schemas/CarSearchStats"
      type: object
    SetClientFiltersResponse:
      description: A client filters response
      properties:
        message:
          description: Description of operation
          type: string
        status:
          description: status code of operation
          type: integer
      type: object
    SpecsAutoCompleteResponse:
      description: Specs auto complete query response
      properties:
        terms:
          items:
            description: The actual term that either has prefix or contains given input
            type: string
          type: array
      type: object
    StatsItem:
      properties:
        count:
          description: count
          type: integer
        max:
          description: Maximum value of the field
          type: integer
        mean:
          description: Mean of the field
          type: number
        median:
          description: median of the field
          type: number
        min:
          description: Minimum value of the field
          type: integer
        missing:
          description: count of listings missing particular field
          type: integer
        stddev:
          description: stddev of the field
          type: number
        sum:
          description: Summation of all values of the field
          type: integer
        sum_of_squares:
          description: sum_of_squares of the field
          type: number
      type: object
    TrendPoint:
      properties:
        dom:
          description: Days on Market
          type: number
        miles:
          description: Miles
          type: number
        msrp:
          description: MSRP
          type: number
        price:
          description: Price
          type: number
        units:
          description: Units
          type: number
      type: object
    UKBaseListing:
      description: Minimal set of attributes describing a listing
      properties:
        base_ext_color:
          description: Base exterior color of the car
          type: string
        base_int_color:
          description: Base interior color of the car
          type: string
        build:
          $ref: "#/components/schemas/Build"
        car_location:
          $ref: "#/components/schemas/CarLocation"
        carfax_1_owner:
          description: Flag to indicate whether listing is carfax_1_owner
          type: boolean
        carfax_clean_title:
          description: Flag to indicate whether listing is carfax_clean_title
          type: boolean
        co2_emissions:
          description: CO2 emissions by car
          type: string
        data_source:
          description: Data source of the listing
          type: string
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dist:
          description: Distance of the car's location from the specified user lcoation
          format: double
          type: number
        dom:
          description: Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car
          type: integer
        dom_180:
          description: Days on Market value for the car based on current and last 6 month listings found in the Marketcheck database for this car
          type: integer
        dom_active:
          description: Days on Market value for the car based on current and last 30 days listings found in the Marketcheck database for this car
          type: integer
        exterior_color:
          description: Exterior color of the car
          type: string
        financing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingFinance"
          type: array
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        in_transit:
          description: in_transit of the listing
          type: boolean
        insurance_group:
          description: Insurance Group of car
          type: string
        interior_color:
          description: Interior color of the car
          type: string
        inventory_type:
          description: Inventory type of car
          type: string
        is_certified:
          description: Certified car
          type: integer
        is_translated:
          description: is_translated of the listing
          type: boolean
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        leasing_options:
          description: Array of all finance offers for this listing
          items:
            $ref: "#/components/schemas/ListingLease"
          type: array
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the car
          type: integer
        model_code:
          description: model_code of the listing
          type: string
        msrp:
          description: MSRP for the car
          type: integer
        num_owners:
          description: Number of owners
          type: string
        price:
          description: Asking price for the car
          type: integer
        price_change_percent:
          description: Percentage difference between the cars's current price and ref_price i.e. last reported price
          format: double
          type: number
        ref_miles:
          description: Last Odometer reading / reported miles usage for the car. If the asking miles value is not or is available then the last_miles could perhaps be used. last_miles is the miles for the car listed on the source website as of last_miles_dt date
          type: string
        ref_miles_dt:
          description: The date at which the last miles was reported online. This is earlier to last_seen_date
          type: integer
        ref_price:
          description: Last reported price for the car. If the asking price value is not or is available then the last_price could perhaps be used. last_price is the price for the car listed on the source website as of last_price_dt date
          type: string
        ref_price_dt:
          description: The date at which the last price was reported online. This is earlier to last_seen_date
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the car
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of car in dealers inventory
          type: string
        title_type:
          description: title_type of the listing
          type: string
        uvc_id:
          description: UVC ID of the car
          type: string
        vdp_url:
          description: Vehicle Details Page url of the specific car
          type: string
        vehicle_registration_mark:
          description: " Vehicle Registration Mark of the car"
          type: string
      type: object
    UKCarSearchFacets:
      properties:
        base_exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        base_interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        body_subtype:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        body_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_location_city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_location_county:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_location_seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_location_street:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_location_zip:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        car_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        carfax_1_owner:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        carfax_clean_title:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        co2_emissions:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        cylinders:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        data_source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_id:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealership_group_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        doors:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        drivetrain:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine_aspiration:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine_block:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine_size:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fca_status:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fuel_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        in_transit:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        insurance_group:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        make:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        mas_code:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        model:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        num_owners:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        powertrain_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seating_capacity:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        state:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        transmission:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        trim:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        vehicle_registration_mark:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        vehicle_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        vrm:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        year:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
      type: object
    UKRVBaseListing:
      description: Base RV listing
      properties:
        availability_status:
          description: availability_status of the listing
          type: string
        build:
          $ref: "#/components/schemas/UKRVBuild"
        currency_indicator:
          description: currency_indicator of the listing
          type: string
        dealer:
          $ref: "#/components/schemas/NestDealer"
        dist:
          description: Distance of the RV's location from the specified user lcoation
          format: double
          type: number
        exterior_color:
          description: Exterior color of the RV
          type: string
        first_seen_at:
          description: Listing first seen at first scraped timestamp
          type: integer
        first_seen_at_date:
          description: Listing first seen at first scraped date
          type: string
        heading:
          description: Listing title as displayed on the source website
          type: string
        id:
          description: Unique identifier representing a specific listing from the Marketcheck database
          type: string
        interior_color:
          description: Interior color of the RV
          type: string
        inventory_type:
          description: Inventory type of RV
          type: string
        last_seen_at:
          description: Listing last seen at (most recent) timestamp
          type: integer
        last_seen_at_date:
          description: Listing last seen at (most recent) date
          type: string
        media:
          $ref: "#/components/schemas/ListingNestMedia"
        miles:
          description: Odometer reading / reported miles usage for the RV
          type: integer
        miles_indicator:
          description: miles_indicator of the listing
          type: string
        mot_expires:
          description: mot_expires of the listing
          type: string
        motorhome_build:
          description: motorhome_build of the listing
          type: string
        msrp:
          description: MSRP for the RV
          type: integer
        origin:
          description: origin of the listing
          type: string
        price:
          description: Asking price for the RV
          type: integer
        scraped_at:
          description: Listing last seen at date timestamp
          format: integer
          type: number
        scraped_at_date:
          description: Listing last seen at date
          type: string
        seller_type:
          description: Seller type for the RV
          type: string
        source:
          description: Source domain of the listing
          type: string
        stock_no:
          description: Stock number of RV in dealers inventory
          type: string
        vdp_url:
          description: Details Page url of the specific RV
          type: string
        vin:
          description: VIN for the RV
          type: string
      type: object
    UKRVBuild:
      description: Describes the RV specification
      properties:
        area:
          description: Area of the RV
          type: string
        berths:
          description: berths of RV
          type: string
        category:
          description: category of the RV
          type: string
        chassis:
          description: chassis of RV
          type: string
        drive_type:
          description: drive_type of RV
          type: string
        drivetrain:
          description: Drivetrain of the RV
          type: string
        engine:
          description: Engine of the RV
          type: string
        engine_size:
          description: engine_size of RV
          type: string
        exterior_length:
          description: exterior_length of RV
          type: string
        floorplan:
          description: floorplan of RV
          type: string
        floorplan_layout:
          description: floorplan_layout of RV
          type: string
        fuel_type:
          description: Fuel type of the RV
          type: string
        gvwr:
          description: Gross Vehicle Weight Ratio of RV
          type: string
        interior_length:
          description: interior_length of RV
          type: string
        inventory_type:
          description: Inventory type of the RV
          type: string
        make:
          description: RV Make
          type: string
        model:
          description: RV model
          type: string
        mtplm:
          description: mtplm of RV
          type: string
        slideouts:
          description: Slideouts of the RV
          type: string
        steering:
          description: steering of RV
          type: string
        sub_category:
          description: sub_category of the RV
          type: string
        transmission:
          description: Transmission of the RV
          type: string
        width:
          description: width of RV
          type: string
        year:
          description: Year of the RV
          type: integer
      type: object
    UKRVSearchFacets:
      properties:
        berths:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        category:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        chassis:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        city:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        dealer_id:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        drive_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        drivetrain:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        engine:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        exterior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        fuel_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        interior_color:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        inventory_type:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        make:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        model:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        postal_code:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        seller_name:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        source:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        state:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        steering:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        sub_category:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        transmission:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        year:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
        zip:
          items:
            $ref: "#/components/schemas/FacetItem"
          type: array
      type: object
    UKRVSearchRangeFacets:
      properties:
        exterior_length:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        interior_length:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        miles:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        price:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
        width:
          items:
            $ref: "#/components/schemas/RangeFacetItem"
          type: object
      type: object
    UKRVSearchResponse:
      description: RV search query response
      properties:
        facets:
          items:
            $ref: "#/components/schemas/UKRVSearchFacets"
          type: object
        listings:
          items:
            $ref: "#/components/schemas/UKRVBaseListing"
          type: array
        num_found:
          description: The number of listings found
          type: integer
        range_facets:
          items:
            $ref: "#/components/schemas/UKRVSearchRangeFacets"
          type: object
        stats:
          items:
            $ref: "#/components/schemas/MotorcycleSearchStats"
          type: object
      type: object
    UKSearchResponse:
      description: Search query response
      properties:
        facets:
          $ref: "#/components/schemas/UKCarSearchFacets"
        listings:
          items:
            $ref: "#/components/schemas/UKBaseListing"
          type: array
        num_found:
          description: The number of listings found
          type: integer
        range_facets:
          $ref: "#/components/schemas/CarSearchRangeFacets"
        stats:
          $ref: "#/components/schemas/CarSearchStats"
      type: object
    VinReport:
      properties:
        icon:
          description: icon url
          type: string
        some_text:
          description: Some descriptional text
          type: string
      type: object
  securitySchemes:
    authorizeEndpoint:
      scheme: basic
      type: http
