{"note":"OpenAPI conversion -- returning structured metadata","name":"autodealerdata-com","description":"CIS Automotive API","version":"1.0","base_url":"","endpoints":35,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api CIS Automotive API\n@version 1.0\n@auth ApiKey apiKey in query\n@endpoints 35\n@hint download_for_search\n@toc getToken(2), makeSubUserKey(1), revokeSubUserKey(1), getSubUserKeys(1), getRegions(1), getBrands(1), getModels(1), getInactiveModels(1), daysToSell(1), daysSupply(1), listPrice(1), salePrice(1), salePriceHistogram(1), modelYearDist(1), topModels(1), getRegionBrandMarketShare(1), getRegionMarketShare(1), getDealers(1), getDealersByRegion(1), getDealersByID(1), regionSales(1), regionDailySales(1), vehicleHistory(1), similarSalePrice(1), valuation(1), vehicleSeen(1), vinDecode(1), listings2(1), listings(1), listingsByDate(1), listingsByRegion(1), listingsByRegionAndDate(1), listingsByZipCode(1), listingsByZipCodeAndDate(1)\n\n@group getToken\n@endpoint GET /getToken\n@desc Get a JWT from your API credentials\n@required {apiID: str, apiKey: str}\n@returns(200) {token: str, expires: int, createdOn: int} # Successful Response\n@errors {422: Validation Error}\n\n@endpoint POST /getToken\n@desc Get a JWT from your API credentials\n@required {apiID: str, apiKey: str}\n@returns(200) {token: str, expires: int, createdOn: int} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group makeSubUserKey\n@endpoint POST /makeSubUserKey\n@desc Generate a Sub User Key that can be used by your users to make API calls in frontend applications.\n@required {apiID: str, apiKey: str}\n@optional {siteName: str=localhost, endPoints: [str]=*}\n@returns(200) {token: str, expires: int, createdOn: int, domain: str, endPoints: [str], uuid: str} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group revokeSubUserKey\n@endpoint PUT /revokeSubUserKey\n@desc Revoke a Sub User Key associated with your account.\n@required {apiID: str, apiKey: str, subUserKeyUUID: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getSubUserKeys\n@endpoint GET /getSubUserKeys\n@desc Get all Sub User Keys associated with your account.\n@required {apiID: str, apiKey: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getRegions\n@endpoint GET /getRegions\n@desc Get a list of region names\n@required {jwt: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [str]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getBrands\n@endpoint GET /getBrands\n@desc Get a list of brand names\n@required {jwt: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [str]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getModels\n@endpoint GET /getModels\n@desc Get a list of model names\n@required {jwt: str, brandName: str}\n@optional {filtered: bool=true}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getInactiveModels\n@endpoint GET /getInactiveModels\n@desc Get a list of model names including discontinued models\n@required {jwt: str, brandName: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group daysToSell\n@endpoint GET /daysToSell\n@desc Days a vehicle takes to sell\n@required {jwt: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group daysSupply\n@endpoint GET /daysSupply\n@desc Days worth of supply left on dealer lots\n@required {jwt: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listPrice\n@endpoint GET /listPrice\n@desc Stats on ask price of new vehicles\n@required {jwt: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group salePrice\n@endpoint GET /salePrice\n@desc Stats on sale price of new vehicles\n@required {jwt: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group salePriceHistogram\n@endpoint GET /salePriceHistogram\n@desc Histogram of sales price of new vehicles by model\n@required {jwt: str, modelName: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group modelYearDist\n@endpoint GET /modelYearDist\n@desc Used market share of model year by model\n@required {jwt: str, modelName: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group topModels\n@endpoint GET /topModels\n@desc Top models in a given region\n@required {jwt: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getRegionBrandMarketShare\n@endpoint GET /getRegionBrandMarketShare\n@desc Market share of a brand in region\n@required {jwt: str, brandName: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getRegionMarketShare\n@endpoint GET /getRegionMarketShare\n@desc Market share of all brands in region\n@required {jwt: str}\n@optional {regionName: str=REGION_STATE_CA}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getDealers\n@endpoint GET /getDealers\n@desc Premium. Dealers in a zip code.\n@required {jwt: str, zipCode: int}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getDealersByRegion\n@endpoint GET /getDealersByRegion\n@desc Premium. Dealers in a region.\n@required {jwt: str}\n@optional {regionName: str=REGION_STATE_CA, page: int=1}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, dealers: [map]}} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group getDealersByID\n@endpoint GET /getDealersByID\n@desc Premium. Dealers by ID\n@required {jwt: str, dealerID: int}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: [map]} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group regionSales\n@endpoint GET /regionSales\n@desc Premium. Brand sales by region and month\n@required {jwt: str, brandName: str, regionName: str, month: str(date)}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group regionDailySales\n@endpoint GET /regionDailySales\n@desc Brand sales by region and Day\n@required {jwt: str, brandName: str, regionName: str, day: str(date)}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group vehicleHistory\n@endpoint GET /vehicleHistory\n@desc Premium. Simple Vehicle History Report\n@required {jwt: str, vin: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{vin: str, data: [map]}} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group similarSalePrice\n@endpoint GET /similarSalePrice\n@desc Premium. Simple Vehicle Market Report\n@required {jwt: str, vin: str}\n@optional {regionName: str=REGION_STATE_CA, daysBack: int=45, sameYear: bool=false}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{newSaleAvg: num, newSaleStdDev: num, newCount: int, usedSaleAvg: num, usedSaleStdDev: num, usedCount: int, milesAvg: num, milesStdDev: num, mileCount: int, daysBack: int}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group valuation\n@endpoint GET /valuation\n@desc Premium. Simple Vehicle Market Report Over Arbitrary Locations and Vehicles.\n@required {jwt: str, vin: str}\n@optional {dealerID: int=0, zipCode: int=0, latitude: num=0, longitude: num=0, radius: num=0, regionName: str, mileageLow: int=0, mileageHigh: int=0, startDate: str(date), endDate: str(date), daysBack: int=45, newCars: bool=false, extendedSearch: bool=false, sameYear: bool=false}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{newSaleAvg: num, newSaleStdDev: num, newCount: int, usedSaleAvg: num, usedSaleStdDev: num, usedCount: int, milesAvg: num, milesStdDev: num, mileCount: int, daysBack: int}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group vehicleSeen\n@endpoint GET /vehicleSeen\n@desc Checks if a VIN appeared on the market on or after a given date.\n@required {jwt: str, vin: str, afterDate: str(date)}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: bool} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group vinDecode\n@endpoint GET /vinDecode\n@desc Vin decoder and Recall Info\n@required {jwt: str, vin: str}\n@optional {passEmpty: bool=false, includeRecall: bool=true}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: any} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listings2\n@endpoint GET /listings2\n@desc Flexible Listing Search\n@required {jwt: str}\n@optional {dealerID: int=0, zipCode: int=0, latitude: num=0, longitude: num=0, radius: num=0, regionName: str, brandName: str, modelName: str, modelYear: int=0, mileageLow: int=0, mileageHigh: int=0, startDate: str(date), endDate: str(date), daysBack: int=45, page: int=1, newCars: bool=true, extendedSearch: bool=false}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listings\n@endpoint GET /listings\n@desc Listings by Dealer ID\n@required {jwt: str, dealerID: int}\n@optional {page: int=1, newCars: bool=true}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listingsByDate\n@endpoint GET /listingsByDate\n@desc Listings by Dealer ID and Date\n@required {jwt: str, dealerID: int, startDate: str(date), endDate: str(date)}\n@optional {page: int=1, newCars: bool=true}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listingsByRegion\n@endpoint GET /listingsByRegion\n@desc Listings by Region\n@required {jwt: str, regionName: str, modelName: str}\n@optional {daysBack: int=10, page: int=1, newCars: bool=true}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listingsByRegionAndDate\n@endpoint GET /listingsByRegionAndDate\n@desc Listings by Region and Date\n@required {jwt: str, regionName: str, modelName: str, startDate: str(date), endDate: str(date)}\n@optional {page: int=1, newCars: bool=true}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listingsByZipCode\n@endpoint GET /listingsByZipCode\n@desc Listings by ZipCode\n@required {jwt: str, zipCode: int}\n@optional {page: int=1, newCars: bool=true, modelName: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@group listingsByZipCodeAndDate\n@endpoint GET /listingsByZipCodeAndDate\n@desc Listings by ZipCode and Date\n@required {jwt: str, zipCode: int, startDate: str(date), endDate: str(date)}\n@optional {page: int=1, newCars: bool=true, modelName: str}\n@returns(200) {brandName: str, modelName: str, regionName: str, condition: str, msg: str, cacheTimeLimit: int, data: map{page: int, maxPages: int, listings: [map]}, startDate: str(date), endDate: str(date)} # Successful Response\n@errors {422: Validation Error}\n\n@endgroup\n\n@end\n"}