> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# DuckDuckGo Search Scraper

Structured DuckDuckGo data: send `query`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/duckduckgo-search/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/duckduckgo-search/` with `query`. The results are in `data.results`; send `data.next_cursor` back as `cursor` to get the next page. 4 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/duckduckgo-search/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "query=python programming" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/duckduckgo-search/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"query": "python programming"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["results"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `query` | string | yes | e.g. `python programming` | Search term. Required on first call; ignored when `cursor` is supplied. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `search_mode` | string | no | `default` | Result type: default (web) \| images \| videos \| news. Locked into the cursor on first call. One of: `default`, `images`, `videos`, `news`. |
| `region` | string | no | `wt-wt` | DuckDuckGo region code (e.g. wt-wt, us-en, uk-en). Locked into the cursor. |
| `safe_search` | string | no | `OFF` | Safe-search level. Locked into the cursor. One of: `OFF`, `MODERATE`, `STRICT`. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.results`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "query": "python tutorial",
    "mode": "default",
    "region": "wt-wt",
    "safe_search": "OFF",
    "page": 1,
    "page_size": 10,
    "results": [
      {
        "title": "Welcome to Python.org",
        "url": "https://www.python.org/",
        "hostname": "www.python.org",
        "description": "The official home of the Python Programming Language.",
        "icon": "https://external-content.duckduckgo.com/ip3/www.python.org.ico",
        "raw_description": "The official home of the Python Programming Language.",
        "position": 1,
        "keyword": "python tutorial"
      }
    ],
    "next_cursor": "eyJoIjoiYWJjMTIzZGVmNDU2IiwibSI6ImRlZmF1bHQiLCJxIjoicHl0aG9uIHR1dG9yaWFsIiwiciI6Ind0LXd0IiwicyI6MTAsInNzIjoiT0ZGIn0"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `query` | string | `python tutorial` |  |
| `mode` | string | `default` |  |
| `region` | string | `wt-wt` |  |
| `safe_search` | string | `OFF` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `10` |  |
| `results` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJoIjoiYWJjMTIzZGVmNDU2IiwibSI6ImRlZmF1bHQiL…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `results[].title` | string | `Welcome to Python.org` |  |
| `results[].url` | string | `https://www.python.org/` |  |
| `results[].hostname` | string | `www.python.org` |  |
| `results[].description` | string | `The official home of the Python Programming L…` |  |
| `results[].icon` | string | `https://external-content.duckduckgo.com/ip3/w…` |  |
| `results[].raw_description` | string | `The official home of the Python Programming L…` |  |
| `results[].position` | integer | `1` |  |
| `results[].keyword` | string | `python tutorial` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/duckduckgo-search/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"query": "python programming"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("results") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Nothing special: send the inputs, read the result.

## Related

- [All DuckDuckGo endpoints](https://docs.scrapier.io/api-reference/duckduckgo.md)
