v1

latestOpenAPI 3.0.02026-07-147195292.0 KB
Dealer API

Find car dealers around

The dealers API returns a list of dealers around a given point and radius.

get/dealers/car

Query parameters

api_keystring

The API Authentication Key. Mandatory with all API calls.

latitudenumber double

Latitude component of location

longitudenumber double

Longitude component of location

radiusinteger

Radius around the search location (Unit - Miles)

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

country'US' | 'CA' | 'us' | 'ca' | 'uk' | 'england' | 'scotland' | 'northan ireland' | 'wales'

To filter listing on Country in which they are listed

dealer_type'franchise' | 'independent'

Filter based on dealer type independant or franchise

citystring

To filter listing on City in which they are listed

statestring

To filter listing on State in which they are listed

listing_count_rangestring string

To filter dealers based on their inventory size. Range can be given in the format - min-max e.g. 50-100

inventory_urlstring string

inventory_url of dealer to be searched

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

providerboolean

boolean param to include site providers name in response

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.

Response

List of dealers for the search

num_foundinteger

number of dealers found