GET /search/car/incentive/oem

To filter listing on acquisition fee of the car

The API Authentication Key. Mandatory with all API calls.

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

To filter listing on cashback amounts listed in offer

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

To filter listing on City in which they are listed

To filter listing on Country in which they are listed

Constraints: {'enum': ['US', 'CA', 'us', 'ca']}

To filter listing on any contribution from dealer's side

To filter listing on disposition fee of the car

To filter listing on down payment offer on car

To filter listing on total amount due at signing, that usually includes first month payment, down payment, acquisition fee etc

To filter listing on offer duration in months

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

Constraints: {'enum': ['count', 'index']}

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.

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

To filter listing on gross capitalised cost of the car

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

Latitude component of location

To filter listing on amount at the lease end to pay for buying the car

Longitude component of location

To filter listings on their make

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

To filter listing on mileage charge limit the offer is valid up to under the default clauses

To filter listings on their model

To filter listing on Monthly payment amount, usually populated in Lease offers

To filter listing on monthly amount to be paid by customer for every $1000 financed at the advertised APR rate

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

To filter listing on net capitalised cost of the car

The type of the incentive

Constraints: {'enum': ['lease', 'finance', 'cash']}

Radius around the search location (Unit - Miles)

Constraints: {'minimum': 0, 'maximum': 7000}

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.

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

Constraints: {'minimum': 0}

To search a substring across entire document

To filter listing on security deposit required for the offer

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

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

Constraints: {'enum': ['asc', 'desc', 'ASC', 'DESC']}

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

Constraints: {'minimum': 0}

To filter listing on State in which they are listed

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.

To filter listing on gross capitalised cost of the car

To filter listing on their trim

To filter listing on their year

Constraints: {'minLength': 4}

To filter listing on ZIP around which they are listed