{ "openapi": "3.0.1", "info": { "title": "🚗 Carfax.com Scraper", "description": null, "version": "0.1", "x-build-id": "U0Do7GSk9Rh9AV3B4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~carfax-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-carfax-scraper", "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/scraper-engine~carfax-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-carfax-scraper", "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/scraper-engine~carfax-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-carfax-scraper", "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": { "urls": { "title": "🔗 Vehicle URLs (bulk)", "type": "array", "description": "Paste one or more Carfax vehicle detail page URLs (e.g. `https://www.carfax.com/vehicle/1GTW7AFP5R1189896`). When set, the actor scrapes these directly and skips search filters.", "items": { "type": "string" } }, "VIN": { "title": "🆔 Single VIN", "type": "string", "description": "Look up exactly one vehicle by 17-character VIN. Quickest path for a single record." }, "VINs": { "title": "🆔 VINs (bulk)", "type": "array", "description": "Look up multiple vehicles by VIN — each is fetched concurrently.", "items": { "type": "string" } }, "zipcode": { "title": "📍 ZIP code", "type": "string", "description": "US ZIP code for the search center. Required when not using URLs/VINs." }, "type": { "title": "🏷️ Listing type", "enum": [ "used", "new" ], "type": "string", "description": "Used or New inventory.", "default": "used" }, "sort": { "title": "🔀 Sort order", "enum": [ "BEST", "PRICE_ASC", "PRICE_DESC", "MILEAGE_ASC", "MILEAGE_DESC", "YEAR_ASC", "YEAR_DESC", "LOCATION_NEAREST", "LISTING_DATE_ASC", "LISTING_DATE_DESC" ], "type": "string", "description": "How the search results are ordered.", "default": "BEST" }, "radius": { "title": "📏 Search radius (miles)", "enum": [ "10", "25", "50", "75", "100", "150", "200", "250", "500", "3000" ], "type": "string", "description": "Distance from the ZIP code to include.", "default": "50" }, "maker": { "title": "🏭 Make", "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": "Vehicle manufacturer. Pick *All Makes* to include every brand.", "default": "All Makes" }, "model": { "title": "🚙 Model", "type": "string", "description": "Model name (e.g. Civic, F-150). Leave blank for any." }, "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": "Earliest model year to include. Leave blank for no lower bound." }, "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": "Latest model year to include. Leave blank for no upper bound." }, "priceOver": { "title": "💵 Min price (USD)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum listing price." }, "priceUnder": { "title": "💸 Max price (USD)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum listing price." }, "mileageMin": { "title": "🛣️ Min mileage", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Minimum odometer reading." }, "mileageMax": { "title": "🛣️ Max mileage", "minimum": 0, "maximum": 500000, "type": "integer", "description": "Maximum odometer reading." }, "certified": { "title": "✅ Certified Pre-Owned only", "type": "boolean", "description": "Only return CPO vehicles.", "default": false }, "noAccidents": { "title": "🛡️ No reported accidents", "type": "boolean", "description": "Only return vehicles with no accident history.", "default": false }, "oneOwner": { "title": "👤 One-owner only", "type": "boolean", "description": "Only return one-owner vehicles.", "default": false }, "personalUse": { "title": "🏠 Personal-use only", "type": "boolean", "description": "Only return vehicles used for personal (non-fleet/rental) use.", "default": false }, "serviceRecords": { "title": "🔧 Has service records", "type": "boolean", "description": "Only return vehicles with service records on file.", "default": false }, "bodyStyles": { "title": "🚘 Body styles", "uniqueItems": true, "type": "array", "description": "Pick one or more body styles. Empty = include all.", "items": { "type": "string", "enum": [ "SUV", "Sedan", "Pickup", "Coupe", "Hatchback", "Minivan", "Van", "Wagon", "Convertible", "Chassis", "Unspecified" ] } }, "valueBadges": { "title": "🏷️ Value badges", "uniqueItems": true, "type": "array", "description": "Carfax price-badge filter. Pick GREAT for top deals, GOOD for fair deals.", "items": { "type": "string", "enum": [ "GREAT", "GOOD" ] } }, "exteriorColors": { "title": "🎨 Exterior colors", "uniqueItems": true, "type": "array", "description": "Pick one or more exterior colors. Empty = include all.", "items": { "type": "string", "enum": [ "White", "Black", "Gray", "Blue", "Silver", "Red", "Green", "Brown", "Beige", "Orange", "Burgundy", "Yellow", "Gold", "Bronze", "Purple", "Turquoise", "Pink", "Unspecified" ] } }, "interiorColors": { "title": "🪑 Interior colors", "uniqueItems": true, "type": "array", "description": "Pick one or more interior colors. Empty = include all.", "items": { "type": "string", "enum": [ "Black", "Gray", "Tan", "Brown", "Red", "White", "Blue", "Orange", "Yellow", "Green", "Unspecified" ] } }, "transmission": { "title": "⚙️ Transmission", "enum": [ "", "Automatic", "Manual", "Unspecified" ], "type": "string", "description": "Gearbox type.", "default": "" }, "driveTypes": { "title": "🛞 Drive types", "uniqueItems": true, "type": "array", "description": "Pick one or more drivetrains. Empty = include all.", "items": { "type": "string", "enum": [ "AWD", "4WD", "FWD", "RWD", "Unspecified" ] } }, "engines": { "title": "🔩 Engines", "uniqueItems": true, "type": "array", "description": "Engine configuration filter.", "items": { "type": "string", "enum": [ "3 Cyl", "4 Cyl", "5 Cyl", "6 Cyl", "8 Cyl", "10 Cyl", "12 Cyl", "Electric", "Unspecified" ] } }, "fuelTypes": { "title": "⛽ Fuel types", "uniqueItems": true, "type": "array", "description": "Pick one or more fuel types.", "items": { "type": "string", "enum": [ "Gasoline", "Hybrid", "Flexible-Fuel", "Electric", "Diesel", "Alternative", "Unspecified" ] } }, "popularOptions": { "title": "🌟 Popular options", "uniqueItems": true, "type": "array", "description": "Filter by must-have 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", "Front bench seat", "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" ] } }, "maxItems": { "title": "🔢 Max items", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of listings to return.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy settings for this run.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }