{ "openapi": "3.0.1", "info": { "title": "Hiyacar Scraper", "description": "Scrape peer-to-peer car rentals from hiyacar.co.uk. Filter by city, dates, make, body type, fuel, and more, or paste a Hiyacar search URL. Returns hourly/daily price, location, QuickStart/instant booking, and photos.", "version": "0.1", "x-build-id": "9Z6WYXx31Hr0ebER6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dadhalfdev~hiyacar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dadhalfdev-hiyacar-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/dadhalfdev~hiyacar-scraper/runs": { "post": { "operationId": "runs-sync-dadhalfdev-hiyacar-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/dadhalfdev~hiyacar-scraper/run-sync": { "post": { "operationId": "run-sync-dadhalfdev-hiyacar-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": { "input_url": { "title": "Input URL", "type": "string", "description": "Optional. Paste a Hiyacar search or city URL (e.g. https://www.hiyacar.co.uk/search?q=London or https://www.hiyacar.co.uk/rent-a-car-in-bristol) to override the filters below." }, "location": { "title": "Location", "enum": [ "london", "manchester", "birmingham", "leeds", "glasgow", "edinburgh", "bristol", "liverpool", "cardiff", "belfast", "newcastle", "sheffield", "nottingham", "leicester", "coventry", "brighton", "oxford", "cambridge", "reading", "southampton", "portsmouth", "bournemouth", "norwich", "york", "bath", "exeter", "plymouth", "aberdeen", "milton-keynes", "swindon", "watford", "woking", "wycombe", "barking", "barnet", "bexley", "brent", "bromley", "camden", "chelsea", "croydon", "dagenham", "ealing", "enfield", "fulham", "greenwich", "hackney", "havering", "hammersmith", "haringey", "harrow", "hillingdon", "hounslow", "islington", "kensington", "kingston", "lambeth", "lewisham", "merton", "newham", "redbridge", "richmond", "southwark", "sutton", "tower-hamlets", "waltham-forest", "wandsworth", "balham", "beckenham", "brixton", "clapham", "clapton", "dalston", "edgware", "haggerston", "homerton", "hornsey", "ilford", "central-ilford", "kings-cross", "leyton", "london-fields", "marylebone", "mitcham", "orpington", "paddington", "peckham", "romford", "ruislip", "shoreditch", "stratford", "stoke-newington", "thornton-heath", "tottenham", "tulse-hill", "twickenham", "uxbridge", "victoria", "walthamstow", "wembley", "willesden", "wimbledon", "woodford-green", "barnsbury", "canonbury", "pentonville", "de-beauvoir-town", "hoxton", "streatham", "streatham-common", "norbury", "streatham-park", "furzedown", "streatham-vale", "mitcham-common", "pollards-hill", "eastfields", "north-london", "east-london", "west-london", "south-london", "south-east-london", "central-london" ], "type": "string", "description": "Town or London area as on Hiyacar. Search is limited to 10 miles (site maximum). Ignored when input_url or query is set.", "default": "london" }, "query": { "title": "Town or postcode", "type": "string", "description": "Optional free-text place as on Hiyacar (e.g. SW1A 1AA or Hackney). Overrides the location dropdown. Ignored when input_url is set." }, "make": { "title": "Make", "enum": [ "", "abarth", "alfaromeo", "audi", "bmw", "cadilac", "chevrolet", "chrysler", "citroen", "dacia", "ds", "fiat", "ford", "honda", "hyundai", "infiniti", "jaguar", "jeep", "kia", "landrover", "lexus", "mazda", "mercedesbenz", "mg", "mini", "mitsubishi", "nissan", "peugeot", "porsche", "renault", "saab", "seat", "skoda", "smart", "ssangyong", "subaru", "suzuki", "tesla", "toyota", "vauxhall", "volkswagen", "volvo" ], "type": "string", "description": "Car brand as on Hiyacar. Leave empty for all makes. Ignored when input_url is set.", "default": "" }, "pickup_date": { "title": "Pickup date", "type": "string", "description": "Optional pickup date (YYYY-MM-DD). Use together with return_date. Ignored when input_url is set." }, "return_date": { "title": "Return date", "type": "string", "description": "Optional return date (YYYY-MM-DD). Use together with pickup_date. Ignored when input_url is set." }, "distance_miles": { "title": "Radius (miles)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Max distance from the location. Hiyacar allows 1–10 miles (default 10). Ignored when input_url is set.", "default": 10 }, "price_max": { "title": "Maximum daily price (GBP)", "minimum": 0, "type": "integer", "description": "Maximum daily rate in GBP. Ignored when input_url is set." }, "car_type": { "title": "Car type", "enum": [ "", "1", "2", "3", "4", "5", "6", "7", "8" ], "type": "string", "description": "Body type as on Hiyacar. Ignored when input_url is set.", "default": "" }, "fuel_type": { "title": "Fuel type", "enum": [ "", "Petrol", "Diesel", "Electric", "Hybrid" ], "type": "string", "description": "Fuel filter. Ignored when input_url is set.", "default": "" }, "transmission": { "title": "Transmission", "enum": [ "", "automatic", "manual" ], "type": "string", "description": "Gearbox filter. Ignored when input_url is set.", "default": "" }, "min_seats": { "title": "Minimum seats", "minimum": 2, "maximum": 9, "type": "integer", "description": "Minimum number of seats (e.g. 7 for 7-seaters). Ignored when input_url is set." }, "instant_booking": { "title": "Instant booking only", "type": "boolean", "description": "Only cars with instant booking. Ignored when input_url is set.", "default": false }, "quickstart": { "title": "QuickStart only", "type": "boolean", "description": "Only keyless QuickStart cars. Ignored when input_url is set.", "default": false }, "pets_welcome": { "title": "Pet friendly", "type": "boolean", "description": "Only cars marked pet friendly. Ignored when input_url is set.", "default": false }, "ulez_compliant": { "title": "ULEZ compliant", "type": "boolean", "description": "Only ULEZ-compliant cars. Ignored when input_url is set.", "default": false }, "sort_by": { "title": "Sort by", "enum": [ "relevancy", "distance", "price-low-to-high", "price-high-to-low", "highest-rated", "number-of-ratings" ], "type": "string", "description": "Result order. Ignored when input_url is set.", "default": "relevancy" }, "max_listings": { "title": "Maximum number of listings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many rental listings to return (1–1000).", "default": 50 } } }, "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 } } } } } } } } } }