{ "openapi": "3.0.1", "info": { "title": "Bring A Trailer(BaT) Scraper", "description": "Easily scrape and download data from Bring a Trailer auction listings. Perfect for car enthusiasts and market analysis.", "version": "2.0", "x-build-id": "r7KbKpgZQu4bn37zI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/potatopeeler~bring-a-trailer-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-potatopeeler-bring-a-trailer-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/potatopeeler~bring-a-trailer-scraper/runs": { "post": { "operationId": "runs-sync-potatopeeler-bring-a-trailer-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/potatopeeler~bring-a-trailer-scraper/run-sync": { "post": { "operationId": "run-sync-potatopeeler-bring-a-trailer-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", "required": [ "category" ], "properties": { "category": { "title": "Car Auction Type", "enum": [ "all-terrain-vehicles", "boats", "convertibles", "electric-vehicles", "go-carts", "hot-rods", "military-vehicles", "minibikes-scooters", "motorcycles", "parts-accessories", "pre-war", "project", "race-cars", "rvs-campers", "service-vehicles", "station-wagons", "tractors", "trucks-4x4s", "vans", "wheels" ], "type": "string", "description": "select the category of the car auction to scrape, the 'cars' option will scrape the car auction, and the 'parts' option will scrape the car parts auction.", "default": "all-terrain-vehicles" }, "filterOptions": { "title": "Filter options", "type": "string", "description": "Advanced settings for the crawler, for time out, retry, and other settings." }, "limit": { "title": "max number of auctions to retrieve", "enum": [ "25", "50", "100", "200", "500", "1000", "2000", "5000", "10000", "all" ], "type": "string", "description": "how many auctions to retrieve, the crawler will stop after reaching this number, or when there are no more items to retrieve, whichever comes first.", "default": "50" }, "sort": { "title": "Sort Options", "enum": [ "td", "vd", "bd", "ta" ], "type": "string", "description": "select the order of the posts to be returned. The 'new' sort option returns the newest posts, 'hot' returns the posts with the most upvotes, and 'top' returns the posts with the highest score.", "default": "new" }, "proxy": { "title": "Proxy Settings", "type": "object", "description": "For best results, it's recommend to use a proxy, you can use Apify Proxy, or use your own proxy. If you don't have a proxy, you can use the Apify Proxy, it's a free proxy provided by Apify. If you have your own proxy, you can use it by entering the proxy URL. If you don't want to use a proxy, you can leave this field empty.", "default": { "useApifyProxy": true } }, "advanced": { "title": "Advanced Settings", "type": "string", "description": "Advanced settings for the crawler, for time out, retry, and other settings." }, "maxRetries": { "title": "Max retries", "type": "integer", "description": "How many retries until the scraper should give up", "default": 3 } } }, "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 } } } } } } } } } }