marketcheck_ruby_client 1.0.7

data/docs/Error.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **Float** | Error code | [optional] 
+**message** | **String** | Error message | [optional] 
+
+

data/docs/FacetItem.md

@@ -0,0 +1,9 @@
+# SwaggerClient::FacetItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item** | **String** | Facet item | [optional] 
+**count** | **Float** | Facet item count | [optional] 
+
+

data/docs/FacetsApi.md

@@ -0,0 +1,71 @@
+# SwaggerClient::FacetsApi
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_facets**](FacetsApi.md#get_facets) | **GET** /facets | Facets
+
+
+# **get_facets**
+> Array<FacetItem> get_facets(api_key, fields, opts)
+
+Facets
+
+[Merged with the /search API - Please check the 'facets' parameter to the Search API above] Get the facets for the given simple filter criteria (by given VIN's basic specification, Or by Year, Make, Model, Trim criteria) and facet fields
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::FacetsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+fields = "fields_example" # String | Comma separated list of fields to generate facets for. Supported fields are - year, make, model, trim, exterior_color, interior_color, drivetrain, vehicle_type, car_type, body_style, body_subtype, doors
+
+opts = { 
+  vin: "vin_example", # String | VIN as a reference to the type of car for which facets data is to be returned
+  year: "year_example", # String | Year of the car
+  make: "make_example", # String | Make of the car
+  model: "model_example", # String | Model of the Car
+  trim: "trim_example" # String | Trim of the Car
+}
+
+begin
+  #Facets
+  result = api_instance.get_facets(api_key, fields, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling FacetsApi->get_facets: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **fields** | **String**| Comma separated list of fields to generate facets for. Supported fields are - year, make, model, trim, exterior_color, interior_color, drivetrain, vehicle_type, car_type, body_style, body_subtype, doors | 
+ **vin** | **String**| VIN as a reference to the type of car for which facets data is to be returned | [optional] 
+ **year** | **String**| Year of the car | [optional] 
+ **make** | **String**| Make of the car | [optional] 
+ **model** | **String**| Model of the Car | [optional] 
+ **trim** | **String**| Trim of the Car | [optional] 
+
+### Return type
+
+[**Array<FacetItem>**](FacetItem.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/GraphsApi.md

@@ -0,0 +1,73 @@
+# SwaggerClient::GraphsApi
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_price_miles_plot_data**](GraphsApi.md#get_price_miles_plot_data) | **GET** /plots | Price, Miles plots data for given criteria
+
+
+# **get_price_miles_plot_data**
+> Array<PlotPoint> get_price_miles_plot_data(api_key, car_type, opts)
+
+Price, Miles plots data for given criteria
+
+Get price, miles plot data for active cars matching the given VIN's basic specification or Year, Make, Model, Trim (Optional) criteria
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::GraphsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+car_type = "car_type_example" # String | Car type to get the scatter plot data for
+
+opts = { 
+  vin: "vin_example", # String | VIN as a reference to the type of car for which plot data is to be returned
+  year: "year_example", # String | Year of the car
+  make: "make_example", # String | Make of the car
+  model: "model_example", # String | Model of the Car
+  trim: "trim_example", # String | Trim of the Car
+  rows: "rows_example" # String | Number of results to return. Default is 1000. Max is 10000
+}
+
+begin
+  #Price, Miles plots data for given criteria
+  result = api_instance.get_price_miles_plot_data(api_key, car_type, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling GraphsApi->get_price_miles_plot_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **car_type** | **String**| Car type to get the scatter plot data for | 
+ **vin** | **String**| VIN as a reference to the type of car for which plot data is to be returned | [optional] 
+ **year** | **String**| Year of the car | [optional] 
+ **make** | **String**| Make of the car | [optional] 
+ **model** | **String**| Model of the Car | [optional] 
+ **trim** | **String**| Trim of the Car | [optional] 
+ **rows** | **String**| Number of results to return. Default is 1000. Max is 10000 | [optional] 
+
+### Return type
+
+[**Array<PlotPoint>**](PlotPoint.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/HistoricalListing.md

@@ -0,0 +1,19 @@
+# SwaggerClient::HistoricalListing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier representing a specific listing from the Marketcheck database | [optional] 
+**price** | **String** | Asking price for the car | [optional] 
+**msrp** | **String** | MSRP for the car | [optional] 
+**miles** | **String** | Odometer reading / reported miles usage for the car | [optional] 
+**vdp_url** | **String** | Vehicle Details Page url of the specific car | [optional] 
+**seller_name** | **String** | Seller name of the listing from the Marketcheck database | [optional] 
+**scraped_at** | **Float** | Listing scraped at timestamp | [optional] 
+**last_seen_at** | **Float** | Listing last seen at (most recent) timestamp | [optional] 
+**source** | **String** | Source website for the listing | [optional] 
+**city** | **String** | City of the listing | [optional] 
+**state** | **String** | State of the listing | [optional] 
+**zip** | **String** | Zip of the listing | [optional] 
+
+

data/docs/HistoryApi.md

@@ -0,0 +1,65 @@
+# SwaggerClient::HistoryApi
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**history**](HistoryApi.md#history) | **GET** /history/{vin} | Get a cars online listing history
+
+
+# **history**
+> Array<HistoricalListing> history(api_key, vin, opts)
+
+Get a cars online listing history
+
+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
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::HistoryApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+vin = "vin_example" # String | The VIN to identify the car to fetch the listing history. Must be a valid 17 char VIN
+
+opts = { 
+  rows: 3.4, # Float | Number of results to return. Default is 10. Max is 50
+  page: 3.4 # Float | Page number to fetch the results for the given criteria. Default is 1.
+}
+
+begin
+  #Get a cars online listing history
+  result = api_instance.history(api_key, vin, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling HistoryApi->history: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **vin** | **String**| The VIN to identify the car to fetch the listing history. Must be a valid 17 char VIN | 
+ **rows** | [**Float**](.md)| Number of results to return. Default is 10. Max is 50 | [optional] 
+ **page** | [**Float**](.md)| Page number to fetch the results for the given criteria. Default is 1. | [optional] 
+
+### Return type
+
+[**Array<HistoricalListing>**](HistoricalListing.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/InventoryApi.md

@@ -0,0 +1,113 @@
+# SwaggerClient::InventoryApi
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_dealer_active_inventory**](InventoryApi.md#get_dealer_active_inventory) | **GET** /dealer/{dealer_id}/active/inventory | Dealer inventory
+[**get_dealer_historical_inventory**](InventoryApi.md#get_dealer_historical_inventory) | **GET** /dealer/{dealer_id}/historical/inventory | Dealer's historical inventory
+
+
+# **get_dealer_active_inventory**
+> BaseListing get_dealer_active_inventory(api_key, dealer_id, opts)
+
+Dealer inventory
+
+Get a dealer's currently active inventory
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::InventoryApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+dealer_id = "dealer_id_example" # String | Id representing the dealer to fetch the active inventory for
+
+opts = { 
+  rows: "rows_example", # String | Number of results to return. Default is 10. Max is 50
+  start: "start_example" # String | Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows
+}
+
+begin
+  #Dealer inventory
+  result = api_instance.get_dealer_active_inventory(api_key, dealer_id, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling InventoryApi->get_dealer_active_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **dealer_id** | **String**| Id representing the dealer to fetch the active inventory for | 
+ **rows** | **String**| Number of results to return. Default is 10. Max is 50 | [optional] 
+ **start** | **String**| Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows | [optional] 
+
+### Return type
+
+[**BaseListing**](BaseListing.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_dealer_historical_inventory**
+> BaseListing get_dealer_historical_inventory(dealer_id)
+
+Dealer's historical inventory
+
+[v1 : Not Implemented Yet] - Get a dealer's historical inventory
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::InventoryApi.new
+
+dealer_id = "dealer_id_example" # String | Id representing the dealer to fetch the active inventory for
+
+
+begin
+  #Dealer's historical inventory
+  result = api_instance.get_dealer_historical_inventory(dealer_id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling InventoryApi->get_dealer_historical_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dealer_id** | **String**| Id representing the dealer to fetch the active inventory for | 
+
+### Return type
+
+[**BaseListing**](BaseListing.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Listing.md

@@ -0,0 +1,23 @@
+# SwaggerClient::Listing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier representing a specific listing from the Marketcheck database | [optional] 
+**heading** | **String** | Listing heading | [optional] 
+**vin** | **String** | VIN for the car | [optional] 
+**stock_no** | **String** | Stock no of the car | [optional] 
+**price** | **String** | Asking price for the car | [optional] 
+**msrp** | **String** | MSRP for the car | [optional] 
+**miles** | **String** | Odometer reading / reported miles usage for the car | [optional] 
+**vdp_url** | **String** | Vehicle Details Page url of the specific car | [optional] 
+**source** | **String** | Source domain of the listing | [optional] 
+**is_certified** | **Integer** | Flag indicating whether the car is Certified | [optional] 
+**dom** | **Float** | Days on Market value for the car based on current and historical listings found in the Marketcheck database for this car | [optional] 
+**build** | [**Build**](Build.md) | Build / Specifications attributes | [optional] 
+**media** | [**ListingMedia**](ListingMedia.md) | Car Media Attributes - main photo link/url and photo links | [optional] 
+**extra** | [**ListingExtraAttributes**](ListingExtraAttributes.md) | Extra attributes for the listing - options, features, seller comments etc | [optional] 
+**dealer** | [**Dealer**](Dealer.md) |  | [optional] 
+**car_location** | [**Location**](Location.md) | Car location data. Included only if its a different location to the dealers location | [optional] 
+
+

data/docs/ListingDebugAttributes.md

@@ -0,0 +1,13 @@
+# SwaggerClient::ListingDebugAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**robot_id** | **Float** | Robot id | [optional] 
+**cycle_id** | **Float** | Cycle id | [optional] 
+**scraped_at** | **String** | Scraped date and time | [optional] 
+**template_id** | **Float** | Template id | [optional] 
+**user_id** | **Float** | User id | [optional] 
+**taxonomy_vin** | **String** | Taxonomy vin | [optional] 
+
+

data/docs/ListingExtraAttributes.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ListingExtraAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | **Array<String>** | Installed Options of the car | [optional] 
+**features** | **Array<String>** | List of Features available with the car | [optional] 
+**seller_comment** | **String** | Seller comment for the car | [optional] 
+
+

data/docs/ListingMedia.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ListingMedia
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**photo_link** | **String** | Single photo url of the car | [optional] 
+**photo_links** | **Array<String>** | A list of photo urls for the car | [optional] 
+
+

data/docs/ListingVDP.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ListingVDP
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**html** | **String** | The HTML string for the listing web page | [optional] 
+**crawled_at** | **Float** | The timestamp indicating the time when the VDP was cached | [optional] 
+**vdp_url** | **String** | The URL of the VDP | [optional] 
+
+

data/docs/ListingsApi.md

@@ -0,0 +1,324 @@
+# SwaggerClient::ListingsApi
+
+All URIs are relative to *http://api.marketcheck.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_listing**](ListingsApi.md#get_listing) | **GET** /listing/{id} | Listing by id
+[**get_listing_extra**](ListingsApi.md#get_listing_extra) | **GET** /listing/{id}/extra | Long text Listings attributes for Listing with the given id
+[**get_listing_media**](ListingsApi.md#get_listing_media) | **GET** /listing/{id}/media | Listing media by id
+[**get_listing_vdp**](ListingsApi.md#get_listing_vdp) | **GET** /listing/{id}/vdp | Get listing HTML
+[**search**](ListingsApi.md#search) | **GET** /search | Gets active car listings for the given search criteria
+
+
+# **get_listing**
+> Listing get_listing(api_key, id)
+
+Listing by id
+
+Get a particular listing by its id
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::ListingsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+id = "id_example" # String | Listing id to get all the listing attributes
+
+
+begin
+  #Listing by id
+  result = api_instance.get_listing(api_key, id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ListingsApi->get_listing: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **id** | **String**| Listing id to get all the listing attributes | 
+
+### Return type
+
+[**Listing**](Listing.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_listing_extra**
+> ListingExtraAttributes get_listing_extra(api_key, id)
+
+Long text Listings attributes for Listing with the given id
+
+Get listing options, features, seller comments
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::ListingsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+id = "id_example" # String | Listing id to get all the long text listing attributes
+
+
+begin
+  #Long text Listings attributes for Listing with the given id
+  result = api_instance.get_listing_extra(api_key, id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ListingsApi->get_listing_extra: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **id** | **String**| Listing id to get all the long text listing attributes | 
+
+### Return type
+
+[**ListingExtraAttributes**](ListingExtraAttributes.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_listing_media**
+> ListingMedia get_listing_media(api_key, id)
+
+Listing media by id
+
+Get listing media (photo, photos) by id
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::ListingsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+id = "id_example" # String | Listing id to get all the listing attributes
+
+
+begin
+  #Listing media by id
+  result = api_instance.get_listing_media(api_key, id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ListingsApi->get_listing_media: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **id** | **String**| Listing id to get all the listing attributes | 
+
+### Return type
+
+[**ListingMedia**](ListingMedia.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_listing_vdp**
+> ListingVDP get_listing_vdp(api_key, id)
+
+Get listing HTML
+
+Cached HTML of the Vehicle Details Page (VDP) for the listing. The HTML is cached only for 7 days for all listings. So this API could be used to get HTML of mostly active listings and that have recently expired
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::ListingsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+id = "id_example" # String | Listing id to get the vehicle details page (VDP) HTML
+
+
+begin
+  #Get listing HTML
+  result = api_instance.get_listing_vdp(api_key, id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ListingsApi->get_listing_vdp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **id** | **String**| Listing id to get the vehicle details page (VDP) HTML | 
+
+### Return type
+
+[**ListingVDP**](ListingVDP.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **search**
+> SearchResponse search(api_key, latitude, longitude, radius, car_type, opts)
+
+Gets active car listings for the given search criteria
+
+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 1000 rows. \n The search API facilitates the following use cases - \n1. Search Cars around a given geo-point within a given radius \n2. Search cars for a specific year / make / model or combination of these \n3. Search cars matching multiple year, make, model combinatins in the same search request\n4. Filter results by most car specification attributes\n5. Search for similar cars by VIN or Taxonomy VIN \n6. Filter cars within a given price / miles / days on market (dom) range\n7. Specify a sort order for the results on price / miles / dom / listed date \n8. Search cars for a given City / State combination \n9. Get Facets to build the search drill downs \n10. Get Market averages for price/miles/dom/msrp for your search
+
+### Example
+```ruby
+# load the gem
+require 'marketcheck_ruby_client'
+
+api_instance = SwaggerClient::ListingsApi.new
+
+api_key = "api_key_example" # String | The API Authentication Key. Mandatory with all API calls.
+
+latitude = 1.2 # Float | Latitude component of location
+
+longitude = 1.2 # Float | Longitude component of location
+
+radius = 56 # Integer | Radius around the search location
+
+car_type = "car_type_example" # String | Car type. Allowed values are - new / used / certified
+
+opts = { 
+  year: "year_example", # String | Car year - 1980 onwards. You can pass in multiple year separated by comma e.g. 2010,2011
+  make: "make_example", # String | Car Make - should be a standard OEM Make name
+  model: "model_example", # String | Car model to search
+  trim: "trim_example", # String | Car trim to search
+  dealer_id: "dealer_id_example", # String | Dealer id to filter the cars
+  body_type: "body_type_example", # String | Body type to filter the cars on
+  body_subtype: "body_subtype_example", # String | Body subtype to filter the cars on
+  vehicle_type: "vehicle_type_example", # String | Vehicle type to filter the cars on
+  vins: "vins_example", # String | 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
+  taxonomy_vins: "taxonomy_vins_example", # String | 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.
+  ymmt: "ymmt_example", # String | 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.
+  cylinders: "cylinders_example", # String | Cylinders to filter the cars on
+  transmission: "transmission_example", # String | Transmission to filter the cars on. [a = Automatic, m = Manual]
+  drivetrain: "drivetrain_example", # String | Drivetrain to filter the cars on.
+  exterior_color: "exterior_color_example", # String | Exterior color to match
+  interior_color: "interior_color_example", # String | Interior color to match
+  miles_range: "miles_range_example", # String | Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000
+  price_range: "price_range_example", # String | Price range to filter cars with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000
+  dom_range: "dom_range_example", # String | 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
+  sort_by: "sort_by_example", # String | Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point
+  sort_order: "sort_order_example", # String | Sort order - asc or desc. Default sort order is distance from a point.
+  rows: "rows_example", # String | Number of results to return. Default is 10. Max is 50
+  start: "start_example", # String | Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows
+  facets: "facets_example", # String | The comma separated list of fields for which facets are requested. Supported fields are - year, make, model, trim, vehicle_type, car_type, body_type, body_subtype, drivetrain, cylinders, transmission, exterior_color, interior_color. 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.
+  stats: "stats_example" # String | The list of fields for which stats need to be generated based on the matching listings for the search criteria. Allowed fields are - price, miles, msrp, dom 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.
+}
+
+begin
+  #Gets active car listings for the given search criteria
+  result = api_instance.search(api_key, latitude, longitude, radius, car_type, opts)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling ListingsApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key** | **String**| The API Authentication Key. Mandatory with all API calls. | 
+ **latitude** | **Float**| Latitude component of location | 
+ **longitude** | **Float**| Longitude component of location | 
+ **radius** | [**Integer**](.md)| Radius around the search location | 
+ **car_type** | **String**| Car type. Allowed values are - new / used / certified | 
+ **year** | **String**| Car year - 1980 onwards. You can pass in multiple year separated by comma e.g. 2010,2011 | [optional] 
+ **make** | **String**| Car Make - should be a standard OEM Make name | [optional] 
+ **model** | **String**| Car model to search | [optional] 
+ **trim** | **String**| Car trim to search | [optional] 
+ **dealer_id** | **String**| Dealer id to filter the cars | [optional] 
+ **body_type** | **String**| Body type to filter the cars on | [optional] 
+ **body_subtype** | **String**| Body subtype to filter the cars on | [optional] 
+ **vehicle_type** | **String**| Vehicle type to filter the cars on | [optional] 
+ **vins** | **String**| 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 | [optional] 
+ **taxonomy_vins** | **String**| 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. | [optional] 
+ **ymmt** | **String**| 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. | [optional] 
+ **cylinders** | **String**| Cylinders to filter the cars on | [optional] 
+ **transmission** | **String**| Transmission to filter the cars on. [a = Automatic, m = Manual] | [optional] 
+ **drivetrain** | **String**| Drivetrain to filter the cars on. | [optional] 
+ **exterior_color** | **String**| Exterior color to match | [optional] 
+ **interior_color** | **String**| Interior color to match | [optional] 
+ **miles_range** | **String**| Miles range to filter cars with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000 | [optional] 
+ **price_range** | **String**| Price range to filter cars with the price in the range given. Range to be given in the format - min-max e.g. 1000-5000 | [optional] 
+ **dom_range** | **String**| 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 | [optional] 
+ **sort_by** | **String**| Sort by field - allowed fields are distance|price|miles|dom|age|posted_at|year. Default sort field is distance from the given point | [optional] 
+ **sort_order** | **String**| Sort order - asc or desc. Default sort order is distance from a point. | [optional] 
+ **rows** | **String**| Number of results to return. Default is 10. Max is 50 | [optional] 
+ **start** | **String**| Page number to fetch the results for the given criteria. Default is 1. Pagination is allowed only till first 1000 results for the search and sort criteria. The page value can be only between 1 to 1000/rows | [optional] 
+ **facets** | **String**| The comma separated list of fields for which facets are requested. Supported fields are - year, make, model, trim, vehicle_type, car_type, body_type, body_subtype, drivetrain, cylinders, transmission, exterior_color, interior_color. 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. | [optional] 
+ **stats** | **String**| The list of fields for which stats need to be generated based on the matching listings for the search criteria. Allowed fields are - price, miles, msrp, dom 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. | [optional] 
+
+### Return type
+
+[**SearchResponse**](SearchResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+