# Yahoo Search

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/yahoo/search` |
| **Base URL** | `https://api.autom.dev` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/yahoo-search |

## Description

Query Yahoo via API and retrieve structured organic results with country and language.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.autom.dev/register

## Example Request

```bash
curl --location --request GET 'https://api.autom.dev/v2/yahoo/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Search openai

```json
{
  "organic_results": [
    {
      "link": "https://openai.com/",
      "title": "OpenAI",
      "domain": "openai.com",
      "snippet": "OpenAI is an AI research and deployment company.",
      "position": 1,
      "displayed_link": "https://openai.com"
    }
  ],
  "search_parameters": {
    "q": "openai",
    "gl": "us",
    "hl": "en",
    "page": 1,
    "engine": "yahoo"
  }
}
```

## Documentation

## Overview
Query Yahoo and retrieve organic results: title, link, domain, snippet, and position.

## Quickstart
```
POST https://api.piloterr.com/v2/yahoo/search
Content-Type: application/json

{"query": "openai", "page": 1, "gl": "us", "hl": "en"}
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search query |
| `page` | integer | no | Page number, starting at 1 |
| `gl` | string | no | Country code, for example us, fr, de, gb |
| `hl` | string | no | Language code, for example en, fr, de, ja |

## Response
`organic_results` contains `position`, `title`, `link`, `domain`, `displayed_link`, and `snippet`. `search_parameters.engine` is `yahoo`.

## Notes
- An empty query returns 400.
- A page with no results returns 404.
- Japan is served from the US host with `hl=ja`.