> 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`.

# Yahoo Search

Structured Yahoo data: send `queries`. Cursor-paginated, 1 credit per successful call.

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

## Overview

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

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/yahoo-search/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=java developer" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/yahoo-search/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "java developer"},
    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. |
| `queries` | string | yes | e.g. `java developer` | 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. |
| `time_period` | string | no | `Anytime` | Filter by recency. One of: `Anytime`, `Past day`, `Past week`, `Past month`. Locked in cursor. |
| `backfill_empty_results` | boolean | no | `true` | Fetch each result's own page to fill in `text`/`links` when Yahoo's SERP snippet is empty. Locked in cursor. |
| `backfill_concurrency` | integer | no | `8` | Concurrent backfill page fetches per page. Locked in cursor. |
| `backfill_max_links` | integer | no | `10` | Max sub-links to extract per backfilled result page. Locked in cursor. |
| `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": "java developer",
    "page": 1,
    "page_size": 7,
    "results": [
      {
        "url": "https://www.geeksforgeeks.org/gfg-academy/how-to-become-a-java-developer/",
        "title": "How to become a Java Developer? - GeeksforGeeks",
        "description": "What is a Java Developer? A Java Developer is a software engineer who builds, maintains, and improves applications using Java.",
        "text": "  * Careers & Jobs in Java\n\nCareers in Java are in high demand...\n",
        "logo_url": "https://s.yimg.com/pv/static/search_favicon/images/32x32_7eae5aac8b7f7402.png",
        "links": [
          "https://www.geeksforgeeks.org/java/careers-jobs-in-java/"
        ],
        "domain": "www.geeksforgeeks.org"
      }
    ],
    "next_cursor": "eyJxIjoiamF2YSBkZXZlbG9wZXIiLCJiIjo4LCJ0cCI6IkFueXRpbWUiLCJiZiI6dHJ1ZSwiYmMiOjgsImJsIjoxMCwiaCI6ImFiYzEyM2RlZiJ9"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `query` | string | `java developer` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `7` |  |
| `results` | array | `[1 item]` | The results. |
| `next_cursor` | string | `eyJxIjoiamF2YSBkZXZlbG9wZXIiLCJiIjo4LCJ0cCI6I…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `results[].url` | string | `https://www.geeksforgeeks.org/gfg-academy/how…` |  |
| `results[].title` | string | `How to become a Java Developer? - GeeksforGeeks` |  |
| `results[].description` | string | `What is a Java Developer? A Java Developer is…` |  |
| `results[].text` | string | `  * Careers & Jobs in Java Careers in Java a…` |  |
| `results[].logo_url` | string | `https://s.yimg.com/pv/static/search_favicon/i…` |  |
| `results[].links` | array | `[1 item]` |  |
| `results[].domain` | string | `www.geeksforgeeks.org` |  |

## 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/yahoo-search/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "java developer"}
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

- Locked into the cursor: `time_period`, `backfill_empty_results`, `backfill_concurrency`, `backfill_max_links`. Set them on the first call; later pages reuse them.

## Related

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