Apinoa Docs

Search

Get one Yahoo! JAPAN results page, with every block in page order.

View raw .mdx
GET | POST /v1/yahoo-japan/search

Send parameters as a query string with GET, or as a JSON body with POST. Both are equivalent.

Request

curl -G "https://gateway.apinoa.com/v1/yahoo-japan/search" \
  --data-urlencode "q=東京 ラーメン" \
  -H "x-api-key: $APINOA_API_KEY"

Parameters

ParameterTypeRequiredNotes
countryenumThe market, as an ISO 3166 country code. JP
cursorstringThe previous page's cursor. Pass it alone for the next page.
deviceenumWhich page to read: the desktop (default) or the mobile one. desktop mobile
limitinteger 1–100Results wanted (default 10, at most 100). More than one page is charged per page.
qstringThe query, search operators included.
timeRangeenumOnly results from this past period. hour day week month year
typeenumWhat to search: web results (default), news, images or videos. web news images videos

The same parameters, and every response type, are in the OpenAPI document.

Response

Returns ResultsPage in data. A real response, shortened: arrays keep their first entries and long text is cut.

{
  "success": true,
  "data": {
    "engine": "yahoo-japan",
    "query": "東京 ラーメン",
    "type": "web",
    "outcome": "results",
    "country": "JP",
    "device": "desktop",
    "totalResults": 95100000,
    "page": 1,
    "items": [
      {
        "type": "relatedSearches",
        "queries": ["東京 ラーメン ランキング"],
        "ext": {"shown": 3, "placement": "top"},
        "rank": 1
      },
      {
        "type": "localPack",
        "places": [
          {
            "id": "oVCz0MkZEOo",
            "name": "銀座 八五",
            "url": "https://map.yahoo.co.jp/place?gid=oVCz0MkZEOo&fr=sydd_p-grmlist-gourmet-list_gl-ttl&from_s…",
            "categories": ["ラーメン店"],
            "rating": 4.24,
            "reviewCount": 362,
            "website": "https://katsumoto-japan.com/",
            "photos": ["https://searchgourmetlist-pctr.c.yimg.jp/KD3zi0uFROIrUpGBKHZNKT29WYmZtb8_P4Hu0p54ztvnRNdPK…"],
            "ext": {
              "hoursText": "営業状況変更の可能性",
              "access": "東銀座駅[A7]徒歩2分",
              "reviewKeywords": {"items": [{"count": 55, "name": "おひとりさま向き"}], "totalCount": 215},
              "menu": [
                {
                  "imageType": "menu",
                  "imageUrl": "https://searchgourmetlist-pctr.c.yimg.jp/KD3zi0uFROIrUpGBKHZNKT29WYmZtb8_P4Hu0p54ztsiks7dD…",
                  "title": "八五ラーメン",
                  "price": "1,000円〜",
                  "poiUrl": "https://map.yahoo.co.jp/v3/place/oVCz0MkZEOo/menu/624982ffe99e5a203f9edd7f?fr=sydd_p-grmli…",
                  "isQueryMatch": true
                }
              ],
              "photoTypes": ["menu"],
              "menuUrl": "https://map.yahoo.co.jp/v3/place/oVCz0MkZEOo/menu?filter=menu&fr=sydd_p-grmlist-gourmet-li…",
              "routeUrl": "https://map.yahoo.co.jp/route/train?from=%E7%8F%BE%E5%9C%A8%E5%9C%B0&to=%E9%8A%80%E5%BA%A7…"
            },
            "reviewsUrl": "https://map.yahoo.co.jp/place?gid=oVCz0MkZEOo&tab=review&fr=sydd_p-grmlist-gourmet-list_gl…"
          }
        ],
        "ext": {
          "title": "東京周辺のラーメン(12346件)",
          "mapUrl": "https://map.yahoo.co.jp/search?q=%E6%9D%B1%E4%BA%AC%20%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3…",
          "source": "Yahoo!マップ"
        },
        "rank": 2,
        "moreUrl": "https://map.yahoo.co.jp/search?q=%E6%9D%B1%E4%BA%AC%20%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3…",
        "total": 12346
      },
      {
        "type": "organic",
        "position": 1,
        "url": "https://s.tabelog.com/ramen/tokyo/rank",
        "title": "東京で人気のラーメン・つけ麺 ランキングTOP20 - 食べログ",
        "snippet": "東京 ラーメン・つけ麺 人気ランキングTOP20 · 1らぁ麺や 嶋 · 2中華そば しば田 · 3ジャパニーズ ラーメン 五感 · 4Homemade Ramen 麦苗 · 5銀…",
        "site": "食べログ",
        "displayUrl": "s.tabelog.com/ramen/tokyo/rank",
        "favicon": "data:image/png;base64,iVBORw0KGgoAAAANSU…",
        "ext": {"breadcrumbs": ["https://s.tabelog.com"], "exploreQueries": ["東京 ラーメン ランキング"]},
        "rank": 3,
        "images": ["https://searchysnippet-pctr.c.yimg.jp/uUzvQ3lML_bkIqyakc1vFi9yrQXh6avYqqVdgqvBtiCaArZ038dg…"],
        "lang": "ja"
      },
      {
        "type": "peopleAlsoAsk",
        "questions": [
          {
            "question": "東京のラーメンランキングで1位はどこですか?",
            "answer": "東京で最新の人気ラーメンを探すなら、まずは食べログの「東京都 ラーメンランキング(2026年9月1日更新)」を基準に見るのが実用的です。",
            "url": "https://tabelog.com/ramen/tokyo/rank/?msockid=10082d06807e60ee165c3bf781a7613d&utm_source=…",
            "title": "東京で人気のラーメン・つけ麺 ランキングTOP20 | 食べログ"
          }
        ],
        "ext": {
          "details": [
            {
              "sources": [
                {
                  "url": "https://tabelog.com/ramen/tokyo/rank/?msockid=10082d06807e60ee165c3bf781a7613d&utm_source=…",
                  "title": "東京で人気のラーメン・つけ麺 ランキングTOP20 | 食べログ",
                  "site": "食べログ"
                }
              ],
              "followUps": ["東京のラーメン順位は何で決まる?"]
            }
          ],
          "moreQuestions": ["東京ラーメンとはどんなラーメンですか?"]
        },
        "rank": 7,
        "title": "他の人はこちらも質問"
      }
    ],
    "cursor": "CABpuP0yN8tjQqKCzFn5exfj121ZsQYsv46xRhhTKOWs01L9ZDnrAd2NTfUfRlU1c-_chn5CvdDdp8q6QdU6P2K9GS…",
    "fetchedAt": "2026-10-30T00:58:04.163Z"
  }
}

Errors

StatusCodeMeaning
400INVALID_CURSORThe cursor is not one this operation returned. Start again without it.
400INVALID_PARAMSA parameter is missing, unknown or out of range, or the engine does not take it. The message names it.
401UNAUTHORIZEDThe x-api-key header is missing, or the key is revoked or unknown.
402INSUFFICIENT_BALANCEThe balance does not cover this call. Top up in the dashboard.
429MARKETPLACE_SATURATEDToo many concurrent calls. Retry after the Retry-After seconds.
502UPSTREAM_ERRORThe engine answered with something unusable. Retry with backoff.
503SERVICE_UNAVAILABLEA temporary failure. Retry with backoff.

Every code is listed in Errors. Failed calls are not billed.

Pricing

Price $0.0012 per call, plus $0.0012 for each extra call it makes — at most 9 more, so $0.012 in total. List price; the rate steps down above 1,000 calls a day.

On this page