{ "openapi": "3.0.1", "info": { "title": "Carfax.com Scraper", "description": "Scrape vehicle data by VIN or make and model from Carfax.com - including mileage, accident records, ownership history, and pricing. Ideal for automotive market research, pricing analysis, and lead generation. Fast, structured, and customizable extraction.", "version": "1.0", "x-build-id": "gdRKAK16rjlF0OVpK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lexis-solutions~carfax-com/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lexis-solutions-carfax-com", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/lexis-solutions~carfax-com/runs": { "post": { "operationId": "runs-sync-lexis-solutions-carfax-com", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/lexis-solutions~carfax-com/run-sync": { "post": { "operationId": "run-sync-lexis-solutions-carfax-com", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Your proxy configuration from Apify", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "zipcode": { "title": "Zipcode", "type": "string", "description": "Zipcode to start with." }, "type": { "title": "Type", "enum": [ "new", "used" ], "type": "string", "description": "Type to start with.", "default": "used" }, "sort": { "title": "Sort By", "enum": [ "BEST", "PRICE_DESC", "PRICE_ASC", "MILEAGE_DESC", "MILEAGE_ASC", "YEAR_DESC", "YEAR_ASC", "LOCATION_NEAREST", "LISTING_DATE_DESC", "LISTING_DATE_ASC" ], "type": "string", "description": "Sort order for the listings." }, "maker": { "title": "Maker", "enum": [ "All Makes", "Acura", "Alfa Romeo", "Audi", "BMW", "Buick", "Cadillac", "Chevrolet", "Chrysler", "Dodge", "Fiat", "Ford", "GMC", "Genesis", "Honda", "Hyundai", "Infiniti", "Jaguar", "Jeep", "Kia", "Land Rover", "Lexus", "Lincoln", "Mazda", "Mercedes-Benz", "Mini", "Mitsubishi", "Nissan", "Porsche", "Ram", "Subaru", "Tesla", "Toyota", "Volkswagen", "Volvo", "AM General", "American Motors", "Aston Martin", "Avanti", "Bentley", "BrightDrop", "Bugatti", "Daewoo", "Daihatsu", "Datsun", "Delorean", "Eagle", "Ferrari", "Fisker", "Freightliner", "Geo", "Hummer", "INEOS", "Isuzu", "Karma", "Laforza", "Lamborghini", "Lotus", "Lucid", "Maserati", "Maybach", "Mclaren", "Mercury", "Merkur", "Mobility Ventures", "Oldsmobile", "Opel", "Pagani", "Panoz", "Plymouth", "Polestar", "Pontiac", "Rimac", "Rivian", "Rolls-Royce", "Saab", "Saturn", "Scion", "Shelby", "Smart", "Spyker", "Sterling", "Suzuki", "Th!nk", "VPG", "VinFast" ], "type": "string", "description": "Maker to start with." }, "model": { "title": "Model", "type": "string", "description": "See in original website." }, "radius": { "title": "Radius", "enum": [ "10", "25", "50", "75", "100", "150", "200", "250", "500", "3000" ], "type": "string", "description": "Radius to start with." }, "certified": { "title": "Certified", "type": "boolean", "description": "Certified", "default": false }, "noAccidents": { "title": "No Accidents", "type": "boolean", "description": "No accidents", "default": false }, "oneOwner": { "title": "One Owner", "type": "boolean", "description": "One owner", "default": false }, "personalUse": { "title": "Personal Use", "type": "boolean", "description": "Personal use", "default": false }, "serviceRecords": { "title": "Service Records", "type": "boolean", "description": "Service records", "default": false }, "minYear": { "title": "Min Year", "enum": [ "1981", "1982", "1983", "1984", "1985", "1986", "1987", "1988", "1989", "1990", "1991", "1992", "1993", "1994", "1995", "1996", "1997", "1998", "1999", "2000", "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026" ], "type": "string", "description": "Minimum vehicle year to include in search." }, "maxYear": { "title": "Max Year", "enum": [ "1981", "1982", "1983", "1984", "1985", "1986", "1987", "1988", "1989", "1990", "1991", "1992", "1993", "1994", "1995", "1996", "1997", "1998", "1999", "2000", "2001", "2002", "2003", "2004", "2005", "2006", "2007", "2008", "2009", "2010", "2011", "2012", "2013", "2014", "2015", "2016", "2017", "2018", "2019", "2020", "2021", "2022", "2023", "2024", "2025", "2026" ], "type": "string", "description": "Maximum vehicle year to include in search." }, "priceUnder": { "title": "Price Under", "minimum": 0, "maximum": 880000, "type": "integer", "description": "Price under to start with." }, "priceOver": { "title": "Price Over", "minimum": 0, "maximum": 880000, "type": "integer", "description": "Price over to start with." }, "mileageMin": { "title": "Mileage Min", "minimum": 0, "maximum": 340000, "type": "integer", "description": "Mileage min to start with." }, "mileageMax": { "title": "Mileage Max", "minimum": 0, "maximum": 340000, "type": "integer", "description": "Mileage max to start with." }, "bodyStyles": { "title": "Body style", "type": "array", "description": "Filter by vehicle body style. You can select multiple.", "items": { "type": "string", "enum": [ "SUV", "Sedan", "Pickup", "Coupe", "Hatchback", "Minivan", "Van", "Wagon", "Convertible", "Chassis", "Unspecified" ] } }, "valueBadges": { "title": "Value badges", "type": "array", "description": "Filter by value badges. You can select multiple.", "items": { "type": "string", "enum": [ "GREAT", "GOOD" ] } }, "exteriorColors": { "title": "Exterior Colors", "type": "array", "description": "Filter by exterior colors (multi-select).", "items": { "type": "string", "enum": [ "White", "Black", "Gray", "Blue", "Silver", "Red", "Green", "Brown", "Beige", "Orange", "Burgundy", "Yellow", "Gold", "Bronze", "Purple", "Turquoise", "Pink", "Unspecified" ] } }, "transmission": { "title": "Transmission", "enum": [ "Automatic", "Manual", "Unspecified" ], "type": "string", "description": "Select a transmission type." }, "driveTypes": { "title": "Drive Types", "type": "array", "description": "Filter by drivetrain.", "items": { "type": "string", "enum": [ "AWD", "4WD", "FWD", "RWD", "Unspecified" ] } }, "engines": { "title": "Engines", "type": "array", "description": "Filter by engine cylinder/electric type.", "items": { "type": "string", "enum": [ "4 Cyl", "6 Cyl", "8 Cyl", "3 Cyl", "Electric", "12 Cyl", "5 Cyl", "10 Cyl", "Unspecified" ] } }, "fuelTypes": { "title": "Fuel Types", "type": "array", "description": "Filter by fuel type.", "items": { "type": "string", "enum": [ "Gasoline", "Hybrid", "Flexible-Fuel", "Electric", "Diesel", "Alternative", "Unspecified" ] } }, "interiorColors": { "title": "Interior Colors", "type": "array", "description": "Filter by interior color.", "items": { "type": "string", "enum": [ "Black", "Gray", "Tan", "Brown", "Red", "White", "Blue", "Orange", "Yellow", "Green", "Unspecified" ] } }, "popularOptions": { "title": "Popular Options", "type": "array", "description": "Filter by popular factory/options features.", "items": { "type": "string", "enum": [ "Adaptive Cruise Control", "Alloy Wheels", "Android Auto", "Anti-Theft System", "Apple Carplay", "Automatic Headlights", "Blind Spot Monitor", "Braking Assist", "Bucket Seats", "Cross Traffic Alert", "Digital Instrument Cluster", "Dual Exhaust", "Dual-Zone Climate Control", "Fog Lights", "Folding Mirrors", "HD Radio", "Handsfree/Bluetooth Integration", "Heated Mirrors", "Heated Seats", "Heated Steering Wheel", "High-Beam Assist", "Keyless Entry", "Keyless Ignition", "LED Lights", "Lane Departure Warning", "Leather Seats", "Limited Slip Differential", "Navigation System", "Power Folding Mirrors", "Power Liftgate", "Premium Sound System", "Privacy Glass", "Rain-Sensing Wipers", "Rear Air Conditioning", "Rear Heated Seats", "Rear-View Camera", "Remote Start", "Roof Rails", "Satellite Radio", "Seat Memory", "Smart Key", "Spoiler", "Stability Control", "Steering Wheel Controls", "Third Row Seating", "Tinted Windows", "Tire Pressure Monitoring System", "Traction Control", "Ventilated Seats", "Front bench seat" ] } }, "maxItems": { "title": "Maximum number of items", "type": "integer", "description": "Maximum number of items that will be extracted.", "default": 10 }, "VIN": { "title": "VIN", "type": "string", "description": "VIN to start with." }, "VINs": { "title": "VINs", "type": "array", "description": "VINs to start with.", "items": { "type": "string" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }