v1

latestOpenAPI 3.0.02026-07-147195292.0 KB
RV Search

Gets active RV listings for the given search criteria

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
get/search/rv/uk/active

Query parameters

api_keystring

The API Authentication Key. Mandatory with all API calls.

price_rangestring string

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

miles_rangestring string

Miles range to filter listings with miles in the given range. Range to be given in the format - min-max e.g. 1000-5000

msrp_rangestring string

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

year_rangestring string

Year range to filter listings with the year in the range given. Range to be given in the format - min-max e.g. 2019-2021

search_textstring

To search a substring across entire document

latitudenumber double

Latitude component of location

longitudenumber double

Longitude component of location

radiusinteger

Radius around the search location (Unit - Miles)

yearstring

To filter listing on their year

makestring

To filter listings on their make

modelstring

To filter listings on their model

vinstring

To filter listing on their VIN

sourcestring

To filter listing on their source

dealer_namestring

Filter listings on dealer_name

dealer_idstring string

Dealer id to filter the listings.

exterior_colorstring

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

interior_colorstring

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

engine_sizestring

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

fuel_typestring

To filter listing on their fuel type

categorystring

Filter RV listings on category

statestring

To filter listing on State in which they are listed

citystring

To filter listing on City in which they are listed

countystring

To filter listing on county in which they are listed

postal_codestring

To filter listing on postal code around which they are listed

zipstring

To filter listing on ZIP around which they are listed

sort_bystring string

Sort by field. Default sort field is distance from the given point

sort_order'asc' | 'desc' | 'ASC' | 'DESC' string

Sort order - asc or desc. Default sort order is asc

rowsinteger

Number of results to return. Default is 10. Max is 50

startinteger

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

facetsstring

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.

range_facetsstring

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.

facet_sort'count' | 'index'

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

statsstring

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.

last_seen_rangestring string

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

first_seen_rangestring string

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

last_seen_daysstring string

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

first_seen_daysstring string

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

base_exterior_colorstring

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

base_interior_colorstring

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

seating_capacitystring string

To filter on vehicle seating capacity

cylindersstring

To filter listing on their cylinders

doorsstring string

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

mtplmstring

To filter rv on mtplm

sub_categorystring

To filter rv on their sub-category

availability_statusstring

To filter rv on their availability_status

berthsstring

To filter rv on their berths

inventory_type'used' | 'new'

To filter listing on their condition. Either used or new

width_rangestring string

width range to filter listings on width in the range given. Range to be given in the format - min-max e.g. 4-8

exterior_length_rangestring string

width range to filter listings on exterior_length in the range given. Range to be given in the format - min-max e.g. 4-8

interior_length_rangestring string

width range to filter listings on interior_length in the range given. Range to be given in the format - min-max e.g. 4-8

drive_typestring

To filter rv on their drive_type

steeringstring

To filter rv on their steering

chassisstring

To filter rv on their chassis

transmissionstring

To filter listing on their transmission

Response

List of all RV listings matching the search & filter criteria

facetsobject
num_foundinteger

The number of listings found

range_facetsobject
statsobject