Compute relative rank for car listings.

POST

/search/car/active/rank

Rank Car Listings

Computer rank for car listings based on inputs provided.Weights for ranking parameters can also be provided.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://marketcheck-prod.apigee.net/v2/search/car/active/rank' \
--header 'Content-Type: application/json' \
--data-raw '{
    "listing_ids": [
        "string"
    ],
    "ranking_criteria": {}
}'

Response Example

200 - Example 1

{
    "num_ranked": 0,
    "ranked_listings": [
        {
            "ranked_listing": {}
        }
    ]
}

Request

Query Params

api_key

string

optional

The API Authentication Key. Mandatory with all API calls.

append_api_key

string

optional

Flag on whether to include api_key in response API urls (if any)

latitude

number

optional

Latitude component of location

longitude

number

optional

Longitude component of location

radius

integer

optional

Radius around the search location (Unit - Miles)

zip

string

optional

To filter listing on ZIP around which they are listed

include_lease

string

optional

Boolean param to search for listings that include leasing options in them

include_finance

string

optional

Boolean param to search for listings that include finance options in them

lease_term

string

optional

Search listings with exact lease term, or inside a range with min and max seperated by a dash like lease_term=30-60

lease_down_payment

string

optional

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

lease_emp

string

optional

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

finance_loan_term

string

optional

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

finance_loan_apr

string

optional

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

finance_emp

string

optional

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

finance_down_payment

string

optional

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

finance_down_payment_per

string

optional

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

car_type

string

optional

Car type. Allowed values are - new / used / certified

carfax_1_owner

string

optional

Indicates whether car has had only one owner or not

carfax_clean_title

string

optional

Indicates whether car has clean ownership records

year

string

optional

To filter listing on their year

make

string

optional

To filter listings on their make

model

string

optional

To filter listings on their model

trim

string

optional

To filter listing on their trim

vin

string

optional

To filter listing on their VIN

body_type

string

optional

To filter listing on their body type

body_subtype

string

optional

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

vehicle_type

string

optional

To filter listing on their vehicle type

vins

string

optional

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

string

optional

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

string

optional

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.

match

string

optional

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

cylinders

string

optional

To filter listing on their cylinders

transmission

string

optional

To filter listing on their transmission

doors

string

optional

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

drivetrain

string

optional

To filter listing on their drivetrain

exterior_color

string

optional

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_color

string

optional

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

base_exterior_color

string

optional

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_color

string

optional

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

engine

string

optional

To filter listing on their engine

engine_size

string

optional

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

engine_aspiration

string

optional

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

engine_block

string

optional

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

highway_mpg_range

string

optional

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

city_mpg_range

string

optional

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

miles_range

string

optional

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

price_range

string

optional

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

msrp_range

string

optional

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

dom_range

string

optional

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

string

optional

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

sort_order

string

optional

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

rows

integer

optional

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

start

integer

optional

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

include_non_vin_listings

string

optional

To include non vin listings. Default is false

msa_code

string

optional

To filter listing on msa code in which they are listed

facets

string

optional

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_facets

string

optional

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

string

optional

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

stats

string

optional

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.

country

string

optional

To filter listing on Country in which they are listed

plot

string

optional

If plot has value true results in around 25k coordinates with limited fields to plot respective graph

nodedup

string

optional

If nodedup is set to true then API will give results without is_searchable i.e multiple listings for single vin

dedup

string

optional

If dedup is set to true then will give results with is_searchable irrespecive of dealer_id or source

owned

string

optional

Used in combination with dealer_id or source, when true returns the listings actually owned by dealer himself

state

string

optional

To filter listing on State in which they are listed

city

string

optional

To filter listing on City in which they are listed

trim_o

string

optional

Filter listings on web scraped trim

trim_r

string

optional

Filter trim on custom possible matches

dom_active_range

string

optional

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

dom_180_range

string

optional

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

exclude_certified

string

optional

Boolean param to exclude certified cars from search results

fuel_type

string

optional

To filter listing on their fuel type

dealer_type

string

optional

Filter based on dealer type independant or franchise

photo_links

string

optional

A boolean indicating whether to include only those listings that have photo_links in search results, And discard those that don't have them

photo_links_cached

string

optional

A boolean indicating whether to include only those listings that have photo_links_cached in search results, And discard those that don't have them

stock_no

string

optional

To filter listing on their stock number on lot

last_seen_range

string

optional

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_range

string

optional

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

first_seen_at_source_range

string

optional

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

first_seen_at_mc_range

string

optional

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

last_seen_days

string

optional

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_days

string

optional

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

first_seen_at_source_days

string

optional

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

first_seen_at_mc_days

string

optional

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

inventory_type

string

optional

To filter listing on their condition. Either used or new

page

number

optional

Page number to fetch the results for the given criteria. Default is 1.

Body Params application/json

Ranking query request

listing_ids

array[string]

optional

ranking_criteria

object

optional

Examples

Responses

🟢200Rank listings based on inputs provided.

application/json

Body

Ranking query response

num_ranked

integer

optional

The number of listings ranked

ranked_listings

array[object (CarListingRank) {1}]

optional

ranked_listing

object

optional

🔴500Error

Modified at 2023-08-15 07:36:55

Price, Miles and Days on Market stats

Compute relative rank for car listings.