オークション

検索

リクエストURL
XML
http://auctions.yahooapis.jp/AuctionWebService/V1/Search

こちらのAPIは、2015年4月15日に終了させていただきました。最新バージョンのAPIをご利用ください。

ヤフオク!の商品の検索機能を提供します。

リクエストパラメータ

RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
appid(必須) string アプリケーションID。詳細はこちらをご覧ください。
query(必須) string (UTF-8エンコードされた)検索キーワードを指定します。
type string: all(デフォルト),any 指定検索の種類:
  • allは全クエリー文字を含む検索結果を返します。
  • anyはクエリー文字のうちいずれかを含む検索結果を返します。
category integer 取得したいヤフオク!のカテゴリIDを指定します。最上位のカテゴリの場合は0を指定します。(categoryパラメータがない場合も最上位カテゴリのリクエストとみなします)
page integer:1(デフォルト) 検索結果のページ番号の指定です。指定のない場合は1ページ目のリクエストとみなします。
aucminprice integer 商品価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします。
aucmaxprice integer 商品価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。
aucmin_bidorbuy_price integer 希望落札価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします。
aucmax_bidorbuy_price integer 希望落札価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。
aucmin_buynow_price integer 即買価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします。
aucmax_buynow_price integer 即買価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。
loc_cd integer: 1~48 地域コードです。1:北海道~48:海外の指定が可能です。指定のない場合はすべての商品になります。
store integer: 0(デフォルト),1,2 商品の出品区分の絞り込み指定です。
0:すべての商品
1:オークションストアの出品
2:一般の出品者の出品
easypayment integer: 1 Yahoo!かんたん決済の利用が可能な商品の絞り込み指定です。指定のない場合はすべての商品になります。
new integer: 1 newアイコンのついた商品の絞り込み指定です。指定のない場合はすべての商品になります。
largeimg integer: 1 特大画像付きの商品の絞り込み指定です。指定のない場合はすべての商品になります。
freeshipping integer: 1 送料無料の商品の絞り込み指定です。指定のない場合はすべての商品になります。
wrappingicon integer: 1 贈答品向き商品の絞り込み指定です。指定のない場合はすべての商品になります。
buynow integer: 1 即買商品の絞り込み指定です。指定のない場合はすべての商品になります。
thumbnail integer: 0(デフォルト), 1 画像ありの商品の絞り込み指定です。指定のない場合はすべての商品になります。
attn integer: 0(デフォルト), 1 注目のオークションの商品の絞り込み指定です。指定のない場合はすべての商品になります。
gift_icon integer: 0(デフォルト)~8 目立ちアイコンのついた商品の絞り込み指定です。
0: 指定なし
1: 新品
2: 美品
3: 非売品
4: 限定品
5: 保証書付
6: 全巻セット
7: 正規店購入
8: 産地直送
指定のない場合はすべての商品になります。
sort string: 右記参照  商品リストのソート項目の指定です。指定のない場合は終了時間の昇順(近い順)になります。ただし、その商品リストに「注目のオークション」がある場合は、「注目のオークション(注目のオークション利用料の金額の降順)」「すべてのオークション(終了時間の昇順)」の順となります。
img: 画像の有無
item : タイトル
cbids: 現在価格
bids : 入札数
end : 終了時間
order string: a(デフォルト), d 上記のソートの順序の指定です。
a: 昇順
d: 降順
※注 img、bidsのみaが降順、dが昇順となります。

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V1/Search?appid=<あなたのアプリケーションID>&query=%E3%83%91%E3%82%BD%E3%82%B3%E3%83%B3


レスポンスフィールド

検索のスキーマの記述は、以下のURLをご覧ください。
http://auctions.yahooapis.jp/AuctionWebService/V1/SearchResult.xsd

フィールド 説明
AuctionSearchResult クエリーレスポンスのすべてを含み、次の属性を持ちます。
  • totalAuctions: 検索条件に一致した商品(オークション)の総数
  • totalPage: 検索条件に一致したページの総数
  • curPage: 現在のページ番号
item 以下の各商品(オークション)情報を含みます。
auctionID 商品(オークション)のIDです。
title 商品(オークション)のタイトルです。
seller 出品者に関する情報です。
id 出品者のYahoo! JAPAN IDです。
itemlist この出品者の出品リストを取得するリクエストURLです。(appidは含まれていませんのでご注意ください)
rating この出品者の評価のページのURLです。
url 商品詳細(オークション)ページのURLです。
img 画像(サムネイル)のURLです。
price 現在価格です。
bids 現在の入札数です。
endtime オークションの終了日時です。
bidorbuy 希望落札価格です。(設定されていない場合は要素なし)
reserved 最低落札価格の有無です。(設定されていない場合は要素なし)
option 商品(オークション)にオプションが設定されている場合、そのオプションのアイコン(GIFファイル)のURLを示します。
new 「new」アイコンのURLです。
store 「ストア」アイコンのURLです。
check 「鑑定済み」アイコンのURLです。
public 「公売」アイコンのURLです。
freeshipping 「送料無料」のアイコンのURLです。
wrappingicon 「贈答品」アイコンのURLです。
buynow 「即買」アイコンのURLです。
easypayment 「Yahoo!かんたん決済」アイコンのURLです。
largeimg 「特大画像」アイコンのURLです。
gift_icon 「目立ち」アイコンのURLです。



サンプルレスポンス

以下は、パソコン のクエリーの結果です。

<?xml version="1.0" encoding="UTF-8" ?>
<AuctionSearchResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:search" xsi:schemaLocation="urn:yahoo:jp:auc:search http://auctions.yahooapis.jp/AuctionWebService/V1/SearchResult.xsd"totalAuctions="461" totalPage="11" curPage="1" >
 <item>
  <auctionID>x12345678</auctionID> 
  <title>★★Pentium4 530 1GB 16倍速DVD±R/DL/RW★★</title> 
  <seller>
   <id>aaaaa123456789</id> 
<itemlist>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=aaaaa123456789</itemlist> 
   <rating>http://rating8.auctions.yahoo.co.jp/jp/show/rating?userID=aaaaa123456789</rating> 
  </seller>
<url>http://page14.auctions.yahoo.co.jp/jp/auction/x12345678</url> 
<img>http://a1025.lm.a.yimg.com/7/1025/1783/000/bag05pr000.ac.yahoo.co.jp/
users/7/5/3/5/aaaaa123456789-thumb-1141742409244944.jpg</img> 
  <price>7,950 円</price> 
  <bids>10</bids> 
  <endtime>3月 9日 22時 40分</endtime> 
  <option>
  <new>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif</new> 
 <store>http://image.auctions.yahoo.co.jp/images/premium.gif</store>
<easypayment>http://i.yimg.jp/images/pay/icon_s16.gif</easypayment>
<gift_icon>http://a1017.lm.a.yimg.com/7/1017/1783/000/image.auctions.yahoo.co.jp/images/gift/
c_attention_05.gif</gift_icon> 
  </option>
 </item>
 <item>
  <auctionID>x88888789</auctionID> 
  <title>★ABC DEF 静音 P4/1.7 新品同様!★</title> 
  <seller>
   <id>z1b2c3d4e5f6789</id> 
<itemlist>http://auctions.yahooapis.jp/AuctionWebService/V1/SellingList?sellerID=z1b2c3d4e5f6789</itemlist> 
   <rating>http://rating6.auctions.yahoo.co.jp/jp/show/rating?userID=z1b2c3d4e5f6789</rating> 
  </seller>
 <url>http://page2.auctions.yahoo.co.jp/jp/auction/x88888789</url> 
<img>http://ac.c.yimg.jp/7/1026/1783/000/img217.auctions.yahoo.co.jp/users/5/6/2/6/
z1b2c3d4e5f6789-thumb-114172473691401.jpg</img> 
  <price>10 円</price> 
  <bids>5</bids> 
  <endtime>3月 9日 23時 58分</endtime> 
  <bidorbuy>39,800 円</bidorbuy> 
  <option>
  <new>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif</new> 
<gift_icon>http://a1017.lm.a.yimg.com/7/1017/1783/000/image.auctions.yahoo.co.jp/images/gift/
c_attention_02.gif</gift_icon> 
  </option>
 </item>
 
 (以下 <item>要素繰り返し)

</AuctionSearchResult>



エラー

検索はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。