AutoVision is a unified dealer management software platform built from the ground up for dealers and automotive companies of all shapes and sizes to automate and optimize their car buying, selling, and vehicle inventory management with a modular suite of interlocking tools, APIs and deep statistical insights.
\nYou must be an AutoVision customer to use the AutoVision API. If you are not already a customer, contact us here: https://www.autovision.com/contact-autovision
\nIf you are an existing customer and would like direct access to the API, contact your sales or support representative directly.
\nIn order to make requests to the AutoVision API you will need to be provided with:
\nAn AutoVision Account
\nAn API hostname
\nAn API Key & CompanyId for your Account
\nA list of Scopes your Account and API key are authorized for
\nAPI Key must be placed in every request header.
\nYour API key may be used to make requests for your AutoVision Account and any authorized Sub-Accounts.
\nVia Scopes, your Account and API key will be authorized for specific API methods, and in the context of individual API methods, may be authorized for some or all response data elements.
\nWhen executing any API method, the primary Scope required for the method must be specified. Sub-scopes specified will determine whether subordinate data elements are returned in the response.
\nAny API request will fail if any Scope specified in the request is not authorized for the specified Account (identified by CompanyId) and API Key.
\nIf you are using Postman, configure the API hostname, API Key, and CompanyId you received in the appropriate Variables in the collection. The variables are setup at the collection level so you should not have to specify them on every request.
\nAll URIs are structured like the following:
\nhttps://[Hostname]/api/public/[Version]/[CompanyId]/some-method-specific-uri
\nHostname: Specific to staging vs. production environments
\nVersion: API version (Currently v2. Individual API methods may be versioned independently in the future)
\nCompanyId: CompanyId for the AutoVision Account to which your API Key was assigned
\nUnless otherwise noted, all requests are:
\nHttp Method: POST
\nRequired HTTP Headers:
\napi-key: [your-api-key]
\nContent-Type: application/json
\nRequest Body: JSON request object
\nAll JSON requests will have a similar structure, although Sopes and Request format will be method-specific.
\n{\n \"Scopes\": [\n \"[primary-scope]\",\n \"[optionally-one-or-more-sub-scopes\",\n ],\n \"Request\": {\n }\n}\n\nAll API requests should return HTTP 200 responses unless the API is unavailable (e.g. for maintenance).
\nAll JSON responses will have a similar structure, although Response format will be method-specific. Failed requests will return only the Errors node. Successful requests will return only the Response node.
\n{\n \"errors\": [\n ],\n \"response\": {\n }\n}\n\ncode int: Error code. Will correspond to standard HTTP error codes unless otherwise specified
\nmessage string: Error message
\ndetail string: Error details
\nNOTE: The language-specific example request to the right is a complete but blank request designed to show all available parameters and will not execute as-is. See below for several specific runnable examples.
\nSearch for vehicles currently listed at supported auctions including:
\nADESA
\nAlly
\nAuctionEdge
\nBid-a-Car
\nManheim
\nAuctionListings (Required): Primary Scope
\nAuctionListings.Export (Conditional): Export search results to a CSV or Excel format. Required for export to CSV/Excel formats.
\nAuctionListings.LiveData (Conditional): Include live auction data (Opening Bid, Current Bid, Buy Now Price). Required for including Live Auction Data in result.
\nScopes array[string] (Required): One or more Request Scopes
\nRequest object (Required): Request parameters
\nCompanyId string (Optional): Identifies the AutoVision Account in the context of which the request will be executed (used to default various request parameters). Defaults to CompanyId specified in URI, but the CompanyId of a subordinate AutoVision Account may be specified
\nCentralPostalCode string (Optional): Location at which to center search. Defaults to location of Account associated with CompanyId
\nMaxDistanceFromPostalCode int (Required): Maximum radius to search from center of CentralPostalCode.
\nNOTE on MaxDistanceFromPostalCode:
\nMinYear int (Optional): Include only results with minimum Model Year MinYear. Defaults to 1981. Accepted values: 1981 - next calendar year.
\nMaxYear int (Optional): Include only results with maximum Model Year MaxYear. Defaults to next calendar year. Accepted values: 1981 - next calendar year.
\nMinOdometer int (Optional): Include only results with minimum Odometer MinOdometer. No value or 0 is considered no restriction. Valid values 0 - 500,000
\nMaxOdometer int (Optional): Include only results with maximum Odometer MaxOdometer. No value or 0 is considered no restriction. Valid values 0 - 500,000
\nMinCR decimal (Optional): Include only results with minimum Condition Report Grade MinCR. No value or 0 is considered no restriction. Accepted values 0 - 5
\nMaxCR decimal (Optional): Include only results with maximum Condition Report Grade MaxCR. No value or 0 is considered no restriction. Accepted values 0 - 5
\nIncludeOnlyDataProviders array[string] (Required): Include only results from specified auction providers. Accepted values: \"ADESA\", \"Ally\", \"AuctionEdge\", \"Manheim\"
\nIncludeOnlyAuctionTypes array[string] (Optional): Include only results from auction types. Defaults to all accepted values. Accepted values: \"Simulcast\", \"Online\"
\nLiveAuctionData boolean (Optional): Include up-to-the-minute data for Opening Bid, Current Bid, Buy Now Price. Defaults to false. Requires Scope AuctionListings.LiveData**.** If specified as true, a Limit of 50 results will be enforced. Supported Auction Data Providers: Manheim, Ally
\nIncludeOnlyVins array[string] (Optional): Include only results for vehicles with matching VIN
\nIncludeOnlyWithoutAnnouncements array[string] (Optional): Include only results without specified Announcements. Accepted values: AsIs, GreenLight, FrameDamage, Salvage, BrandedTitle, Accidents, Damage, Rollback
\nIncludeOnlyBuyNowEligible bool (Optional): Include only vehicles with \"Buy Now\" price.
\nIncludeOnlyWithMakes array[string] (Optional): Include only vehicles with matching Make
\nIncludeOnlyWithModels array[string] (Optional): Include only vehicles with matching Model
\nIncludeOnlyWithTrims array[string] (Optional): Include only vehicles with matching Trim
\nIncludeOnlyWithBodyStyles array[string] (Optional): Include only vehicles with matching Bodystyle
\nIncludeOnlyWithEngines array[string] (Optional): Include only vehicles with matching Engine
\nIncludeOnlyWithTransmissions array[string] (Optional): Include only vehicles with matching Transmission
\nIncludeOnlyWithDrivetrains array[string] (Optional): Include only vehicles with matching Drivetrain
\nIncludeOnlyWithFuelTypes array[string] (Optional): Include only vehicles with matching Fuel Type
\nIncludeOnlyWithExtColors array[string] (Optional): Include only vehicles with matching Exterior Color
\nIncludeOnlyWithIntColors array[string] (Optional): Include only vehicles with matching Interior Color
\nIncludeOnlyWithOdometerBands array[string] (Optional): Include only vehicles with matching Odometer Band
\nIncludeOnlyAuctionIds array[string] (Optional): Include only vehicles with matching Auction
\nIncludeOnlySaleDates array[string] (Optional): Include only vehicles with matching Sale Date
\nIncludeOnlyWithRuns array[string] (Optional): Include only vehicles with matching Run
\nIncludeOnlyWithLanes array[string] (Optional): Include only vehicles with with matching Lane
\nIncludeOnlyWithActiveUnits array[string] (Optional): Include only vehicles with matching Active Unit range
\nIncludeOnlyWithMds array[string] (Optional): Include only vehicles with matching Market Days Supply Range
\nIncludeOnlyWithDts array[string] (Optional): Include only vehicles with matching Estimated Days to Sell Range
\nIncludeOnlyWithEstRetailValue array[string] (Optional): Include only vehicles with matching Estimated Retail Value Range
\nIncludeOnlyWithEstWholesaleValue array[string] (Optional): Include only vehicles with matching Estimated Wholesale Value Range
\nIncludeOnlyWithProfitPotential array[string] (Optional): Include only vehicles with matching Estimated Profit Potential Range (based on Estimated Retail Value and Estimated Wholesale Value)
\nIncludeOnlyWithSoldPtm30 array[string] (Optional): Include only vehicles with matching Sold Percent to Market Range (Last 30 days)
\nIncludeOnlyWithProfitPotentialSoldPtm30 array[string] (Optional): Include only vehicles with matching Profit Potential Range (based on Estimated Wholesale Value and Sold PTM 30)
\nIncludeOnlyWithCtmPotential array[string] (Optional): Include only vehicles with matching Potential Cost to Market Range (based on Estimated Retail and Wholesale values)
\nIncludeOnlyWithProjectedCtm array[string] (Optional): Include only vehicles with matching Projected Cost to Market Range (based on Estimated Retail and Wholesale values)
\nIncludeOnlyWithBuyNowPrice array[string] (Optional): Include only vehicles with matching Buy Now Price Range
\nIncludeOnlyWithBuyNowProfitPotential array[string] (Optional): Include only vehicles with matching Profit Potential Range (based on Estimated Retail Value and Buy Now Price)
\nIncludeOnlyWithBuyNowProjectedProfit array[string] (Optional): Include only vehicles with matching Projected Profit Range (based on Estimated Retail Value and Buy Now Price)
\nIncludeOnlyWithBuyNowCtmPotential array[string] (Optional): Include only vehicles with matching Potential Cost to Market Range (based on Estimated Retail Value and Buy Now Price)
\nIncludeOnlyWithBuyNowProjectedCtm array[string] (Optional): Include only vehicles with matching Projected Cost to Market Range (based on Estimated Retail Value and Buy Now Price)
\nIncludeOnlyWithOpeningBid array[string] (Optional): Include only vehicles with matching Opening Bid Range
\nIncludeOnlyWithOpeningBidProfitPotential array[string] (Optional): Include only vehicles with matching Profit Potential Range (based on Estimated Retail Value and Opening Bid)
\nIncludeOnlyWithOpeningBidProjectedProfit array[string] (Optional): Include only vehicles with matching Projected Profit Range (based on Estimated Retail Value and Opening Bid)
\nIncludeOnlyWithOpeningBidCtmPotential array[string] (Optional): Include only vehicles with matching Potential Cost to Market Range (based on Estimated Retail Value and Opening Bid)
\nIncludeOnlyWithOpeningBidProjectedCtm array[string] (Optional): Include only vehicles with matching Projected Cost to Market Range (based on Estimated Retail Value and Opening Bid)
\nNOTE on IncludeOnlyWith[Facet]: Unless accepted values are explicitly specified above: Any request will return results indicating the availability of any given value in the selected market, as well as the available values in the selected market.
\nCostEstimation object (Optional): Reconditioning and Transport Cost estimation parameters may be configured in the AutoVision Account associated with CompanyId and/or may be specified here. If specified in the request, all values from the CostEstimation will be used, even if blank. If not specified in the request, all values from the AutoVision Account configuration will be used.
\nPackDefaultAmount int (Optional): Default Pack. Defaults to 0
\nEstimateTransport boolean (Conditional): Include Estimated Transport Cost in Cost Estimation. Required to be specified as true if any Transport-related parameters (below) are included. Defaults to false
\nTransportEstimateType string (Conditional): Required if EstimateTransport is specified true. Accepted Values: MinimumPlusCostPerMile
\nTransportCostMinimum int (Required): Minimum Cost of Transport (Dollar amount)
\nTransportCostPerMile decimal (Optional): Additional Transport Cost per Mile (Dollar amount)
\nEstimateRecon boolean (Conditional): Include Estimated Reconditioning Cost in Cost Estimation. Required to be specified as true if any Reconditioning-related parameters (below) are included. Defaults to false
\nReconditioningEstimateType string (Conditional): Required if EstimateRecon is specified true. Model for estimating Reconditioning costs. Defaults to None. Accepted Values: Flat, Percent
\nReconditioningEstimateAmount decimal (Required): Estimated Reconditioning Cost (Dollar amount if ReconditioningEstimateType specified as Flat, Percent of Cost if ReconditioningEstimateType specified as Percent)
\nOrderBys array[object] (Optional): One or more result properties to order results by. Evaluated in the order specified
\nOrderBy string (Required): Property to order results by. Accepted Values: Odometer, MDS, DTS, EstRetailValue, EstWholesaleValue, UnitsInMarket, EstProfitPotential, SoldPTM30, EstProfitSoldPTM30, NewestFirst, OldestFirst, CR, Year, Make, Model, Trim, AuctionName, Lane, Run, CtmPotential, ProjectedCtm, BuyNowEligible, BuyNowPrice, BuyNowProfitPotential, BuyNowProjectedProfit, BuyNowCtmPotential, BuyNowProjectedCtm, OpeningBid, OpeningBidProfitPotential, OpeningBidProjectedProfit, OpeningBidCtmPotential, OpeningBidProjectedCtm, DistanceFromMe
\nDescending bool (Optional): Sort in Descending order. Ignored for NewestFirst, OldestFirst. Defaults to false.
\nOffset int (Conditional): First matching listing to return in the selected result set (ordered by OrderBys). Zero-based. Required unless OnlyCounts is specified as true
\nLimit int (Optional): Number of matching listings to return. Required unless OnlyCounts is specified as true. Accepted values: 1 - 500
\nNOTE on OrderBys, Offset, Limit: All matching listings will be ordered by OrderBys, and a selection of Limit restults will be returned starting at Offset. For example: To return the first 100 results, specify Offset: 0, Limit: 100. To return the next 100 results, specify Offset: 100, Limit: 100.
\nOnlyCounts bool (Optional): Return only counts
\nCountsBy array[object] (Conditional): List of aggregations to return counts by. Required if OnlyCounts specified as true. Accepted Values: YearMake, YearMakeModel, YearMakeModelTrim, YearMakeModelTrimBodystyle, YearMakeModelTrimBodystyleDrivetrain, MakeModel, MakeModelTrim, MakeModelTrimBodystyle, MakeModelTrimBodystyleDrivetrain
\nExample responses are provided as links due to the response size.
\nExample 1: Minimal request for closest 50 results at all Auctions within 100 miles of AutoVision Account Postal Code
\nRequest:
\n{\n \"Scopes\": [\n \"AuctionListings\",\n \"AuctionListings.LiveData\"\n ],\n \"Request\": {\n \"MaxDistanceFromPostalCode\": 100,\n \"IncludeOnlyDataProviders\": [\n \"Ally\",\n \"ADESA\",\n \"AuctionEdge\",\n \"BidACar\",\n \"Manheim\"\n ],\n \"IncludeOnlyAuctionTypes\": [\n \"Simulcast\",\n \"Online\"\n ],\n \"LiveAuctionData\": true,\n \"OrderBys\": [\n {\n \"OrderBy\": \"DistanceFromMe\",\n \"Descending\": false\n }\n ],\n \"Offset\": 0,\n \"Limit\": 50\n }\n}\n\nResponse: auction-listings-ex01-response.json
\nExample 2: Minimal request for counts of vehicles by Year/Make, Year/Make/Model, Year/Make/Model/Trim, Make/Model, and Make/Model/Trim at Manheim auctions within 50 miles of Postal Code 94546
\nRequest:
\n{\n \"Scopes\": [\n \"AuctionListings\"\n ],\n \"Request\": {\n \"CentralPostalCode\": \"94546\",\n \"MaxDistanceFromPostalCode\": 50,\n \"IncludeOnlyDataProviders\": [\n \"Manheim\"\n ],\n \"IncludeOnlyAuctionTypes\": [\n \"Simulcast\"\n ],\n \"onlyCounts\": true,\n \"countsBy\": [\n \"YearMake\",\n \"YearMakeModel\",\n \"YearMakeModelTrim\",\n \"MakeModel\",\n \"MakeModelTrim\"\n ]\n }\n}\n\nResponse: auction-listings-ex02-response.json
\nExample 3: Minimal request for a single vehicle by VIN, at any Auction Nationwide
\nRequest:
\n{\n \"Scopes\": [\n \"AuctionListings\",\n \"AuctionListings.LiveData\"\n ],\n \"Request\": {\n \"CompanyId\": \"\",\n \"CentralPostalCode\": \"94546\",\n \"MaxDistanceFromPostalCode\": 6000,\n \"IncludeOnlyDataProviders\": [\n \"Ally\",\n \"ADESA\",\n \"AuctionEdge\",\n \"BidACar\",\n \"Manheim\"\n ],\n \"IncludeOnlyAuctionTypes\": [\n \"Simulcast\",\n \"Online\"\n ],\n \"LiveAuctionData\": true,\n \"IncludeOnlyVins\": [\n \"SBM26ACA6MW815122\"\n ],\n \"OrderBys\": [\n {\n \"OrderBy\": \"DistanceFromMe\",\n \"Descending\": false\n }\n ],\n \"Offset\": 0,\n \"Limit\": 10\n }\n}\n\nResponse: auction-listings-ex03-response.json
Note that if the same vehicle is available at multiple auctions, all listings will be returned.
Example 4: Detailed request specifying multiple filter and sort parameters
\nRequest:
\n{\n \"Scopes\": [\n \"AuctionListings\",\n \"AuctionListings.LiveData\"\n ],\n \"Request\": {\n \"CentralPostalCode\": \"94546\",\n \"MaxDistanceFromPostalCode\": 100,\n \"MinYear\": 2010,\n \"MaxYear\": 2020,\n \"MinOdometer\": 0,\n \"MaxOdometer\": 150000,\n \"IncludeOnlyDataProviders\": [\n \"Manheim\"\n ],\n \"IncludeOnlyAuctionTypes\": [\n \"Simulcast\",\n \"Online\"\n ],\n \"IncludeOnlyVins\": [],\n \"IncludeOnlyWithoutAnnouncements\": [\n \"AsIs\",\n \"FrameDamage\",\n \"Salvage\",\n \"BrandedTitle\",\n \"Rollback\"\n ],\n \"IncludeOnlyWithMakes\": [\n \"Audi\",\n \"BMW\",\n \"Mercedes-Benz\"\n ],\n \"IncludeOnlyWithBodyStyles\": [\n \"Sedan\",\n \"Coupe\"\n ],\n \"IncludeOnlyWithEstRetailValue\": [\n \"04: 30k - 40k\",\n \"05: 40k - 50k\",\n \"06: 50k - 100k\"\n ],\n \"OrderBys\": [\n {\n \"OrderBy\": \"Make\",\n \"Descending\": false\n },\n {\n \"OrderBy\": \"EstProfitPotential\",\n \"Descending\": true\n }\n ],\n \"Offset\": 0,\n \"Limit\": 100\n }\n}\n\nResponse: auction-listings-ex04-response.json
\nerrors object: Errors object. Only included if request fails.
\nresponse object: Primary response object. Only included if request is successful.
\ntotalRecords int: Total listings that match search criteria
\nuiListViewArrays dictionary[string, array[object]]: Matching results by facet
\nkey string: Indicator of facet \"optionsFor[Facet]\"
\nvalue array[object]: Facet data
\ntext string:
\nid string:
\nisChecked boolean:
\nsortBy string:
\ntotal int:
\nselected int:
\nlistings array[object]: Detailed listings
\nbookValue int:
\nappraisalGap decimal:
\nactualCashValue decimal:
\ncarfaxDealerReport string:
\nnotes string:
\nauctionName string:
\nforeignAuctionId string:
\nauctionListingId string:
\nvehicleSaleUrl string:
\nlane string:
\nrun string:
\ncr decimal:
\nannouncements string:
\ndistance int:
\nsaleDate string:
\nauctionDataProvider string:
\ndoNotBuy bool:
\nisFavorite bool:
\naddedToBuyListBy string:
\ndoNotBuyBy string:
\nassignedTo string:
\nymmLocalMDS int:
\nymmLocalDTS int:
\nymmLocalMarket100 int:
\nymmLocalMarket100PricingError string:
\nymmWholesaleMarket100 int:
\nymmWholesaleMarket100PricingError string:
\nymmBusinessModelScore int:
\nymmInMarket int:
\nymmProfitPotential int:
\nymmBaseProfitPotential int:
\nymmSoldPTM30 decimal:
\nymmSoldPTM60 decimal:
\nymmEstProfitSoldPTM30 int:
\nymmEstProfitSoldPTM60 int:
\nwarrantyClass string:
\nfirstSeenTs int:
\nisNewResult bool:
\nctmPotential decimal:
\nprojectedCtm decimal:
\nbuyNowEligible bool:
\nbuyNowPrice int:
\nbuyNowProfitPotential decimal:
\nbuyNowProjectedProfit decimal:
\nbuyNowCtmPotential decimal:
\nbuyNowProjectedCtm decimal:
\nopeningBid int:
\nopeningBidProfitPotential int:
\nopeningBidProjectedProfit int:
\nopeningBidCtmPotential decimal:
\nopeningBidProjectedCtm decimal:
\nbidPlaced bool:
\ncurrentBid int:
\ncurrentBidProfitPotential decimal:
\ncurrentBidProjectedProfit decimal:
\ncurrentBidCtmPotential decimal:
\ncurrentBidProjectedCtm decimal:
\noverallClassification string:
\nmdsClassification string:
\nprofitClassification string:
\nvolumeClassification string:
\ndtsClassification string:
\nappraisalGuid string:
\nyear int:
\nmake string:
\nmodel string:
\ntrim string:
\ncanonicalTrim string:
\nbodyStyle string:
\nbodyType string:
\nbodySubType string:
\nvin string:
\nmileage int:
\nengine string:
\ndrivetrain string:
\ntransmission string:
\nfuelType string:
\nthumbnailUrl string:
\nymm string:
\nexteriorColor string:
\ninteriorColor string:
\nsalesPerson string:
\nappraisalStatus string:
\ntags string:
\nlockedByUserGuid string:
\nlockedTime string:
\nsoldRecords int:
\nSearch for vehicles currently in market.
\n","_postman_id":"5a314b29-7104-45ca-b5e8-49de418bcf99"}],"id":"925a4a12-fcc2-4383-9ed5-1d140d6169ec","description":"Search for vehicles from a variety of market including Retail, Wholesale, and For-Sale-By-Owner.
\n","_postman_id":"925a4a12-fcc2-4383-9ed5-1d140d6169ec"},{"name":"Market Analysis","item":[{"name":"Single Vehicle","item":[{"name":"Combined Report","id":"2b12941c-53be-4ef4-b6b8-5ea76433c35f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api-key"},{"key":"value","value":"[your-api-key]"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Scopes\": [\r\n \"RetailValuation\",\r\n \"RetailValuation.RmvMarket\",\r\n \"RetailValuation.RmvMarket.DetailedListings\",\r\n \"RetailValuation.RmvMarket.MarketTrends\",\r\n \"RetailValuation.MarketInsights\",\r\n \"RetailValuation.LocalMarket\",\r\n \"RetailValuation.ProfitabilityReport\",\r\n \"RetailValuation.ProfitabilityReport.EstimatedAuctionValue\",\r\n \"RetailValuation.ProfitabilityReport.EstimatedTransportCost\",\r\n \"RetailValuation.ProfitabilityReport.EstimatedReconCost\",\r\n \"RetailValuation.Artemis\"\r\n ],\r\n \"Request\": {\r\n \"CompanyId\": \"\",\r\n \"AppraisalId\": \"\",\r\n \"VIN\": \"\",\r\n \"VehicleDetails\": {\r\n \"Year\": 0,\r\n \"Make\": \"\",\r\n \"Model\": \"\",\r\n \"Trim\": \"\",\r\n \"BodyType\": \"\",\r\n \"BodySubType\": \"\",\r\n \"Engine\": \"\",\r\n \"Transmission\": \"\",\r\n \"Drivetrain\": \"\",\r\n \"FuelType\": \"\",\r\n \"Doors\": 0,\r\n \"InteriorColor\": \"\",\r\n \"ExteriorColor\": \"\",\r\n \"Msrp\": 0,\r\n \"Odometer\": 0,\r\n \"RetailPrice\": 0\r\n },\r\n \"AuctionDataProviders\": [\r\n ],\r\n \"VehicleClass\": \"Used\",\r\n \"LocationPostalCode\": \"\",\r\n \"AppraisalPostalCode\": \"\",\r\n \"ExplicitRadius\": 0,\r\n \"ExplicitDsa\": 0,\r\n \"ExplicitMaxListedDom\": 0,\r\n \"ExplicitYear\": 0,\r\n \"ExplicitYearsUp\": 0,\r\n \"ExplicitYearsDown\": 0,\r\n \"ExplicitMinOdometerAllowed\": 0,\r\n \"ExplicitMaxOdometerAllowed\": 0,\r\n \"Include0Odometer\": false,\r\n \"ExplicitPrice\": 0,\r\n \"ExplicitPtm\": 0,\r\n \"DesiredRank\": 0,\r\n \"ExplicitPercentBelowMarketAllowed\": 0.0,\r\n \"ExplicitPercentAboveMarketAllowed\": 0.0,\r\n \"ExcludeCompetitorVins\": [],\r\n \"SourceExclusionListIds\": [],\r\n \"SourceInclusionListIds\": [],\r\n \"ExplicitSourceNameExclusion\": [],\r\n \"ExplicitSourceNameInclusion\": [],\r\n \"SelectedConfigs\": [],\r\n \"SelectedTrims\": [],\r\n \"SelectedDrivetrains\": [],\r\n \"SelectedEngines\": [],\r\n \"SelectedFuelTypes\": [],\r\n \"SelectedTransmissions\": [],\r\n \"SelectedBodyStyles\": [],\r\n \"SelectedExtColors\": [],\r\n \"SelectedIntColors\": [],\r\n \"SelectedOptions\": [],\r\n \"SelectedIsCertified\": [],\r\n \"SelectedDealerTypes\": [],\r\n \"SelectedOdometerBands\": [],\r\n \"IncludePtmAndRankRanges\": true,\r\n \"IncludeFullListings\": true,\r\n \"MarketTrendsGrouping\": \"Overall\",\r\n \"CostEstimation\": {\r\n \"PackDefaultAmount\": 0,\r\n \"EstimateTransport\": false,\r\n \"TransportEstimateType\": \"MinimumPlusCostPerMile\",\r\n \"TransportCostMinimum\": 0,\r\n \"TransportCostPerMile\": 0.0,\r\n \"EstimateRecon\": false,\r\n \"ReconditioningEstimateType\": \"Flat\",\r\n \"ReconditioningEstimateAmount\": 0\r\n }\r\n }\r\n}"},"url":"https://[autovision-api-hostname]/api/public/v2/[your-company-id]/marketanalysis/singlevehicle/combinedreport","description":"NOTE: The language-specific example request to the right is a complete but blank request designed to show all available parameters and will not execute as-is. See below for several specific runnable examples.
\nThe combined market analysis report for a single vehicle provides detailed market analysis of the local and custom retail markets, wholesale market, as well as market trends and insights.
\nRetailValuation (Required): Primary Scope
\nRetailValuation.RmvMarket (Optional): Include Custom Retail Market Report in response
\nRetailValuation.RmvMarket.DetailedListings (Optional): Include Detailed Listings in Custom Retail Market Report
\nRetailValuation.RmvMarket.MarketTrends (Optional): Include Market Trends Report in response
\nRetailValuation.MarketInsights (Optional): Include Market Insights Report in response
\nRetailValuation.LocalMarket (Optional): Include Local Retail Market Report in response
\nRetailValuation.Artemis (Optional): Include Artemis Report in response
\nRetailValuation.ProfitabilityReport (Optional): Include Profitability Report in response
\nRetailValuation.ProfitabilityReport.EstimatedAuctionValue (Optional): Include Estimated Auction Value in Profitability Report
\nRetailValuation.ProfitabilityReport.EstimatedTransportCost (Optional): Include Transport Reconditioning Cost in Profitability Report
\nRetailValuation.ProfitabilityReport.EstimatedReconCost (Optional): Include Estimated Reconditioning Cost in Profitability Report
\nScopes array[string] (Required): One or more Request Scopes
\nRequest object (Required): Request parameters
\nCompanyId string (Optional): Identifies the AutoVision Account in the context of which the request will be executed (used to default various request parameters). Defaults to CompanyId specified in URI, but the CompanyId of a subordinate AutoVision Account may be specified
\nAppraisalId string (Conditional): Used to request an existing vehicle that has been appraised or added to inventory in AutoVision in the account associated with the CompanyId
\nVIN string (Conditional): Used to request any vehicle by VIN
\nNOTE on AppraisalId and VIN: One of AppraisalId or VIN is required. If both are specified, AppraisalId will take precedence
\nVehicleDetails object (Conditional): Vehicle description data for VIN decode. Required if VIN is specified. It is recommended to specify as many parameters are possible for matching and ranking/categorizing purposes. If a definitive match cannot be made using VIN and this suppiemental data, the best match configuration will be selected.
\nYear int (Optional): Supplemental Year information
\nMake string (Optional): Supplemental Make information
\nModel string (Optional): Supplemental Model information
\nTrim string (Optional): Supplemental Trim information
\nBodyType string (Optional): Supplemental Bodystyle information
\nBodySubType string (Optional): Supplemental Body Sub-style information (e.g. Pickup Cab Size)
\nEngine string (Optional): Supplemental Engine information
\nTransmission string (Optional): Supplemental Transmission information
\nDrivetrain string (Optional): Supplemental Drivetrain information
\nFuelType string (Optional): Supplemental Fuel Type information
\nDoors int (Optional): Supplemental Door count information
\nInteriorColor string (Optional): Supplemental Interior Color information
\nExteriorColor string (Optional): Supplemental Exterior Color information
\nMsrp int (Optional): Supplemental MSRP information
\nOdometer int (Conditional): Supplemental Odometer information. If not specified with AppraisalId, will default to odometer of vehicle associated with AppraisalId. If not specified with VIN and the vehicle is found in auction listings associated with one of AuctionDataProviders, will default to odometer of auction listing. Will override value from Appraisal or Auction Listing if specified.
\nRetailPrice int (Conditional): Supplemental Retail Price information. If not specified with AppraisalId, will default to active list price of vehicle in AutoVision. If not specified with VIN and the vehicle is found in auction listings associated with one of AuctionDataProviders, Buy Now Price from the auction listing will be used (if available). Will override value from Appraisal or Auction Listing if specified.
\nAuctionDataProviders array[string] (Conditional): Required if your account is authorized to appraise VINs at specific auctions only, rather than any arbitrary VIN. If VIN is specified, will be used to search auction listings for supplemental data including but not limited to Trim (if not VIN-decodable), Odometer, Buy Now Price, etc. If not specified will default to list of providers associated with API Key. If VIN is found at multiple matching auctions (for one or more AuctionDataProviders), an auction listing will be selected at random. Accepted values: \"ADESA\", \"Ally\", \"AuctionEdge\", \"Manheim\"
\nVehicleClass string (Optional): Override for vehicle class. If specified with AppraisalId or VIN, will override class of vehicle for valuation purposes. Defalults to class of existing appraisal if AppraisalId is specified. Defaults to Used if VIN is specified. Accepted values: \"New\", \"Used\"
\nLocationPostalCode string (Optional): Location of vehicle for estimating transport costs. If VIN is specified, defaults to auction location, then location of AutoVision Account associated with CompanyId. If AppraisalId is specified, defaults to location of Appraisal associated with AppraisalId
\nAppraisalPostalCode string (Optional): Location for which to generate valuation. Defaults to location of Account associated with CompanyId
\nExplicitRadius int (Optional): Maximum Radius to include in search (from center of AppraisalPostalCode)
\nExplicitDsa int (Optional): Maximum Days Since Active to include in search. Accepted values: 2 - 60
\nNOTE on ExplicitRadius and ExplicitDsa:
\nIn conjunction with AppraisalId, if either ExplicitRadius or ExplicitDsa is left blank or specified as 0, both will default to the Custom Market Distance and Custom Market DSA saved for the corresponding Appraisal in AutoVision
\nIf both ExplicitRadius and ExplicitDsa are specified with AppraisalId, the Appraisal's Custom Market Distance and Custom Market DSA will be updated to reflect the specified values
\nIn conjunction with VIN, if either ExplicitRadius and ExplicitDsa is left blank or specified as 0, a search will be performed based on the Account's configured Retail Market settings to identify an initial market (within the bound of the Account's Retail Market Settings)
\nIf both ExplicitRadius and ExplicitDsa are specified, it is recommended that other selection & filter criteria are explicitly specified as well. Some values will default to dealer settings if not supplied, and the API response will indicate the criteria used.
\nExplicitMaxListedDom int (Optional): Include only results with Days on Market <= ExplicitMaxListedDom
\nExplicitYear int (Optional): Include results for a Year other than the Year indicated by the VIN
\nExplicitYearsUp int (Optional): Include results for ExplicitYear plus ExplicitYearsUp years newer. Ignored if ExplicitYear is not specified
\nExplicitYearsDown int (Optional): Include results for ExplicitYear plus ExplicitYearsDown years older. Ignored if ExplicitYear is not specified
\nExplicitMinOdometerAllowed int (Optional): Include results with Odometer >= ExplicitMinOdometerAllowed. Defaults to dealer settings if not supplied or set to 0.
\nExplicitMaxOdometerAllowed int (Optional): Include results with Odometer <= ExplicitMaxOdometerAllowed. Defaults to dealer settings if not supplied or set to 0.
\nInclude0Odometer bool (Optional): Include results with no Odometer or with 0 listed Odometer. Defaults to false. Results with 0 Odometer cannot be priced or ranked for VehicleClass Used
\nExplicitPrice int (Optional): Option to return the selected market analysis with the Price of vehicle identified by AppraisalId or VIN forced to ExplicitPrice
\nExplicitPtm decimal (Optional): Option to return the selected market analysis with the Percent to Market of vehicle identified by AppraisalId or VIN forced to ExplicitPtm
\nDesiredRank int (Optional): Option to return the selected market analysis with the Rank of vehicle identified by AppraisalId or VIN forced to DesiredRank (if possible)
\nExplicitPercentBelowMarketAllowed decimal (Optional): Include results priced at >= ExplicitPercentBelowMarketAllowed their calculated market value. Expressed as a decimal where 0.5 = 50% of claculated market value
\nExplicitPercentAboveMarketAllowed decimal (Optional): Include results priced at <= ExplicitPercentAboveMarketAllowed their calculated market value. Expressed as a decimal where 1.5 = 150% of claculated market value
\nExcludeCompetitorVins array[string] Optional: Option to exclude specific vehicles from the competetive set by VIN
\nSourceExclusionListIds array[string] Optional: Option to exclude all competetive vehicles from specific dealers.
\nSourceInclusionListIds array[string] Optional: Option to include only competetive vehicles from specific dealers
\nNOTE on SourceExclusionListIds and SourceInclusionListIds: These parameters identify lists of keyword filters configured in the AutoVision Account associated with CompanyId. If lists are configured in AutoVision and selected as default in the Account's Retail Settings, they will be applied even if not specified here.
\nExplicitSourceNameExclusion array[string] Optional: Option to exclude all competetive vehicles from dealers whose name matches specific keywords
\nExplicitSourceNameInclusion array[string] Optional: Option to include only competetive vehicles from dealers whose name matches specific keywords
\nSelectedConfigs array[string] Optional: Include only vehicles with matching Config (Canonical Trim + Drivetrain)
\nSelectedTrims array[string] Optional: Include only vehicles with matching Canonical Trim
\nSelectedDrivetrains array[string] Optional: Include only vehicles with matching Drivetrain
\nSelectedEngines array[string] Optional: Include only vehicles with matching Engine
\nSelectedFuelTypes array[string] Optional: Include only vehicles with matching Fuel Type
\nSelectedTransmissions array[string] Optional: Include only vehicles with matching Transmission
\nSelectedBodyStyles array[string] Optional: Include only vehicles with matching Body Style
\nSelectedExtColors array[string] Optional: Include only vehicles with matching Exterior Color
\nSelectedIntColors array[string] Optional: Include only vehicles with matching Interior Color
\nSelectedOptions array[string] Optional: Include only vehicles with matching Options (common options and special packages)
\nSelectedIsCertified array[string] Optional: Include only CPO/Non-CPO vehicles
\nSelectedDealerTypes array[string] Optional: Include only vehicles listed at Franchise/Independent dealerships
\nSelectedOdometerBands array[string] Optional: Include only vehicles with matching Odometer range
\nNOTE on Selected[Facet]: Any request will return results indicating the availability of any given value in the selected market, as well as the available values in the selected market.
\nIncludePtmAndRankRanges bool (Optional): Option to include Percent to Market and Rank ranges
\nPTM Ranges include min/max Price and Rank for vehicles valued at any given Percent-to-Market included in the response
\nRank Ranges include min/max Price and PTM to required in order to achieve a desired rank in the selected market
\nIncludeFullListings bool (Optional): Option to include detailed retail market listings in the response (including Dealer Name, VDP URL, and other details)
\nMarketTrendsGrouping string (Optional): If Market Trends report is included in response, defines how results are grouped. Accepted values: Overall, DealerType, Year, BodyStyle, Trim
\nCostEstimation object (Optional): Reconditioning and Transport Cost estimation parameters may be configured in the AutoVision Account associated with CompanyId and/or may be specified here. If specified in the request, all values from the CostEstimation will be used, even if blank. If not specified in the request, all values from the AutoVision Account configuration will be used.
\nPackDefaultAmount int (Optional): Default Pack. Defaults to 0
\nEstimateTransport boolean (Conditional): Include Estimated Transport Cost in Cost Estimation. Required to be specified as true if any Transport-related parameters (below) are included. Defaults to false
\nTransportEstimateType string (Conditional): Required if EstimateTransport is specified true. Accepted Values: MinimumPlusCostPerMile
\nTransportCostMinimum int (Required): Minimum Cost of Transport (Dollar amount)
\nTransportCostPerMile decimal (Optional): Additional Transport Cost per Mile (Dollar amount)
\nEstimateRecon boolean (Conditional): Include Estimated Reconditioning Cost in Cost Estimation. Required to be specified as true if any Reconditioning-related parameters (below) are included. Defaults to false
\nReconditioningEstimateType string (Conditional): Required if EstimateRecon is specified true. Model for estimating Reconditioning costs. Defaults to None. Accepted Values: Flat, Percent
\nReconditioningEstimateAmount decimal (Required): Estimated Reconditioning Cost (Dollar amount if ReconditioningEstimateType specified as Flat, Percent of Cost if ReconditioningEstimateType specified as Percent)
\nNOTE on selection criteria and filters:
\nThe following request parameters are used to make an initial selection of vehicles to be evaluated in the selecte market:. Vehicle which do not match these criteria will not be included in the response.
\nAppraisalPostalCode + ExplicitRadius
\nExplicitDsa + ExplicitMaxListedDom
\nExplicitYear + ExplicitYearsUp + ExplicitYearsDown
\nExplicitMinOdometerAllowed + ExplicitMaxOdometerAllowed
\nSelectedDealerTypes
\nSelectedIsCertified
\nSourceExclusionListIds + SourceInclusionListIds + ExplicitSourceNameInclusion + ExplicitSourceNameExclusion
\nAll other filter criteria are evaluated after the initial selection of vehicles in market has been made, and if vehicles are excluded from the selected market by any other criteria they will be included in the response with an indicator that they have been filtered out of the pricing and metrics for the selected market segment.
\nStartFragment
\nExample responses are provided as links due to the response size.
\nEndFragment
\nExample 1: Minimal request by VIN (if Account is authorized to appraise any VIN), including complete retail market response data.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.RmvMarket\",\n \"RetailValuation.RmvMarket.DetailedListings\",\n \"RetailValuation.RmvMarket.MarketTrends\",\n \"RetailValuation.MarketInsights\",\n \"RetailValuation.LocalMarket\",\n \"RetailValuation.ProfitabilityReport\",\n \"RetailValuation.ProfitabilityReport.EstimatedAuctionValue\",\n \"RetailValuation.ProfitabilityReport.EstimatedTransportCost\",\n \"RetailValuation.ProfitabilityReport.EstimatedReconCost\"\n ],\n \"Request\": {\n \"VIN\": \"2C3CDXBG5JH152314\",\n \"VehicleDetails\": {\n \"Trim\": \"SXT\",\n \"BodyType\": \"Sedan\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"RWD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Red\",\n \"Odometer\": 60000\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex01-response.json
\nExample 2: Minimal request by VIN (if Account is authorized to appraise VINs for Scoped Auction Data Providers), including complete retail market response data.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.RmvMarket\",\n \"RetailValuation.RmvMarket.DetailedListings\",\n \"RetailValuation.RmvMarket.MarketTrends\",\n \"RetailValuation.MarketInsights\",\n \"RetailValuation.LocalMarket\",\n \"RetailValuation.ProfitabilityReport\",\n \"RetailValuation.ProfitabilityReport.EstimatedAuctionValue\",\n \"RetailValuation.ProfitabilityReport.EstimatedTransportCost\",\n \"RetailValuation.ProfitabilityReport.EstimatedReconCost\"\n ],\n \"Request\": {\n \"VIN\": \"2C3CDXGJ7NH225547\",\n \"AuctionDataProviders\": [\n \"AuctionEdge\"\n ],\n \"VehicleDetails\": {\n \"Trim\": \"Scat Pack\"\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex02-response.json
\nExample 3: Detailed request by VIN, including complete retail market response data and market trends by year.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.RmvMarket\",\n \"RetailValuation.RmvMarket.DetailedListings\",\n \"RetailValuation.RmvMarket.MarketTrends\",\n \"RetailValuation.MarketInsights\",\n \"RetailValuation.LocalMarket\",\n \"RetailValuation.ProfitabilityReport\",\n \"RetailValuation.ProfitabilityReport.EstimatedAuctionValue\",\n \"RetailValuation.ProfitabilityReport.EstimatedTransportCost\",\n \"RetailValuation.ProfitabilityReport.EstimatedReconCost\"\n ],\n \"Request\": {\n \"CompanyId\": \"\",\n \"AppraisalId\": \"\",\n \"VIN\": \"2C3CDXBG5JH152314\",\n \"AuctionDataProviders\": [\n \"Manheim\"\n ],\n \"VehicleDetails\": {\n \"Trim\": \"SXT\",\n \"Odometer\": 37807,\n \"RetailPrice\": 24065\n },\n \"VehicleClass\": \"Used\",\n \"LocationPostalCode\": \"\",\n \"AppraisalPostalCode\": \"85014\",\n \"ExplicitRadius\": 207,\n \"ExplicitDsa\": 7,\n \"ExplicitMaxListedDom\": 0,\n \"ExplicitYear\": 2018,\n \"ExplicitYearsUp\": 1,\n \"ExplicitYearsDown\": 1,\n \"ExplicitMinOdometerAllowed\": 1,\n \"ExplicitMaxOdometerAllowed\": 153320,\n \"Include0Odometer\": false,\n \"ExplicitPrice\": 0,\n \"ExplicitPtm\": 0,\n \"DesiredRank\": 0,\n \"ExplicitPercentBelowMarketAllowed\": 0.5,\n \"ExplicitPercentAboveMarketAllowed\": 1.5,\n \"ExcludeCompetitorVins\": [],\n \"SourceExclusionListIds\": [\n \"85ca4a75-d5b8-7108-3d4b-f827ea5ee76c\"\n ],\n \"SourceInclusionListIds\": null,\n \"ExplicitSourceNameExclusion\": null,\n \"ExplicitSourceNameInclusion\": null,\n \"SelectedConfigs\": [\n \"SXT 2WD\"\n ],\n \"SelectedTrims\": [\n \"SXT\"\n ],\n \"SelectedDrivetrains\": [\n \"2WD\"\n ],\n \"SelectedEngines\": [],\n \"SelectedFuelTypes\": [],\n \"SelectedTransmissions\": [],\n \"SelectedBodyStyles\": [\n \"Sedan\"\n ],\n \"SelectedExtColors\": [],\n \"SelectedIntColors\": [],\n \"SelectedOptions\": [],\n \"SelectedIsCertified\": [],\n \"SelectedDealerTypes\": [],\n \"SelectedOdometerBands\": [],\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Year\"\n }\n}\n\nResponse: combined-report-ex03-response.json
\nExample 4: Minimal request by VIN (if Account is authorized to appraise any VIN), including only minimal custom retail market response data.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.RmvMarket\"\n ],\n \"Request\": {\n \"VIN\": \"1C4RJFBG4JC336333\",\n \"VehicleDetails\": {\n \"Trim\": \"Limited\",\n \"BodyType\": \"SUV\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"4WD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Grey\",\n \"Odometer\": 53993\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex04-response.json
\nExample 5: Minimal request by VIN (if Account is authorized to appraise any VIN), including only detailed custom retail market response data.
Request:
{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.RmvMarket\",\n \"RetailValuation.RmvMarket.DetailedListings\"\n ],\n \"Request\": {\n \"VIN\": \"1C4RJFBG4JC336333\",\n \"VehicleDetails\": {\n \"Trim\": \"Limited\",\n \"BodyType\": \"SUV\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"4WD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Grey\",\n \"Odometer\": 53993\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex05-response.json
\nExample 6: Minimal request by VIN (if Account is authorized to appraise any VIN), including only market trends response data.
Request:
{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.RmvMarket\",\n \"RetailValuation.RmvMarket.MarketTrends\"\n ],\n \"Request\": {\n \"VIN\": \"1C4RJFBG4JC336333\",\n \"VehicleDetails\": {\n \"Trim\": \"Limited\",\n \"BodyType\": \"SUV\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"4WD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Grey\",\n \"Odometer\": 53993\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex06-response.json
\nExample 7: Minimal request by VIN (if Account is authorized to appraise any VIN), including only market insights response data.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.MarketInsights\"\n ],\n \"Request\": {\n \"VIN\": \"1C4RJFBG4JC336333\",\n \"VehicleDetails\": {\n \"Trim\": \"Limited\",\n \"BodyType\": \"SUV\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"4WD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Grey\",\n \"Odometer\": 53993\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex07-response.json
\nExample 8: Minimal request by VIN (if Account is authorized to appraise any VIN), including only local retail market response data.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.LocalMarket\"\n ],\n \"Request\": {\n \"VIN\": \"1C4RJFBG4JC336333\",\n \"VehicleDetails\": {\n \"Trim\": \"Limited\",\n \"BodyType\": \"SUV\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"4WD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Grey\",\n \"Odometer\": 53993\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex08-response.json
\nExample 9: Minimal request by VIN (if Account is authorized to appraise any VIN), including only profitability report response data.
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.ProfitabilityReport\",\n \"RetailValuation.ProfitabilityReport.EstimatedAuctionValue\",\n \"RetailValuation.ProfitabilityReport.EstimatedTransportCost\",\n \"RetailValuation.ProfitabilityReport.EstimatedReconCost\"\n ],\n \"Request\": {\n \"VIN\": \"1C4RJFBG4JC336333\",\n \"VehicleDetails\": {\n \"Trim\": \"Limited\",\n \"BodyType\": \"SUV\",\n \"Engine\": \"V6\",\n \"Transmission\": \"Automatic\",\n \"Drivetrain\": \"4WD\",\n \"Doors\": \"4\",\n \"InteriorColor\": \"Black\",\n \"ExteriorColor\": \"Grey\",\n \"Odometer\": 53993\n },\n \"IncludePtmAndRankRanges\": true,\n \"IncludeFullListings\": true,\n \"MarketTrendsGrouping\": \"Overall\"\n }\n}\n\nResponse: combined-report-ex09-response.json
\nExample 10: Minimal Artemis request with AppraisalId
\nRequest:
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.Artemis\"\n ],\n \"Request\": {\n \"AppraisalId\": \"d9477720-c527-4e3b-8554-7a5bc1ea3ca3\"\n }\n}\n\nResponse: combined-report-ex10-response.json
\nExample 11: Minimal Artemis request with VIN
\n{\n \"Scopes\": [\n \"RetailValuation\",\n \"RetailValuation.Artemis\"\n ],\n \"Request\": {\n \"VIN\": \"JTDKN3DU5D1640201\",\n \"VehicleDetails\": {\n \"Trim\": \"Four\",\n \"Odometer\": 31311\n }\n }\n}\n\nResponse: combined-report-ex11-response.json
\nerrors object: Errors object. Only included if request fails.
\nresponse object: Primary response object. Only included if request is successful.
\nlocalMarketAnalysisReport object: Local Market Analysis Report
\nradiusDiameterIndicatorMeters decimal:
\ncentralPointPostalCode string:
\ncentralPointLat decimal:
\ncentralPointLong decimal:
\nvehicleClass string:
\ndataRegion string:
\nradiusType string:
\nradiusIdentifier string:
\nradiusTitle string:
\nretailDataType string:
\nwholesaleDataType string:
\nactiveDom int:
\nactiveUnits int:
\nactiveAvgListPrice int:
\nactiveDealers int:
\nactiveAvgMiles int:
\nactiveAvgMsrp int:
\nactiveMds int:
\nactiveMarketValue decimal:
\nactiveMarketPricingError string:
\nsoldDts int:
\nsoldUnits int:
\nsoldAvgListPrice int:
\nsoldDealers int:
\nsoldAvgMiles int:
\nsoldAvgMsrp int:
\nsoldMarketValue decimal:
\nsoldMarketPricingError string:
\nsoldPTM30Units int:
\nsoldPTM30 decimal:
\nretailBookSoldPTM30 decimal:
\nsoldPTM60Units int:
\nsoldPTM60 decimal:
\nretailBookSoldPTM60 decimal:
\nscore int:
\nscoreDetails object: null,
\nmarketGrade string:
\nretailActiveMarketModel object: null,
\nretailSoldModel object: null,
\nretailBlendedModel object: null,
\nretailBlendedModelDsa int:
\nwholesaleAdjustedModel object: null,
\nwholesaleAdjustedModelDsa int:
\nretailFallbackModels array[object]: null,
\nretailTotal int:
\nretailMinMiles int:
\nretailAvgMiles decimal:
\nretailMaxMiles int:
\nretailMinMsrp int:
\nretailAvgMsrp decimal:
\nretailMaxMsrp int:
\nretailMinPrice decimal:
\nretailAvgPrice decimal:
\nretailMaxPrice decimal:
\nwholesaleTotal int:
\nwholesaleMinMiles int:
\nwholesaleAvgMiles decimal:
\nwholesaleMaxMiles int:
\nwholesaleMinPrice decimal:
\nwholesaleAvgPrice decimal:
\nwholesaleMaxPrice decimal:
\ndistanceMiles int:
\nestimatedProfit int:
\nestProfitSoldPTM30 int:
\nestProfitSoldPTM60 int:
\nestimatedWholesalePrice int:
\nestimatedReconCost int:
\nestimatedTransportCost int:
\nestimatedWholesaleCostPlus int:
\nretailMarket100 int:
\nmarketReportDays array[object]: null
\nreportType string:
\ncustomMarketAnalysisReport object: Custom Market Analysis Report
\npctToMarketRanges dictionary[string, object]:
\nkey string: PTM as a decimal-formatted string
\nvalue object: Market Range (Price, Rank)
\nminPrice decimal:
\nmaxPrice decimal:
\nminRank decimal:
\nmaxRank decimal:
\nrankRanges dictionary[string, object]:
\nkey string: Rank as an int-formatted string
\nvalue object: Market Range (Price, Rank)
\nminPrice decimal:
\nmaxPrice decimal:
\nminPct decimal:
\nmaxPct decimal:
\ncurrent60DayRankableResults array[object]: null
\nselectedListings array[object]: Ranked Listings
\nvin string:
\nlistPrice decimal:
\nmarketValue decimal:
\npricingError string:
\nrank int:
\nmarketDelta decimal:
\npercentToMarket decimal:
\nlastPtm decimal:
\nisThisVIN boolean:
\ndsa int:
\nvehicleClass string:
\npricingError string:
\nmarketPrice decimal:
\ndesiredPrice decimal:
\ndesiredPriceRank decimal:
\ndesiredPricePctToMkt decimal:
\nsuggestedPrice decimal:
\nsuggestedPriceRank decimal:
\nsuggestedPricePctToMkt decimal:
\nbestPriceInMarket decimal:
\ntenthBestPriceInMarket decimal:
\ntotalListings int:
\nmatchingListings int:
\nmatchingComps int:
\nmatchingDom int:
\nmatchingDts int:
\nmatchingMds int:
\nmatchingMaxOdometer int:
\nmatchingMinOdometer int:
\nmatchingMaxMsrp int:
\nmatchingMinMsrp int:
\nsoldPTM30 decimal:
\nsoldPTM60 decimal:
\ndataRegion string:
\ngeneratedPricingModel object: null,
\nuiListViewArrays dictionary[string, array[object]]: Avaliable market values and market analysis by facet
\nkey string: Indicator of facet \"optionsFor[Facet]\"
\nvalue array[object]: Facet data
\ntext string:
\nid string:
\nisChecked boolean:
\ntooltip string:
\ncategory string:
\nsortBy string:
\nisThisVIN boolean:
\ntotal int:
\nmatched int:
\ndom int:
\ndts int:
\nmds int:
\nsold60 int:
\nactive int:
\nrank1 int:
\nrank10 int:
\nmaxOdo int:
\nminOdo int:
\nsoldPtm30 decimal:
\nsoldPtm60 decimal:
\nselectedYears array[string]:
\nselectedMakes array[string]:
\nselectedModels array[string]:
\nselectedConfigs array[string]:
\nselectedTrims array[string]:
\nselectedDrivetrains array[string]:
\nselectedEngines array[string]:
\nselectedFuelTypes array[string]:
\nselectedTransmissions array[string]:
\nselectedBodyStyles array[string]:
\nselectedExtColors array[string]:
\nselectedIntColors array[string]:
\nselectedOptions array[string]:
\nselectedIsCertified array[string]:
\nselectedDealerTypes array[string]:
\nselectedOdometerBands array[string]:
\nbodyStyleChangesInYears object: null,
\nyearsByMakeModel array[int]:
\nnormalizedConfig string:
\nnormalizedTrim string:
\nnormalizedExtColor string:
\nnormalizedIntColor string:
\nnormalizedEngine string:
\nnormalizedTransmission string:
\nnormalizedDrivetrain string:
\nnormalizedBodyStyle string:
\nreportedOptions array[string]:
\ndistanceSearched int:
\ndaysOffMarketSearched int:
\npercentAboveMarketAllowed decimal:
\npercentBelowMarketAllowed decimal:
\nexcludedCompetitorVins array[string]:
\nmoreMatchesAvailable int:
\nresultsWereTruncated boolean:
\nmaxOdometerAllowed int:
\nminOdometerAllowed int:
\nmaxListedDom int:
\nprofitabilityReport object: Wholesale Analysis / Profitability Report (see below)
\nwholesaleAnalysisReport object: Wholesale Analysis / Profitability Report
\nestimatedTransportCost decimal:
\ndesiredGross decimal:
\nestimatedRecon decimal:
\ndesiredMinRank decimal:
\ndesiredPercentageOfMarket decimal:
\nwholesalePrice decimal:
\nwholesalePricingError string:
\nestimatedWholesaleCostPlus int:
\nretailPrice decimal:
\ntradeInPrce decimal:
\nconditionReportOffset decimal:
\nprojectedRetailSalesPrice decimal:
\nprojectedDaysInInventory int:
\nprojectedRetailProfitSourcedWholesale decimal:
\nprojectedRetailProfitSourcedTrade decimal:
\nlocalSupplyIndicator string:
\nlocalDemandIndicator string:
\nlocalBroadMatchMarketDaysSupply int:
\nnationalBroadMatchMarketDaysSupply int:
\nlocalCarsBroadMatchInMarket int:
\nlocalCarsBroadMatchSoldLast45Days int:
\nbestPriceInMarket decimal:
\ntenthBestPriceInMarket decimal:
\npackAmount decimal:
\nreportType string:
\nymmConfigOptions object: null,
\nsourceInclusionListIds array[string]:
\nsourceExclusionListIds array[string]:
\nexplicitSourceNameInclusion array[string]:
\nexplicitSourceNameExclusion array[string]:
\nmarketTrends object: Market Trends Report
\nreport object:
\nreportDate object:
\nyear int:
\nmonth int:
\nday int:
\nresults dictionary[string, array[object]]:
\nkey string: MarketTrendsGrouping
\nvalue object: Results by day
\ndate object:
\nyear int:
\nmonth int:
\nday int:
\ndayInt int:
\nleftMarketUnits int:
\nnewInMarketUnits int:
\nonMarketUnits int:
\navgPTM decimal:
\navgDom int:
\navgDts int:
\navgPrice int:
\navgOdo int:
\nmarketSlope decimal:
\nmarketIntercept decimal:
\naverageMileageExample100PTMPrice int:
\nmds int:
\navgSoldPTM decimal:
\ndom15 int:
\ndom30 int:
\ndom45 int:
\ndom60 int:
\ndom90 int:
\ndomAged int:
\naverageMileageExampleSoldPrice int:
\ndataRegion string:
\nvehicleClas string:
\npostalCode string:
\nretailPeriodId string:
\nwholesalePeriodId string:
\ntrendItems array[object]:
\naggregateName string: MarketTrendsGrouping
\ntrendReportPeriod string:
\ndataPoints array[object]:
\ntrendReportValue string:
\nrecentValue int:
\npreviousValue int:
\ndelta int:
\ndeltaPercent decimal:
\nreportType string: \"MarketTrends\"
\nsummaryReports dictionary[string, object]:
\nkey string: MarketTrendsGrouping
\nvalue object:
\naggregationKey string: MarketTrendsGrouping
\ntotalSalesThisMonth int:
\ntotalSalesThisMonthChange int:
\ntotalSalesThisMonthPercentChange decimal:
\nmarketSizeThisMonth int:
\nmarketSizeThisMonthChange int:
\nmarketSizeThisMonthPercentChange decimal:
\navgDTSThisMonth int:
\navgDTSThisMonthChange int:
\navgDTSThisMonthPercentChange decimal:
\navgPTMThisMonth int:
\navgPTMThisMonthChange int:
\navgPTMThisMonthPercentChange decimal:
\navgDOMThisMonth int:
\navgDOMThisMonthChange int:
\navgDOMThisMonthPercentChange decimal:
\nnewToMarketThisMonth int:
\nnewToMarketThisMonthChange int:
\nnewToMarketThisMonthPercentChange decimal:
\navgMileage100PTMThisMonth int:
\navgMileage100PTMThisMonthChange int:
\navgMileage100PTMThisMonthPercentChange decimal:
\ntotalSalesThisWeek int:
\ntotalSalesThisWeekChange int:
\ntotalSalesThisWeekPercentChange decimal:
\nmarketSizeThisWeek int:
\nmarketSizeThisWeekChange int:
\nmarketSizeThisWeekPercentChange decimal:
\navgDTSThisWeek int:
\navgDTSThisWeekChange int:
\navgDTSThisWeekPercentChange decimal:
\navgPTMThisWeek int:
\navgPTMThisWeekChange int:
\navgPTMThisWeekPercentChange decimal:
\navgDOMThisWeek int:
\navgDOMThisWeekChange int:
\navgDOMThisWeekPercentChange decimal:
\nnewToMarketThisWeek int:
\nnewToMarketThisWeekChange int:
\nnewToMarketThisWeekPercentChange decimal:
\navgMileage100PTMThisWeek int:
\navgMileage100PTMThisWeekChange int:
\navgMileage100PTMThisWeekPercentChange decimal:
\nreportDate object:
\nyear int:
\nmonth int:
\nday int:
\nlistings array[object]: Detailed Listings
\nlistPrice decimal:
\nmarketValue decimal:
\npricingError string:
\nlistedDate object:
\nyear int:
\nmonth int:
\nday int:
\ndaysOnMarket int:
\nvdpUrl string:
\ndistanceFromSource decimal:
\nrank int:
\ninMarket bool:
\ndaysSinceActive int:
\nmarketDelta decimal:
\npercentToMarket decimal:
\nlatitude decimal:
\nlongitude decimal:
\nsellerName string:
\naddressLine1 string:
\naddressCity string:
\naddressState string:
\naddressPostalCode string:
\ntrimDTMarketDelta int:
\nisCertifiedString string:
\naskingPriceToMSRPDiscount decimal:
\naskingPriceToMSRPDiscountPercent decimal:
\nrankableValue int:
\nmake string:
\nmodel string:
\nmileage int:
\nvin string:
\nyear string:
\ntrimDescription string:
\nexteriorColor string:
\ninteriorColor string:
\nnormalizedExteriorColor string:
\nnormalizedInteriorColor string:
\nengine string:
\ntransmission string:
\ndrivetrain string:
\nnormalizedTransmission string:
\nnormalizedDriveTrain string:
\nnormalizedEngine string:
\nvehicleProvenience string:
\nvehicleClass string:
\nlistingBodyStyle string:
\nnormalizedTrim string:
\nnormalizedConfig string:
\nreportedOptions array[string]:
\ndealerType string:
\nisCertified boolean:
\nprice decimal:
\nmsrp decimal:
\nfuelType string:
\ndoors string:
\nodometerBand string:
\nselectedOptions array[string]:
\nprimaryPhoto string:
\nphotoCount int:
\nisThisVIN bool:
\nlistingReportName string: null
\nreportType string:
\nmarketInsights object: Market Insights Report
\nartemisReport object: Artemis Report
\ntopXResults int:
\ntopMarketResults array[object]:
\nradiusDiameterIndicatorMeters decimal:
\ncentralPointPostalCode string:
\ncentralPointLat decimal:
\ncentralPointLong decimal:
\nvehicleClass string:
\ndataRegion string:
\nradiusType string:
\nradiusIdentifier string:
\nradiusTitle string:
\nretailDataType string:
\nwholesaleDataType string:
\nactiveDom int:
\nactiveUnits int:
\nactiveAvgListPrice int:
\nactiveDealers int:
\nactiveAvgMiles int:
\nactiveAvgMsrp int:
\nactiveMds int:
\nactiveMarketValue decimal:
\nactiveMarketPricingError string:
\nsoldDts int:
\nsoldUnits int:
\nsoldAvgListPrice int:
\nsoldDealers int:
\nsoldAvgMiles int:
\nsoldAvgMsrp int:
\nsoldMarketValue decimal:
\nsoldMarketPricingError string:
\nsoldPTM30Units int:
\nsoldPTM30 decimal:
\nretailBookSoldPTM30 decimal:
\nsoldPTM60Units int:
\nsoldPTM60 decimal:
\nretailBookSoldPTM60 decimal:
\nscore int:
\nscoreDetails object:
\nactiveDomScore decimal:
\nactiveUnitsScore decimal:
\nactiveAvgListPriceScore decimal:
\nactiveDealersScore decimal:
\nactiveAvgMilesScore decimal:
\nactiveMdsScore decimal:
\nactiveMarketValueScore decimal:
\nsoldDtsScore decimal:
\nsoldUnitsScore decimal:
\nsoldAvgListPriceScore decimal:
\nsoldDealersScore decimal:
\nsoldAvgMilesScore decimal:
\nsoldMarketValueScore decimal:
\nsoldPTM30Score decimal:
\nactiveDomRank decimal:
\nactiveUnitsRank decimal:
\nactiveAvgListPriceRank decimal:
\nactiveDealersRank decimal:
\nactiveAvgMilesRank decimal:
\nactiveMdsRank decimal:
\nactiveMarketValueRank decimal:
\nsoldDtsRank decimal:
\nsoldUnitsRank decimal:
\nsoldAvgListPriceRank decimal:
\nsoldDealersRank decimal:
\nsoldAvgMilesRank decimal:
\nsoldMarketValueRank decimal:
\nsoldPTM30Rank decimal:
\ntotalScore int:
\nmarketGrade string:
\nretailActiveMarketModel object: null
\nretailSoldModel object: null
\nretailBlendedModel object: null
\nretailBlendedModelDsa int:
\nwholesaleAdjustedModel object: null
\nwholesaleAdjustedModelDsa int:
\nretailFallbackModels array[object]: null
\nretailTotal int:
\nretailMinMiles int:
\nretailAvgMiles decimal:
\nretailMaxMiles int:
\nretailMinMsrp int:
\nretailAvgMsrp decimal:
\nretailMaxMsrp int:
\nretailMinPrice decimal:
\nretailAvgPrice decimal:
\nretailMaxPrice decimal:
\nwholesaleTotal int:
\nwholesaleMinMiles int:
\nwholesaleAvgMiles decimal:
\nwholesaleMaxMiles int:
\nwholesaleMinPrice decimal:
\nwholesaleAvgPrice decimal:
\nwholesaleMaxPrice decimal:
\ndistanceMiles int:
\nestimatedProfit int:
\nestProfitSoldPTM30 int:
\nestProfitSoldPTM60 int:
\nestimatedWholesalePrice int:
\nestimatedReconCost int:
\nestimatedTransportCost int:
\nestimatedWholesaleCostPlus int:
\nretailMarket100 int:
\nmarketReportDays object: null
\nreportType string: \"LocalOnlyReport\"
\nlegionMarketResults object:
\nthisDealerResult object:
\nradiusOverride int:
\nreportType string: \"ArtemisMarketReport\"
\nvechicleMatchData object:
\nDetailed market analysis for a single vehicle.
\n","_postman_id":"3b761ca8-c1b8-4903-87b3-9c37df3b6835"}],"id":"f63f9b10-da10-4bdd-8a2b-c9d572d09bb4","description":"Get detailed market analysis for a single vehicle or segment the market by any facet.
\n","_postman_id":"f63f9b10-da10-4bdd-8a2b-c9d572d09bb4"}],"event":[{"listen":"prerequest","script":{"id":"cd586b1e-d30b-41ff-8b41-5e8013b867e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0b386d75-0b3e-4bcf-bd98-b36be259b68c","type":"text/javascript","exec":[""]}}],"variable":[{"key":"CompanyId","value":"[your-company-id]"},{"key":"Hostname","value":"[autovision-api-hostname]"},{"key":"ApiKey","value":"[your-api-key]"}]}