openapi.yaml

basePath: /v2
definitions:
  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:
      build:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/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
      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: '#/definitions/ListingLease'
        type: array
      media:
        $ref: '#/definitions/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
      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
      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: '#/definitions/SalesStats'
      inventoryType:
        description: Inventory type
        type: string
      make:
        description: Make name
        type: string
      miles_stats:
        $ref: '#/definitions/SalesStats'
      model:
        description: Model name
        type: string
      price_stats:
        $ref: '#/definitions/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
      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
      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
      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: '#/definitions/Listing'
        type: object
    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: '#/definitions/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: '#/definitions/CarListingRank'
        type: array
    type: object
  CarSearchFacets:
    properties:
      base_exterior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      base_interior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      body_subtype:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      body_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      car_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      carfax_1_owner:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      carfax_clean_title:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      city:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      cylinders:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      data_source:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      dealer_id:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      dealer_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      doors:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      drivetrain:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine_aspiration:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine_block:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine_size:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      exterior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      fuel_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      interior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      make:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      model:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      seller_name:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      seller_name_o:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      seller_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      source:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      state:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      transmission:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      trim:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      trim_o:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      trim_r:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      vehicle_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      year:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
    type: object
  CarSearchRangeFacets:
    properties:
      dom:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      dom_180:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      dom_active:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      finance_down_payment:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      finance_emp:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      finance_loan_apr:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      finance_loan_term:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      lease_down_payment:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      lease_emp:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      lease_term:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      miles:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      msrp:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      price:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
    type: object
  CarSearchStats:
    properties:
      dom:
        $ref: '#/definitions/StatsItem'
      dom_180:
        $ref: '#/definitions/StatsItem'
      dom_active:
        $ref: '#/definitions/StatsItem'
      finance_down_payment:
        $ref: '#/definitions/StatsItem'
      finance_down_payment_per:
        $ref: '#/definitions/StatsItem'
      finance_emp:
        $ref: '#/definitions/StatsItem'
      finance_loan_apr:
        $ref: '#/definitions/StatsItem'
      finance_loan_term:
        $ref: '#/definitions/StatsItem'
      lease_down_payment:
        $ref: '#/definitions/StatsItem'
      lease_emp:
        $ref: '#/definitions/StatsItem'
      lease_term:
        $ref: '#/definitions/StatsItem'
      miles:
        $ref: '#/definitions/StatsItem'
      msrp:
        $ref: '#/definitions/StatsItem'
      price:
        $ref: '#/definitions/StatsItem'
    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: '#/definitions/CompetitorsCarDetails'
      same_car_models:
        items:
          $ref: '#/definitions/CompetitorsSameCars'
        type: array
      similar_car_models:
        items:
          $ref: '#/definitions/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: '#/definitions/DailyStatsNestedJson'
      miles_stats:
        $ref: '#/definitions/DailyStatsNestedJson'
      price_stats:
        $ref: '#/definitions/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
      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
      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: '#/definitions/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: '#/definitions/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: '#/definitions/Dealer'
        type: array
      num_found:
        description: number of dealers found
        type: integer
    type: object
  DepreciationPoint:
    properties:
      similar_models:
        items:
          $ref: '#/definitions/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
  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
  HeavyEquipmentsBaseListing:
    description: Base heavy equipment listing
    properties:
      build:
        $ref: '#/definitions/HeavyEquipmentsBuild'
      dealer:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/RVBuild'
      dealer:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/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: '#/definitions/FacetItem'
        type: array
      category:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      city:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      cylinders:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      dealer_id:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      drivetrain:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      exterior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      fuel_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      interior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      inventory_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      make:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      model:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      seller_name:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      source:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      state:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      sub_category:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      transmission:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      trim:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      year:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
    type: object
  HeavyEquipmentsSearchRangeFacets:
    properties:
      hours_used:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      miles:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      price:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
    type: object
  HeavyEquipmentsSearchResponse:
    description: Heavy Equipments search query response
    properties:
      facets:
        items:
          $ref: '#/definitions/HeavyEquipmentsSearchFacets'
        type: object
      listings:
        items:
          $ref: '#/definitions/HeavyEquipmentsBaseListing'
        type: array
      num_found:
        description: The number of listings found
        type: integer
      range_facets:
        items:
          $ref: '#/definitions/HeavyEquipmentsSearchRangeFacets'
        type: object
      stats:
        items:
          $ref: '#/definitions/HeavyEquipmentsSearchStats'
        type: object
    type: object
  HeavyEquipmentsSearchStats:
    properties:
      hours_used:
        $ref: '#/definitions/StatsItem'
      miles:
        $ref: '#/definitions/StatsItem'
      price:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/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:
      build:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/ListingNestExtraAttributes'
      financing_options:
        description: Array of all finance offers for this listing
        items:
          $ref: '#/definitions/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: '#/definitions/ListingLease'
        type: array
      media:
        $ref: '#/definitions/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
      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
      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
    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: '#/definitions/MotorcycleBuild'
      color:
        description: Color of the motorcycle
        type: string
      dealer:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/MotorcycleBuild'
      color:
        description: Color of the motorcycle
        type: string
      dealer:
        $ref: '#/definitions/NestDealer'
      dp_url:
        description: Details Page url of the specific motorcycle
        type: string
      extra:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/FacetItem'
        type: array
      city:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      cylinders:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      dealer_id:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      drivetrain:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      fuel_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      inventory_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      make:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      model:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      seller_name:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      source:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      state:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      transmission:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      trim:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      vehicle_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      year:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
    type: object
  MotorcycleSearchRangeFacets:
    properties:
      miles:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
      price:
        items:
          $ref: '#/definitions/RangeFacetItem'
        type: object
    type: object
  MotorcycleSearchResponse:
    description: Motorcycle search query response
    properties:
      facets:
        items:
          $ref: '#/definitions/MotorcycleSearchFacets'
        type: object
      listings:
        items:
          $ref: '#/definitions/MotorcycleBaseListing'
        type: array
      num_found:
        description: The number of listings found
        type: integer
      range_facets:
        items:
          $ref: '#/definitions/MotorcycleSearchRangeFacets'
        type: object
      stats:
        items:
          $ref: '#/definitions/MotorcycleSearchStats'
        type: object
    type: object
  MotorcycleSearchStats:
    properties:
      miles:
        $ref: '#/definitions/StatsItem'
      price:
        $ref: '#/definitions/StatsItem'
    type: object
  NestDealer:
    properties:
      city:
        description: City of the dealer
        type: string
      country:
        description: country of the dealer
        type: string
      dealer_type:
        description: Type of dealer (franchise/independent)
        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
      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: '#/definitions/BasePopular'
        type: array
      used_top50:
        description: Array of all used top 50 cars
        items:
          $ref: '#/definitions/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
  RVBaseListing:
    description: Base RV listing
    properties:
      build:
        $ref: '#/definitions/RVBuild'
      dealer:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/RVBuild'
      dealer:
        $ref: '#/definitions/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: '#/definitions/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: '#/definitions/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: '#/definitions/FacetItem'
        type: array
      awnings:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      city:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      class:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      dealer_id:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      engine:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      exterior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      fuel_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      interior_color:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      inventory_type:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      length:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      make:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      model:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      seller_name:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      sleeps:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      slideouts:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      source:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      state:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      transmission:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
      year:
        items:
          $ref: '#/definitions/FacetItem'
        type: array
    type: object
  RVSearchResponse:
    description: RV search query response
    properties:
      facets:
        items:
          $ref: '#/definitions/RVSearchFacets'
        type: object
      listings:
        items:
          $ref: '#/definitions/RVBaseListing'
        type: array
      num_found:
        description: The number of listings found
        type: integer
      range_facets:
        items:
          $ref: '#/definitions/MotorcycleSearchRangeFacets'
        type: object
      stats:
        items:
          $ref: '#/definitions/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: '#/definitions/SalesStats'
      inventory_type:
        description: inventory_type
        type: string
      make:
        description: Make
        type: string
      miles_stats:
        $ref: '#/definitions/SalesStats'
      model:
        description: model
        type: string
      non-cpo:
        description: Non-cpo sales count
        type: integer
      price_stats:
        $ref: '#/definitions/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:
        items:
          $ref: '#/definitions/CarSearchFacets'
        type: object
      listings:
        items:
          $ref: '#/definitions/BaseListing'
        type: array
      num_found:
        description: The number of listings found
        type: integer
      range_facets:
        items:
          $ref: '#/definitions/CarSearchRangeFacets'
        type: object
      stats:
        items:
          $ref: '#/definitions/CarSearchStats'
        type: object
    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
  VinReport:
    properties:
      icon:
        description: icon url
        type: string
      some_text:
        description: Some descriptional text
        type: string
    type: object
host: marketcheck-prod.apigee.net
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
paths:
  /car/dealer/inventory/active:
    get:
      description: Get dealers active inventory
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Boolean param to search for listings that include leasing options in
            them
          in: query
          name: include_lease
          required: false
          type: boolean
        - description: >-
            Boolean param to search for listings that include finance options in
            them
          in: query
          name: include_finance
          required: false
          type: boolean
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Dealer id to filter the listings.
          format: string
          in: query
          name: dealer_id
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seed_id
            transformConstraints:
              - transformer: parseInt
                type: integer
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their source
          in: query
          name: source
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: source
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: mm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: ymm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - default: false
          description: To include non vin listings. Default is false
          in: query
          name: include_non_vin_listings
          required: false
          type: boolean
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
            - all
            - ALL
          in: query
          name: country
          type: string
        - description: >-
            If plot has value true results in around 25k coordinates with
            limited fields to plot respective graph
          in: query
          name: plot
          required: false
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on dealer_name
          in: query
          name: dealer_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seller_name
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Name of the dealership group to search for
          format: string
          in: query
          name: dealership_group_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: dealership_group_name_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on web scraped trim
          in: query
          name: trim_o
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_orig
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter trim on custom possible matches
          in: query
          name: trim_r
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_r_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: Boolean param to exclude certified cars from search results
          in: query
          name: exclude_certified
          required: false
          type: boolean
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: boolean
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: List of all cars listings matching the search & filter criteria
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: The VIN to identify the car. Must be a valid 17 char VIN
          format: string
          in: path
          minLength: 10
          name: vin
          required: true
          type: string
        - description: >-
            Page number to fetch the results for the given criteria. Default is
            1.
          format: number
          in: query
          name: page
          required: false
          type: number
      produces:
        - application/json
      responses:
        '200':
          description: Reacll info for the given vin
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: Recall info by vin
      tags:
        - Recall Search
    x-swagger-router-controller: history
  '/crm_check/car/{vin}':
    get:
      description: >-
        Check whether particular vin has had a listing after stipulated date or
        not
      operationId: crmCheck
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: The VIN to identify the car. Must be a valid 17 char VIN
          format: string
          in: path
          minLength: 10
          name: vin
          required: true
          type: string
        - description: >-
            sale date to check whether after this listing has appeared or not.
            Must be 8 character long, with YYYYMMDD format
          format: string
          in: query
          minLength: 8
          name: sale_date
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: CRM check for given vin
          schema:
            $ref: '#/definitions/CRMResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: CRM check of a particular vin
      tags:
        - CRM Cleanse API
      x-swagger-router-controller: history
  '/dealer/car/{id}':
    get:
      description: Get a particular dealer's information by its id
      operationId: getDealer
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Dealer id to get all the dealer info attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Dealer for the given id
          schema:
            $ref: '#/definitions/Dealer'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Dealer id to get all the dealer info attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Dealer for the given id
          schema:
            $ref: '#/definitions/Dealer'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Dealer id to get all the dealer info attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Dealer for the given id
          schema:
            $ref: '#/definitions/Dealer'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Dealer id to get all the dealer info attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Dealer for the given id
          schema:
            $ref: '#/definitions/Dealer'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: >-
            To filter dealers based on their inventory size. Range can be given
            in the format - min-max e.g. 50-100
          format: string
          in: query
          name: listing_count_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: listing_count
            transformConstraints:
              - defaultMax: 500
                defaultMin: 10
                transformer: parseInt
                type: integer
        - description: inventory_url of dealer to be searched
          format: string
          in: query
          name: inventory_url
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: website
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
        - 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
          type: string
        - 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
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of dealers for the search
          schema:
            $ref: '#/definitions/DealersResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: >-
            To filter dealers based on their inventory size. Range can be given
            in the format - min-max e.g. 50-100
          format: string
          in: query
          name: listing_count_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: listing_count
            transformConstraints:
              - defaultMax: 500
                defaultMin: 10
                transformer: parseInt
                type: integer
        - description: inventory_url of dealer to be searched
          format: string
          in: query
          name: inventory_url
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: website
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
        - 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
          type: string
        - 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
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of dealers for the search
          schema:
            $ref: '#/definitions/DealersResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: >-
            To filter dealers based on their inventory size. Range can be given
            in the format - min-max e.g. 50-100
          format: string
          in: query
          name: listing_count_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: listing_count
            transformConstraints:
              - defaultMax: 500
                defaultMin: 10
                transformer: parseInt
                type: integer
        - description: inventory_url of dealer to be searched
          format: string
          in: query
          name: inventory_url
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: website
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
        - 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
          type: string
        - 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
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of dealers for the search
          schema:
            $ref: '#/definitions/DealersResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: >-
            To filter dealers based on their inventory size. Range can be given
            in the format - min-max e.g. 50-100
          format: string
          in: query
          name: listing_count_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: listing_count
            transformConstraints:
              - defaultMax: 500
                defaultMin: 10
                transformer: parseInt
                type: integer
        - description: inventory_url of dealer to be searched
          format: string
          in: query
          name: inventory_url
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: website
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: false
          description: boolean param to include site providers name in response
          in: query
          name: provider
          required: false
          type: boolean
        - 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
          type: string
        - 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
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of dealers for the search
          schema:
            $ref: '#/definitions/DealersResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: The VIN to identify the car. Must be a valid 17 char VIN
          format: string
          in: path
          minLength: 10
          name: vin
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Basic sepcifications details about the car
          schema:
            $ref: '#/definitions/Build'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: EPI VIN 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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: The VIN to identify the car. Must be a valid 17 char VIN
          format: string
          in: path
          minLength: 10
          name: vin
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Basic sepcifications details about the car
          schema:
            $ref: '#/definitions/Build'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: VIN Decoder
      tags:
        - VIN Decoder API
      x-swagger-router-controller: vin_decoder
  '/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: The VIN to identify the car. Must be a valid 17 char VIN
          format: string
          in: path
          minLength: 10
          name: vin
          required: true
          type: string
        - description: >-
            List of fields to fetch, in case the default fields list in the
            response is to be trimmed down
          format: string
          in: query
          name: fields
          required: false
          type: string
        - description: >-
            Page number to fetch the results for the given criteria. Default is
            1.
          format: number
          in: query
          name: page
          required: false
          type: number
        - description: >-
            Flag to indicate whether to include duplicate historical records as
            well in the response
          in: query
          name: include_duplicates
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Online listing history for the given vin
          schema:
            items:
              $ref: '#/definitions/HistoricalListing'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: ID of the listing to fetch cached images for
          in: path
          name: listingID
          required: true
          type: string
        - description: ID of the image to fetch
          in: path
          name: imageID
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Cached image of the car
          schema:
            $ref: '#/definitions/CacheImageResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Listing for the given id
          schema:
            $ref: '#/definitions/Listing'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: ListingAttributes for the given listing id
          schema:
            $ref: '#/definitions/ListingExtraAttributes'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: ListingMedia for the given listing id
          schema:
            $ref: '#/definitions/ListingMedia'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Listing for the given id
          schema:
            $ref: '#/definitions/Listing'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: ListingAttributes for the given listing id
          schema:
            $ref: '#/definitions/ListingExtraAttributes'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: ListingMedia for the given listing id
          schema:
            $ref: '#/definitions/ListingMedia'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Listing for the given id
          schema:
            $ref: '#/definitions/Listing'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: ListingAttributes for the given listing id
          schema:
            $ref: '#/definitions/ListingExtraAttributes'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: ListingMedia for the given listing id
          schema:
            $ref: '#/definitions/ListingMedia'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Heavy equipment listing for the given id
          schema:
            $ref: '#/definitions/HeavyEquipmentsListing'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Heavy equipment ListingAttributes for the given listing id
          schema:
            $ref: '#/definitions/ListingExtraAttributes'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Listing Media for the given listing id
          schema:
            $ref: '#/definitions/ListingMedia'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Motorcycle listing for the given id
          schema:
            $ref: '#/definitions/MotorcycleListing'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Motorcycle ListingAttributes for the given listing id
          schema:
            $ref: '#/definitions/ListingExtraAttributes'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Motorcycle listing media for the given listing id
          schema:
            $ref: '#/definitions/ListingMedia'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: Motorcycle listing media by id
      tags:
        - Motorcycle Search
    x-swagger-router-controller: search
  '/listing/rv/{id}':
    get:
      description: Get a particular RV listing by its id
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: RV listing for the given id
          schema:
            $ref: '#/definitions/RVListing'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: RV ListingAttributes for the given listing id
          schema:
            $ref: '#/definitions/ListingExtraAttributes'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Listing id to get all the listing attributes
          format: string
          in: path
          name: id
          required: true
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Listing Media for the given listing id
          schema:
            $ref: '#/definitions/ListingMedia'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: VIN to decode
          format: string
          in: query
          minLength: 10
          name: vin
          required: false
          type: string
        - default: false
          description: Exact parameter
          in: query
          name: exact
          required: false
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - default: false
          description: Debug parameter
          in: query
          name: debug
          required: false
          type: boolean
        - default: false
          description: To fetch sold vins
          in: query
          name: include_sold
          required: false
          type: boolean
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Dealer id to filter the listings.
          format: string
          in: query
          name: dealer_id
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seed_id
            transformConstraints:
              - transformer: parseInt
                type: integer
        - description: To filter listing on their source
          in: query
          name: source
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: source
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Name of the dealership group to search for
          format: string
          in: query
          name: dealership_group_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: dealership_group_name_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
      produces:
        - application/json
      responses:
        '200':
          description: Provides Market Days supply for year make model or trim combination
          schema:
            $ref: '#/definitions/Mds'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: State level sales count
          format: string
          in: query
          name: state
          required: false
          type: string
        - description: >-
            City level sales count, pipe seperated like
            city_state=jacksonville|FL
          format: string
          in: query
          name: city_state
          required: false
          type: string
        - description: Inventory type for which popular count is to be searched
          enum:
            - new
            - used
          format: string
          in: query
          name: car_type
          required: true
          type: string
        - default: us
          description: Country for which the popular cars are to be searched
          enum:
            - us
            - ca
            - US
            - CA
          in: query
          name: country
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of most popular top 50 cars
          schema:
            $ref: '#/definitions/PopularCars'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: 'Get make model wise top 50 popular cars on national, state, city level'
      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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: used
          description: >-
            Inventory type for which sales count is to be searched, default is
            used
          enum:
            - new
            - used
          format: string
          in: query
          name: car_type
          required: false
          type: string
        - description: Make for which sales count is to be searched
          format: string
          in: query
          name: make
          required: false
          type: string
        - description: >-
            Make-Model for which sales count is to be searched, pipe seperated
            like mm=ford|f-150
          format: string
          in: query
          name: mm
          required: false
          type: string
        - description: >-
            Year-Make-Model for which sales count is to be searched, pipe
            seperated like ymm=2015|ford|f-150
          format: string
          in: query
          name: ymm
          required: false
          type: string
        - description: >-
            Year-Make-Model-Trim for which sales count is to be searched, pipe
            seperated like ymmt=2015|ford|f-150|platinum
          format: string
          in: query
          name: ymmt
          required: false
          type: string
        - description: taxonomy_vin for which sales count is to be searched
          format: string
          in: query
          name: taxonomy_vin
          required: false
          type: string
        - description: State level sales count
          format: string
          in: query
          name: state
          required: false
          type: string
        - description: >-
            City level sales count, pipe seperated like
            city_state=jacksonville|FL
          format: string
          in: query
          name: city_state
          required: false
          type: string
        - description: VIN that will be transformed to taxonomy_vin
          format: string
          in: query
          name: vin
          required: false
          type: string
        - default: us
          description: Country for which the sales records are to be searched
          enum:
            - us
            - ca
            - US
            - CA
          in: query
          name: country
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Sales count for given parameters
          schema:
            $ref: '#/definitions/Sales'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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
      operationId: search
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Boolean param to search for listings that include leasing options in
            them
          in: query
          name: include_lease
          required: false
          type: boolean
        - description: >-
            Boolean param to search for listings that include finance options in
            them
          in: query
          name: include_finance
          required: false
          type: boolean
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: mm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: ymm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - default: false
          description: To include non vin listings. Default is false
          in: query
          name: include_non_vin_listings
          required: false
          type: boolean
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
            - all
            - ALL
          in: query
          name: country
          type: string
        - description: >-
            If plot has value true results in around 25k coordinates with
            limited fields to plot respective graph
          in: query
          name: plot
          required: false
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on web scraped trim
          in: query
          name: trim_o
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_orig
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter trim on custom possible matches
          in: query
          name: trim_r
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_r_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: Boolean param to exclude certified cars from search results
          in: query
          name: exclude_certified
          required: false
          type: boolean
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: boolean
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: List of all cars listings matching the search & filter criteria
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: Gets active car listings for the given search criteria
      tags:
        - Car Search
    x-swagger-router-controller: search
  /search/car/active/rank:
    post:
      consumes:
        - application/json
      description: >-
        Computer rank for car listings based on inputs provided.Weights for
        ranking parameters can also be provided.
      operationId: searchAndRankCar
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Boolean param to search for listings that include leasing options in
            them
          in: query
          name: include_lease
          required: false
          type: boolean
        - description: >-
            Boolean param to search for listings that include finance options in
            them
          in: query
          name: include_finance
          required: false
          type: boolean
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - default: 1-
          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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - default: 1-
          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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - default: false
          description: To include non vin listings. Default is false
          in: query
          name: include_non_vin_listings
          required: false
          type: boolean
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
            - all
            - ALL
          in: query
          name: country
          type: string
        - description: >-
            If plot has value true results in around 25k coordinates with
            limited fields to plot respective graph
          in: query
          name: plot
          required: false
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on web scraped trim
          in: query
          name: trim_o
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_orig
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter trim on custom possible matches
          in: query
          name: trim_r
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_r_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: Boolean param to exclude certified cars from search results
          in: query
          name: exclude_certified
          required: false
          type: boolean
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: boolean
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Page number to fetch the results for the given criteria. Default is
            1.
          format: number
          in: query
          name: page
          required: false
          type: number
        - description: Inputs needed for ranking a group of car listings
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/CarRankRequest'
      produces:
        - application/json
      responses:
        '200':
          description: Rank listings based on inputs provided.
          schema:
            $ref: '#/definitions/CarRankResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: Compute relative rank for car listings.
      tags:
        - Rank Car Listings
    x-swagger-router-controller: search
  /search/car/active/rank/listings:
    post:
      consumes:
        - application/json
      description: >-
        Computer rank for car listings based on inputs provided.Weights for
        ranking parameters can also be provided.
      operationId: rankCar
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Inputs needed for ranking a group of car listings
          in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/CarRankRequest'
      produces:
        - application/json
      responses:
        '200':
          description: Rank listings based on inputs provided.
          schema:
            $ref: '#/definitions/CarRankResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Boolean param to search for listings that include leasing options in
            them
          in: query
          name: include_lease
          required: false
          type: boolean
        - description: >-
            Boolean param to search for listings that include finance options in
            them
          in: query
          name: include_finance
          required: false
          type: boolean
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: mm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: ymm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - default: false
          description: To include non vin listings. Default is false
          in: query
          name: include_non_vin_listings
          required: false
          type: boolean
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
            - all
            - ALL
          in: query
          name: country
          type: string
        - description: >-
            If plot has value true results in around 25k coordinates with
            limited fields to plot respective graph
          in: query
          name: plot
          required: false
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on web scraped trim
          in: query
          name: trim_o
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_orig
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter trim on custom possible matches
          in: query
          name: trim_r
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_r_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: Boolean param to exclude certified cars from search results
          in: query
          name: exclude_certified
          required: false
          type: boolean
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: boolean
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: >-
            List of all auction cars listings matching the search & filter
            criteria
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Field name for which you want auto-completion
          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
          in: query
          name: field
          required: true
          type: string
        - description: Input entered so far
          format: string
          in: query
          name: input
          required: true
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: Car type. Allowed values are - new / used
          enum:
            - new
            - used
          in: query
          name: car_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - default: 'false'
          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
          enum:
            - 'true'
            - 'false'
          in: query
          name: include_non_vin_listings
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: is_non_vin_listing_is
            transformConstraints:
              - transformer: boolToFlag
                type: string
        - default: true
          description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          type: boolean
        - default: false
          description: >-
            Boolean variable to indicate wheather to include term counts as well
            in response
          in: query
          name: term_counts
          required: false
          type: boolean
        - default: index
          description: 'Sort the response, either by index or count(default)'
          enum:
            - index
            - count
          in: query
          name: sort_by
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Unique terms available in given field for auto completion
          schema:
            $ref: '#/definitions/SearchAutoCompleteResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Boolean param to search for listings that include leasing options in
            them
          in: query
          name: include_lease
          required: false
          type: boolean
        - description: >-
            Boolean param to search for listings that include finance options in
            them
          in: query
          name: include_finance
          required: false
          type: boolean
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: mm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: ymm
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - default: false
          description: To include non vin listings. Default is false
          in: query
          name: include_non_vin_listings
          required: false
          type: boolean
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
            - all
            - ALL
          in: query
          name: country
          type: string
        - description: >-
            If plot has value true results in around 25k coordinates with
            limited fields to plot respective graph
          in: query
          name: plot
          required: false
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on web scraped trim
          in: query
          name: trim_o
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_orig
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter trim on custom possible matches
          in: query
          name: trim_r
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_r_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: Boolean param to exclude certified cars from search results
          in: query
          name: exclude_certified
          required: false
          type: boolean
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: boolean
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: List of all FSBO cars listings matching the search & filter criteria
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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
      parameters:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: The type of the incentive
          enum:
            - lease
            - finance
            - cash
          in: query
          name: offer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: offer_type
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: msrp
          required: false
          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
          format: string
          in: query
          name: apr
          required: false
          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
          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
          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
          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
          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
          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
          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
          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
          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
          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
          format: string
          in: query
          name: mileage_charge
          required: false
          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
          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
          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
          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
          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
          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
          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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: total_monthly_payment
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
          in: query
          name: country
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: country
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To search a substring across entire document
          in: query
          name: search_text
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: long_text_copy_field
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: >-
            List of all oem incentive listings matching the search & filter
            criteria
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: true
          description: Flag on whether to include api_key in response API urls (if any)
          in: query
          name: append_api_key
          type: boolean
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 100
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: >-
            Boolean param to search for listings that include leasing options in
            them
          in: query
          name: include_lease
          required: false
          type: boolean
        - description: >-
            Boolean param to search for listings that include finance options in
            them
          in: query
          name: include_finance
          required: false
          type: boolean
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: lease_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_down_pay_fs
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: l_emi_fs
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_term_is
            transformConstraints:
              - defaultMax: 48
                defaultMin: 12
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: loan_apr_fs
            transformConstraints:
              - defaultMax: 12
                defaultMin: 1
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_emi_fs
            transformConstraints:
              - defaultMax: 3000
                defaultMin: 10
                transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            separator: '-'
            targetAlias: f_down_pay_fs
            transformConstraints:
              - defaultMax: 10000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          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
        - description: Car type. Allowed values are - new / used / certified
          enum:
            - new
            - used
            - certified
          in: query
          name: car_type
          required: false
          type: string
        - description: Indicates whether car has had only one owner or not
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_1_owner
          required: false
          type: string
        - description: Indicates whether car has clean ownership records
          enum:
            - 'true'
            - 'false'
          in: query
          name: carfax_clean_title
          required: false
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Dealer id to filter the listings.
          format: string
          in: query
          name: dealer_id
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seed_id
            transformConstraints:
              - transformer: parseInt
                type: integer
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their source
          in: query
          name: source
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: source
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
        - 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
          type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: doors
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: doors_is
            transformConstraints:
              - min: 1
                transformer: parseInt
                type: integer
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: base_interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_aspiration
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: highway_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: highway_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: city_mpg_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: city_mpg
            transformConstraints:
              - defaultMax: 1000
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: dom_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: dom_is
            transformConstraints:
              - defaultMax: 30
                defaultMin: 0
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_source_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: relisted_at_date_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_at_mc_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: first_scraped_at_dts
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - default: false
          description: To include non vin listings. Default is false
          in: query
          name: include_non_vin_listings
          required: false
          type: boolean
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - default: US
          description: To filter listing on Country in which they are listed
          enum:
            - US
            - CA
            - us
            - ca
            - all
            - ALL
          in: query
          name: country
          type: string
        - description: >-
            If plot has value true results in around 25k coordinates with
            limited fields to plot respective graph
          in: query
          name: plot
          required: false
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - 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
          type: boolean
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - description: Filter listings on dealer_name
          in: query
          name: dealer_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seller_name
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Name of the dealership group to search for
          format: string
          in: query
          name: dealership_group_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: dealership_group_name_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter listings on web scraped trim
          in: query
          name: trim_o
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_orig
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter trim on custom possible matches
          in: query
          name: trim_r
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim_r_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: dom_active_range
          required: false
          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
        - 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
          format: string
          in: query
          name: dom_180_range
          required: false
          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
        - description: Boolean param to exclude certified cars from search results
          in: query
          name: exclude_certified
          required: false
          type: boolean
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter based on dealer type independant or franchise
          enum:
            - franchise
            - independent
          in: query
          name: dealer_type
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            separator: ','
            targetAlias: dealer_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: boolean
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: sold parameter to fetch only sold listings
          in: query
          name: sold
          required: false
          type: boolean
        - default: false
          description: To include_relevant_links. Default is true
          in: query
          name: include_relevant_links
          required: false
          type: boolean
        - description: >-
            Boolean falg to either fetch only the expired listings or active
            ones
          enum:
            - 'true'
            - 'false'
          in: query
          name: expired
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: is_expired_listing
            transformConstraints:
              - transformer: boolToFlag
                type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of all cars listings matching the search & filter criteria
          schema:
            $ref: '#/definitions/SearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: Gets Recent 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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To search a substring across entire document
          in: query
          name: search_text
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: long_text_copy_field
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their source
          in: query
          name: source
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: source
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: Filter listings on dealer_name
          in: query
          name: dealer_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seller_name
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Dealer id to filter the listings.
          format: string
          in: query
          name: dealer_id
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seed_id
            transformConstraints:
              - transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter heavy equipments on their category
          in: query
          name: category
          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
          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
          format: string
          in: query
          name: hours_used_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: hours_used
            transformConstraints:
              - defaultMax: 5000
                defaultMin: 100
                transformer: parseInt
                type: integer
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
      produces:
        - application/json
      responses:
        '200':
          description: >-
            List of all heavy equipment listings matching the search & filter
            criteria
          schema:
            $ref: '#/definitions/HeavyEquipmentsSearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Field name for which you want auto-completion
          enum:
            - make
            - model
            - trim
            - body_type
            - transmission
            - drivetrain
            - fuel_type
            - exterior_color
            - interior_color
            - engine
            - category
            - sub_category
            - state
            - city
          format: string
          in: query
          name: field
          required: true
          type: string
        - description: Input entered so far
          format: string
          in: query
          name: input
          required: true
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Color of the vehicle
          in: query
          name: color
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - default: true
          description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          type: boolean
        - default: false
          description: >-
            Boolean variable to indicate wheather to include term counts as well
            in response
          in: query
          name: term_counts
          required: false
          type: boolean
        - default: index
          description: 'Sort the response, either by index or count(default)'
          enum:
            - index
            - count
          in: query
          name: sort_by
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Unique terms available in given field for auto completion
          schema:
            $ref: '#/definitions/SearchAutoCompleteResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To search a substring across entire document
          in: query
          name: search_text
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: long_text_copy_field
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: Taxonomy VIN of the motorcycle
          in: query
          name: taxonomy_vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: taxonomy_vin
            transformConstraints:
              - maxLength: 10
                transformer: caseTransformer
                type: string
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their source
          in: query
          name: source
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: source
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: Dealer id to filter the listings.
          format: string
          in: query
          name: dealer_id
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seed_id
            transformConstraints:
              - transformer: parseInt
                type: integer
        - description: Color of the vehicle
          in: query
          name: color
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their cylinders
          in: query
          name: cylinders
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: cylinders
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
      produces:
        - application/json
      responses:
        '200':
          description: >-
            List of all motorcycles listings matching the search & filter
            criteria
          schema:
            $ref: '#/definitions/MotorcycleSearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Field name for which you want auto-completion
          enum:
            - make
            - model
            - trim
            - body_type
            - vehicle_type
            - transmission
            - drivetrain
            - fuel_type
            - color
            - engine
            - state
            - city
          format: string
          in: query
          name: field
          required: true
          type: string
        - description: Input entered so far
          format: string
          in: query
          name: input
          required: true
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Color of the vehicle
          in: query
          name: color
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - default: true
          description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          type: boolean
        - default: false
          description: >-
            Boolean variable to indicate wheather to include term counts as well
            in response
          in: query
          name: term_counts
          required: false
          type: boolean
        - default: index
          description: 'Sort the response, either by index or count(default)'
          enum:
            - index
            - count
          in: query
          name: sort_by
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Unique terms available in given field for auto completion
          schema:
            $ref: '#/definitions/SearchAutoCompleteResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - 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
          format: string
          in: query
          name: price_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: price
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: miles_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: miles
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - 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
          format: string
          in: query
          name: msrp_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: msrp
            transformConstraints:
              - defaultMax: 100000
                defaultMin: 1000
                transformer: parseInt
                type: integer
        - description: To search a substring across entire document
          in: query
          name: search_text
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: equals
            targetAlias: long_text_copy_field
        - description: Latitude component of location
          format: double
          in: query
          name: latitude
          type: number
        - description: Longitude component of location
          format: double
          in: query
          name: longitude
          type: number
        - description: Radius around the search location (Unit - Miles)
          format: int32
          in: query
          maximum: 7000
          minimum: 0
          name: radius
          type: integer
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model orig (as described on the webpage)
          in: query
          name: model_o
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model_o
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their VIN
          in: query
          name: vin
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vin
            transformConstraints:
              - maxLength: 17
                transformer: caseTransformer
                type: string
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their stock number on lot
          in: query
          name: stock_no
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: stock_no
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their source
          in: query
          name: source
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: source
            transformConstraints:
              - transformer: urlTransformer
                type: string
        - description: Filter listings on dealer_name
          in: query
          name: dealer_name
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seller_name
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Dealer id to filter the listings.
          format: string
          in: query
          name: dealer_id
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: seed_id
            transformConstraints:
              - transformer: parseInt
                type: integer
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: exterior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: interior_color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Filter RV listings on class
          in: query
          name: class
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: class
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on ZIP around which they are listed
          in: query
          name: zip
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: zip
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on msa code in which they are listed
          in: query
          name: msa_code
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: msa_code
        - description: Sort by field. Default sort field is distance from the given point
          format: string
          in: query
          name: sort_by
          required: false
          type: string
        - description: Sort order - asc or desc. Default sort order is asc
          enum:
            - asc
            - desc
            - ASC
            - DESC
          format: string
          in: query
          name: sort_order
          required: false
          type: string
        - default: 10
          description: Number of results to return. Default is 10. Max is 50
          format: int32
          in: query
          minimum: 0
          name: rows
          required: false
          type: integer
        - default: 0
          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
          format: int32
          in: query
          minimum: 0
          name: start
          required: false
          type: integer
        - 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
          type: string
        - 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
          type: string
        - default: count
          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
          enum:
            - count
            - index
          in: query
          name: facet_sort
          required: false
          type: string
        - 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
          type: string
        - 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
          format: string
          in: query
          name: last_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_range
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: last_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: status_date
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
        - 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
          format: string
          in: query
          name: first_seen_days
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: between
            separator: '-'
            targetAlias: scraped_at
            transformConstraints:
              - nowBound: true
                transformer: parseDate
                type: date
      produces:
        - application/json
      responses:
        '200':
          description: List of all RV listings matching the search & filter criteria
          schema:
            $ref: '#/definitions/RVSearchResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Field name for which you want auto-completion
          enum:
            - make
            - model
            - trim
            - class
            - transmission
            - fuel_type
            - exterior_color
            - interior_color
            - engine
            - state
            - city
          format: string
          in: query
          name: field
          required: true
          type: string
        - description: Input entered so far
          format: string
          in: query
          name: input
          required: true
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: Color of the vehicle
          in: query
          name: color
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: color
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on State in which they are listed
          in: query
          name: state
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: state
            transformConstraints:
              - maxLength: 2
                transformer: caseTransformer
                type: string
        - description: To filter listing on City in which they are listed
          in: query
          name: city
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: city
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their condition. Either used or new
          enum:
            - used
            - new
          in: query
          name: inventory_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: false
            operator: in
            targetAlias: inventory_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - default: true
          description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          type: boolean
        - default: false
          description: >-
            Boolean variable to indicate wheather to include term counts as well
            in response
          in: query
          name: term_counts
          required: false
          type: boolean
        - default: index
          description: 'Sort the response, either by index or count(default)'
          enum:
            - index
            - count
          in: query
          name: sort_by
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Unique terms available in given field for auto completion
          schema:
            $ref: '#/definitions/SearchAutoCompleteResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: API for auto-completion of inputs
      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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Field name for which you want auto-completion
          enum:
            - make
            - model
            - trim
            - body_type
            - body_subtype
            - vehicle_type
            - transmission
            - drivetrain
            - fuel_type
            - engine
            - engine_size
            - engine_block
          format: string
          in: query
          name: field
          required: true
          type: string
        - description: Input entered so far
          format: string
          in: query
          name: input
          required: true
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - default: true
          description: Boolean variable to indicate ignore case of current input
          in: query
          name: ignore_case
          required: false
          type: boolean
      produces:
        - application/json
      responses:
        '200':
          description: Unique terms available in given field for auto completion
          schema:
            $ref: '#/definitions/SpecsAutoCompleteResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - description: Comma separated list of fields to get terms for
          format: string
          in: query
          name: field
          required: true
          type: string
        - description: To filter listing on their year
          in: query
          minLength: 4
          name: year
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: year
            transformConstraints:
              - max: 2121
                min: 1800
                transformer: parseInt
                type: integer
        - description: To filter listings on their make
          in: query
          name: make
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: make
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listings on their model
          in: query
          name: model
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: model
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their trim
          in: query
          name: trim
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: trim
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their body type
          in: query
          name: body_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          format: string
          in: query
          name: body_subtype
          required: false
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: body_subtype
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their vehicle type
          in: query
          name: vehicle_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: vehicle_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their transmission
          in: query
          name: transmission
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: transmission
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their drivetrain
          in: query
          name: drivetrain
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: drivetrain
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their fuel type
          in: query
          name: fuel_type
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: fuel_type
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - description: To filter listing on their engine
          in: query
          name: engine
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_size
            transformConstraints:
              - transformer: caseTransformer
                type: string
        - 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
          type: string
          x-field-config:
            isConfigurable: true
            isMultiValued: true
            operator: in
            separator: ','
            targetAlias: engine_block_ss
            transformConstraints:
              - transformer: caseTransformer
                type: string
      produces:
        - application/json
      responses:
        '200':
          description: List of unique terms for specified fields
          schema:
            $ref: '#/definitions/SpecsAutoCompleteResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/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:
        - description: The API Authentication Key. Mandatory with all API calls.
          in: query
          name: api_key
          type: string
        - default: us
          description: Country for which the stats are to be searched
          enum:
            - us
            - ca
          format: string
          in: query
          name: country
          required: false
          type: string
        - default: used
          description: 'Inventory type for which stats are to be searched, default is used'
          enum:
            - new
            - used
          format: string
          in: query
          name: car_type
          required: false
          type: string
        - description: >-
            Year, Make, Model of the car, Separated by pipe e.g.
            ymm=2015|ford|f-150
          format: string
          in: query
          name: ymm
          required: false
          type: string
        - description: >-
            Year, Make, Model, Trim of the car, Separated by pipe e.g.
            ymmt=2015|ford|f-150|platinum
          format: string
          in: query
          name: ymmt
          required: false
          type: string
        - description: Taxonomy vin for referance to find stats of similar cars
          format: string
          in: query
          name: taxonomy_vin
          required: false
          type: string
        - description: VIN that will be transformed to taxonomy_vin
          format: string
          in: query
          name: vin
          required: false
          type: string
        - description: State level stats
          format: string
          in: query
          name: state
          required: false
          type: string
        - description: 'City level stats, pipe seperated like city_state=jacksonville|FL'
          format: string
          in: query
          name: city_state
          required: false
          type: string
      produces:
        - application/json
      responses:
        '200':
          description: Data with Market averages and stats
          schema:
            $ref: '#/definitions/DailyStats'
        default:
          description: Error
          schema:
            $ref: '#/definitions/Error'
      summary: 'Price, Miles and Days on Market stats'
      tags:
        - Cars Market API
      x-swagger-router-controller: market
schemes:
  - https
swagger: '2.0'
x-components:
  parameters:
    api_key:
      description: The API Authentication Key. Mandatory with all API calls.
      in: query
      name: api_key
      type: string
    append_api_key:
      default: true
      description: Flag on whether to include api_key in response API urls (if any)
      in: query
      name: append_api_key
      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
      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
      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
      format: string
      in: query
      name: body_subtype
      required: false
      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
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: body_type
        transformConstraints:
          - transformer: caseTransformer
            type: string
    car_car_type:
      description: Car type. Allowed values are - new / used / certified
      enum:
        - new
        - used
        - certified
      in: query
      name: car_type
      required: false
      type: string
    car_country:
      default: US
      description: To filter listing on Country in which they are listed
      enum:
        - US
        - CA
        - us
        - ca
        - all
        - ALL
      in: query
      name: country
      type: string
    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
      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
      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
      type: boolean
    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
      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
      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_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
      type: string
    car_type:
      description: Car type. Allowed values are - new / used
      enum:
        - new
        - used
      in: query
      name: car_type
      required: false
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: in
        targetAlias: inventory_type
        transformConstraints:
          - transformer: caseTransformer
            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
      type: string
    carfax_1_owner:
      description: Indicates whether car has had only one owner or not
      enum:
        - 'true'
        - 'false'
      in: query
      name: carfax_1_owner
      required: false
      type: string
    carfax_clean_title:
      description: Indicates whether car has clean ownership records
      enum:
        - 'true'
        - 'false'
      in: query
      name: carfax_clean_title
      required: false
      type: string
    city:
      description: To filter listing on City in which they are listed
      in: query
      name: city
      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
      format: string
      in: query
      name: city_mpg_range
      required: false
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: '-'
        targetAlias: city_mpg
        transformConstraints:
          - defaultMax: 1000
            defaultMin: 0
            transformer: parseInt
            type: integer
    color:
      description: Color of the vehicle
      in: query
      name: color
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    country:
      default: US
      description: To filter listing on Country in which they are listed
      enum:
        - US
        - CA
        - us
        - ca
      in: query
      name: country
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: country
        transformConstraints:
          - maxLength: 2
            transformer: caseTransformer
            type: string
    cylinders:
      description: To filter listing on their cylinders
      in: query
      name: cylinders
      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.
      format: string
      in: query
      name: dealer_id
      required: false
      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
      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
      enum:
        - franchise
        - independent
      in: query
      name: dealer_type
      required: false
      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
      format: string
      in: query
      name: dealership_group_name
      required: false
      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
      format: string
      in: query
      name: dom_180_range
      required: false
      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
      format: string
      in: query
      name: dom_active_range
      required: false
      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
      format: string
      in: query
      name: dom_range
      required: false
      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
      format: string
      in: query
      name: doors
      required: false
      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
      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
      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
      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
      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
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: engine_size
        transformConstraints:
          - transformer: caseTransformer
            type: string
    exclude_certified:
      description: Boolean param to exclude certified cars from search results
      in: query
      name: exclude_certified
      required: false
      type: boolean
    expired:
      description: Boolean falg to either fetch only the expired listings or active ones
      enum:
        - 'true'
        - 'false'
      in: query
      name: expired
      required: 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
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: exterior_color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    facet_sort:
      default: count
      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
      enum:
        - count
        - index
      in: query
      name: facet_sort
      required: false
      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
      type: string
    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
      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
      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
      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
      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
      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
      format: string
      in: query
      name: first_seen_at_mc_days
      required: false
      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
      format: string
      in: query
      name: first_seen_at_mc_range
      required: false
      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
      format: string
      in: query
      name: first_seen_at_source_days
      required: false
      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
      format: string
      in: query
      name: first_seen_at_source_range
      required: false
      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
      format: string
      in: query
      name: first_seen_days
      required: false
      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
      format: string
      in: query
      name: first_seen_range
      required: false
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: '-'
        targetAlias: scraped_at
        transformConstraints:
          - transformer: parseDate
            type: date
    fuel_type:
      description: To filter listing on their fuel type
      in: query
      name: fuel_type
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: fuel_type
        transformConstraints:
          - 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
      format: string
      in: query
      name: highway_mpg_range
      required: false
      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
      format: string
      in: path
      name: id
      required: true
      type: string
    include_non_vin_listings:
      default: false
      description: To include non vin listings. Default is false
      in: query
      name: include_non_vin_listings
      required: false
      type: boolean
    include_relevant_links:
      default: false
      description: To include_relevant_links. Default is true
      in: query
      name: include_relevant_links
      required: false
      type: boolean
    inpath_full_vin:
      description: The VIN to identify the car. Must be a valid 17 char VIN
      format: string
      in: path
      minLength: 10
      name: vin
      required: true
      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
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: interior_color
        transformConstraints:
          - transformer: caseTransformer
            type: string
    inventory_type:
      description: To filter listing on their condition. Either used or new
      enum:
        - used
        - new
      in: query
      name: inventory_type
      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
      format: string
      in: query
      name: inventory_url
      required: false
      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
      format: string
      in: query
      name: last_seen_days
      required: false
      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
      format: string
      in: query
      name: last_seen_range
      required: false
      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
      format: double
      in: query
      name: latitude
      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
      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
      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
      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
      format: string
      in: query
      name: listing_count_range
      required: false
      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
      format: double
      in: query
      name: longitude
      type: number
    make:
      description: To filter listings on their make
      in: query
      name: make
      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
      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
      format: string
      in: query
      name: miles_range
      required: false
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: '-'
        targetAlias: miles
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            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
      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
      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
      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
      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
      format: string
      in: query
      name: msrp_range
      required: false
      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
      enum:
        - US
        - CA
        - us
        - ca
      in: query
      name: country
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: country
        transformConstraints:
          - maxLength: 2
            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
      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
      type: boolean
    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
      format: string
      in: query
      name: price_range
      required: false
      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)
      format: int32
      in: query
      maximum: 7000
      minimum: 0
      name: radius
      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
      type: string
    rank_miles_range:
      default: 1-
      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
      format: string
      in: query
      name: miles_range
      required: false
      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:
      default: 1-
      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
      format: string
      in: query
      name: price_range
      required: false
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: between
        separator: '-'
        targetAlias: price
        transformConstraints:
          - defaultMax: 100000
            defaultMin: 1000
            transformer: parseInt
            type: integer
    rows:
      default: 10
      description: Number of results to return. Default is 10. Max is 50
      format: int32
      in: query
      minimum: 0
      name: rows
      required: false
      type: integer
    search_text:
      description: To search a substring across entire document
      in: query
      name: search_text
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: false
        operator: equals
        targetAlias: long_text_copy_field
    sort_by:
      description: Sort by field. Default sort field is distance from the given point
      format: string
      in: query
      name: sort_by
      required: false
      type: string
    sort_order:
      description: Sort order - asc or desc. Default sort order is asc
      enum:
        - asc
        - desc
        - ASC
        - DESC
      format: string
      in: query
      name: sort_order
      required: false
      type: string
    source:
      description: To filter listing on their source
      in: query
      name: source
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: source
        transformConstraints:
          - transformer: urlTransformer
            type: string
    start:
      default: 0
      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
      format: int32
      in: query
      minimum: 0
      name: start
      required: false
      type: integer
    state:
      description: To filter listing on State in which they are listed
      in: query
      name: state
      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
      type: string
    stock_no:
      description: To filter listing on their stock number on lot
      in: query
      name: stock_no
      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
      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
      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
      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
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: trim_r_ss
        transformConstraints:
          - transformer: caseTransformer
            type: string
    vehicle_type:
      description: To filter listing on their vehicle type
      in: query
      name: vehicle_type
      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
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: vin
        transformConstraints:
          - maxLength: 17
            transformer: caseTransformer
            type: string
    year:
      description: To filter listing on their year
      in: query
      minLength: 4
      name: year
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: year
        transformConstraints:
          - max: 2121
            min: 1800
            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
      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
      type: string
    zip:
      description: To filter listing on ZIP around which they are listed
      in: query
      name: zip
      type: string
      x-field-config:
        isConfigurable: true
        isMultiValued: true
        operator: in
        separator: ','
        targetAlias: zip
        transformConstraints:
          - transformer: caseTransformer
            type: string
  requestBodies:
    CarRankRequest:
      content:
        application/json:
          schema:
            $ref: '#/definitions/CarRankRequest'
      description: Inputs needed for ranking a group of car listings
      required: true