{ "openapi": "3.0.1", "info": { "title": "Duckduckgo Scraper", "version": "0.1", "x-build-id": "OlaIwg1bV9X8vbl7s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapepilotapi~duckduckgo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapepilotapi-duckduckgo-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/scrapepilotapi~duckduckgo-scraper/runs": { "post": { "operationId": "runs-sync-scrapepilotapi-duckduckgo-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/scrapepilotapi~duckduckgo-scraper/run-sync": { "post": { "operationId": "run-sync-scrapepilotapi-duckduckgo-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": [ "searchKeyword", "searchMode", "region", "safeSearch" ], "properties": { "searchKeyword": { "title": "๐Ÿ”‘ Search keyword", "type": "string", "description": "โœ๏ธ What should DuckDuckGo look for? (e.g. โ€œbest pizza in Romeโ€, โ€œreact hooks tutorialโ€, a brand nameโ€ฆ)", "default": "javascript" }, "searchMode": { "title": "๐ŸŽฏ Search mode", "enum": [ "default", "images", "news", "videos" ], "type": "string", "description": "๐Ÿ“‚ Pick the kind of results you want back โ€” classic web links, ๐Ÿ–ผ๏ธ images, ๐Ÿ“ฐ headlines, or ๐ŸŽฌ videos.", "default": "default" }, "region": { "title": "๐ŸŒ Region & language", "enum": [ "wt-wt", "ar-es", "au-en", "at-de", "be-fr", "be-nl", "br-pt", "bg-bg", "ca-en", "ca-fr", "ct-ca", "cl-es", "cn-zh", "co-es", "hr-hr", "cz-cs", "dk-da", "ee-et", "fi-fi", "fr-fr", "de-de", "gr-el", "hk-tzh", "hu-hu", "in-en", "id-en", "ie-en", "il-en", "it-it", "jp-jp", "kr-kr", "lv-lv", "lt-lt", "my-en", "mx-es", "nl-nl", "nz-en", "no-no", "pk-en", "pe-es", "ph-en", "pl-pl", "pt-pt", "ro-ro", "ru-ru", "xa-ar", "sg-en", "sk-sk", "sl-sl", "za-en", "es-ca", "es-es", "se-sv", "ch-de", "ch-fr", "tw-tzh", "th-en", "tr-tr", "us-en", "us-es", "ua-uk", "uk-en", "vn-en" ], "type": "string", "description": "๐Ÿ—บ๏ธ Results feel different per country โ€” choose where DuckDuckGo should โ€œsearch fromโ€ for the most relevant local mix.", "default": "wt-wt" }, "safeSearch": { "title": "๐Ÿ›ก๏ธ Safe search", "enum": [ "OFF", "MODERATE", "STRICT" ], "type": "string", "description": "๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘ง Filter how strict DuckDuckGo is about adult or sensitive content โ€” OFF is widest, STRICT is most family-friendly.", "default": "OFF" }, "maxItems": { "title": "๐Ÿ“Š Max results to save", "minimum": 1, "maximum": 1000, "type": "integer", "description": "๐Ÿงฎ Cap how many rows land in your dataset (1โ€“1000). Lower = faster & cheaper; higher = deeper coverage.", "default": 20 }, "endPage": { "title": "๐Ÿ“„ Last page to scrape", "minimum": 0, "maximum": 100, "type": "integer", "description": "๐Ÿ”ข Stop after this page number (0โ€“100). Handy when you only need the first few SERPs โ€” applies per search / start URL.", "default": 3 }, "proxyConfiguration": { "title": "๐ŸŒ Proxy configuration", "type": "object", "description": "๐Ÿš€ Route requests through datacenter or residential IPs to reduce blocks โ€” turn on when you scale up or hit rate limits." } } }, "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 } } } } } } } } } }