{ "openapi": "3.0.1", "info": { "title": "CARFAX Used Cars Scraper", "description": "Search and collect used car listings from CARFAX with vehicle history details, pricing, mileage, and dealer information. Filter by make, model, year, price range, and location. Get comprehensive vehicle data including accident history and ownership records for smarter car buying decisions today.", "version": "1.0", "x-build-id": "MhM9JgfGcAJPG1vFz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~carfax-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~carfax-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~carfax-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "startUrl": { "title": "Start URL", "type": "string", "description": "Direct CARFAX search URL (e.g. https://www.carfax.com/Used-Toyota-Camry_z90210). If provided, all filter fields below are ignored." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 100. Paid users: Optional, max 1,000,000." }, "zipCode": { "title": "ZIP Code", "type": "string", "description": "US ZIP code to center the search around (e.g. 90210). Required when not using a Start URL." }, "make": { "title": "Make", "type": "string", "description": "Vehicle make/brand (e.g. Toyota, Ford, Honda)." }, "model": { "title": "Model", "type": "string", "description": "Vehicle model (e.g. Camry, F-150, Civic). Requires Make to be set." }, "type": { "title": "Listing Type", "enum": [ "used", "new" ], "type": "string", "description": "Whether to search used or new vehicles.", "default": "used" }, "minYear": { "title": "Min Year", "minimum": 1981, "maximum": 2030, "type": "integer", "description": "Minimum model year (e.g. 2018)." }, "maxYear": { "title": "Max Year", "minimum": 1981, "maximum": 2030, "type": "integer", "description": "Maximum model year (e.g. 2024)." }, "priceMin": { "title": "Min Price ($)", "minimum": 0, "type": "integer", "description": "Minimum price in US dollars." }, "priceMax": { "title": "Max Price ($)", "minimum": 0, "type": "integer", "description": "Maximum price in US dollars." }, "mileageMax": { "title": "Max Mileage", "minimum": 0, "type": "integer", "description": "Maximum odometer reading in miles." }, "radius": { "title": "Search Radius (miles)", "enum": [ "10", "25", "50", "75", "100", "150", "200", "250", "500", "3000" ], "type": "string", "description": "Search radius from the ZIP code.", "default": "50" }, "sortBy": { "title": "Sort By", "enum": [ "BEST", "PRICE_ASC", "PRICE_DESC", "MILEAGE_ASC", "MILEAGE_DESC", "YEAR_DESC", "YEAR_ASC", "LISTING_DATE_DESC" ], "type": "string", "description": "How to sort the results.", "default": "BEST" }, "noAccidents": { "title": "No Accidents Only", "type": "boolean", "description": "Only show vehicles with no reported accidents.", "default": false }, "oneOwner": { "title": "One Owner Only", "type": "boolean", "description": "Only show vehicles with a single previous owner.", "default": false }, "serviceRecords": { "title": "Service Records Available", "type": "boolean", "description": "Only show vehicles with available service records.", "default": false }, "personalUse": { "title": "Personal Use Only", "type": "boolean", "description": "Only show vehicles used for personal (not fleet/rental) use.", "default": false }, "includeHistory": { "title": "Include Vehicle History", "type": "boolean", "description": "Fetch accident history, owner history, service records, and price history for each vehicle. Adds one extra request per vehicle — significantly increases run time. Disabled by default.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum parallel requests for history enrichment. Lower if you get rate-limited.", "default": 3 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "US residential proxies required to access CARFAX.com." } } }, "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 } } } } } } } } } }