{ "openapi": "3.0.1", "info": { "title": "Google Images Scraper", "description": "Scrape Google Images by keyword: full-size image URLs with width and height, thumbnails, source page, title, website, credits, file size, colour, product prices and video details. Filter by size, type, colour, date or Creative Commons.", "version": "0.1", "x-build-id": "LVfnZci6m9NKC3n99" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~google-images-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-google-images-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/cirkit~google-images-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-google-images-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/cirkit~google-images-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-google-images-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": [ "queries" ], "properties": { "queries": { "title": "Image searches", "minItems": 1, "type": "array", "description": "What to search for on Google Images, one search per line, for example \"golden retriever puppy\" or \"modern kitchen design\". Each search runs separately and images are deduped within it.", "items": { "type": "string" } }, "maxResultsPerQuery": { "title": "Max images per search", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Upper limit of unique images for each search. Google shows 50 to 100 images per page, so past that the actor walks Google's own Tools filters (large, clip art, black and white, past month and so on) to go deeper. Expect several hundred, and up to about 1,800, unique images per search; add more searches for more volume.", "default": 100 }, "maxItems": { "title": "Max images in total", "minimum": 0, "type": "integer", "description": "Hard cap on rows across every search, and therefore on what the run can cost. Leave empty for no cap." }, "imageSize": { "title": "Size", "enum": [ "any", "large", "medium", "icon" ], "type": "string", "description": "Only images of this size, using Google's Tools filter.", "default": "any" }, "imageType": { "title": "Type", "enum": [ "any", "photo", "clipart", "lineart", "animated" ], "type": "string", "description": "Only images of this type.", "default": "any" }, "color": { "title": "Colour", "enum": [ "any", "grayscale", "transparent", "red", "orange", "yellow", "green", "teal", "blue", "purple", "pink", "white", "gray", "black", "brown" ], "type": "string", "description": "Only images in this colour. Transparent returns images with a transparent background, mostly PNG.", "default": "any" }, "timeRange": { "title": "Time", "enum": [ "any", "day", "week", "month", "year" ], "type": "string", "description": "Only images Google first indexed within this window.", "default": "any" }, "usageRights": { "title": "Usage rights", "enum": [ "any", "creativeCommons" ], "type": "string", "description": "Creative Commons returns only images Google labels as published under a Creative Commons licence. Always confirm the licence on the source page before reuse.", "default": "any" }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code Google ranks results for, for example \"us\", \"gb\", \"de\" or \"in\".", "default": "us" }, "language": { "title": "Language", "type": "string", "description": "Two-letter interface language code, for example \"en\", \"fr\" or \"es\". It changes titles Google shows and slightly shifts ranking.", "default": "en" }, "safeSearch": { "title": "SafeSearch", "type": "boolean", "description": "Filter explicit images out of the results, like SafeSearch on google.com. Turn off to get unfiltered results.", "default": true } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }