Yahoo!デベロッパーネットワーク - オークション

リクエストパラメータ

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

パラメータ	値	説明
appid（必須）	string	アプリケーションのIDです。詳細はこちらをご覧ください。
callback	string	JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
query（必須）	string	検索キーワードです。
type	string	指定検索の種類です。 all ：全クエリー文字を含む検索結果を返します。 any ：クエリー文字のうちいずれかを含む検索結果を返します。
category	integer	カテゴリIDです。指定のない場合は全カテゴリを対象として検索を行ないます。
page	integer	ページ番号です。指定のない場合は1ページ目のリクエストとみなします。
sort	string	ソート項目です。指定のない場合は終了時間の昇順（近い順）になります。ただし、その商品リストに「注目のオークション」ある場合は、「注目のオークション（注目のオークション利用料の金額の降順）」「すべてのオークション（終了時間の昇順）」の順となります。 end ：終了時間 img ：画像の有無 bids ：入札数 cbids ：現在価格 bidorbuy ：即決価格
order	string	ソートの順番です。（a ：昇順　d ：降順）
store	integer	商品の出品区分の絞り込み指定です。 0 ：すべての商品 1 ：オークションストアの出品 2 ：一般の出品者の出品
aucminprice	integer	商品価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします
aucmaxprice	integer	商品価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。
aucmin_bidorbuy_price	integer	即決価格の範囲指定の下限値です。指定のない場合は下限値指定なしとみなします。
aucmax_bidorbuy_price	integer	即決価格の範囲指定の上限値です。指定のない場合は上限値指定なしとみなします。
loc_cd	integer	地域コードです。1：北海道～48：海外の指定が可能です。指定のない場合はすべての商品になります。
easypayment	integer	Yahoo!かんたん決済の利用が可能な商品の絞り込み指定です。指定のない場合はすべての商品になります。
ybank	integer	Yahoo!ネットバンキングの利用が可能な商品の絞り込み指定です。指定のない場合はすべての商品になります。
new	integer	「new」アイコンのついた商品の絞り込み指定です。指定のない場合はすべての商品になります。
freeshipping	integer	送料無料の商品の絞り込み指定です。指定のない場合はすべての商品になります。
wrappingicon	integer	贈答品向き商品の絞り込み指定です。指定のない場合はすべての商品になります。
buynow	integer	即決価格が設定されている商品の絞り込み指定です。指定のない場合はすべての商品になります。
thumbnail	integer	画像のある商品の絞り込み指定です。指定のない場合はすべての商品になります。
attn	integer	注目のオークションの商品の絞り込み指定です。指定のない場合はすべての商品になります。
english	integer	Yahoo!オークション英語版の絞り込み指定です。指定のない場合はすべての商品になります。
point	integer	Yahoo!ポイントの設定された商品の絞り込み指定です。指定のない場合はすべての商品になります。
gift_icon	integer	目立ちアイコンのついた商品の絞り込み指定です。 0 ：指定なし 2 ：美品 3 ：非売品 4 ：限定品 5 ：保証書付 6 ：全巻セット 7 ：正規店購入 8 ：産地直送指定のない場合はすべての商品になります。
item_status	integer	商品状態での絞り込み指定です。 0 ：指定なし 1 ：新品 2 ：中古指定のない場合はすべての商品になります。
offer	integer	値下げ交渉が設定された商品の絞り込み指定です。指定のない場合はすべての商品になります。

サンプルリクエストURL

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

レスポンスフィールド

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

フィールド	説明
ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable：該当件数の総個数です。 totalResultsReturned：返された値の個数です。 firstResultPosition：最初のデータが何個目に当たるかです。
Result	各個別レスポンスを含みます。
UnitsWord	関連検索ワードです。（最大5件）
Item	商品（オークション）の情報を含みます。
AuctionID	商品（オークション）のIDです。
Title	商品（オークション）のタイトルです。
Seller	出品者に関する情報です。
Id	出品者のYahoo! JAPAN IDです。
ItemListUrl	この出品者の出品リストを取得するリクエストURLです。（appidは含まれていませんのでご注意ください）
RatingUrl	この出品者の評価リストを取得するリクエストURLです。（appidは含まれていませんのでご注意ください）
ItemUrl	商品（オークション）のURLです。
Image	画像（サムネイル）のURLです。以下の属性を持ちます。 width：サムネイルの横幅です。 height：サムネイルの縦幅です。
CurrentPrice	現在価格です。¥記号やカンマは含みません。小数点第二位までの精度です。
Bids	現在の入札数です。
EndTime	終了予定日時です。RFC3339に準拠した表現を用います。（例：2004-04-01T12:00:00+09:00）
BidOrBuy	即決価格です。（設定されていない場合は要素なし）
IsReserved	最低落札価格の有無です。（あり：`true`　なし：`false`）
Option	商品（オークション）に設定されているオプション情報です。
NewIcon	「new」アイコンのURLです。
StoreIcon	「ストア」アイコンのURLです。
CheckIcon	「鑑定済み」アイコンのURLです。
PublicIcon	「官公庁オークション」アイコンのURLです。
FeaturedIcon	「注目のオークション」アイコンのURLです。
FreeshippingIcon	「送料無料」アイコンのURLです。
NewItemIcon	「新品」アイコンのURLです。
YBankIcon	Yahoo!ネットバンキング対応の場合に「Yahoo!ネットバンキング」アイコンのURLが設定されます。
WrappingIcon	「贈答品」アイコンのURLです。
BuynowIcon	「即決価格」アイコンのURLです。
EasyPaymentIcon	「Yahoo!かんたん決済」アイコンのURLです。
GiftIcon	「目立ち」アイコンのURLです。
EnglishIcon	「Yahoo!オークション英語版」アイコンのURLです。
PointIcon	「Yahoo!ポイント」アイコンのURLです。
IsBold	太字設定の有無です。（あり：`true`　なし：`false`）
IsBackGroundColor	背景色設定の有無です。（あり：`true`　なし：`false`）
IsOffer	値下げ交渉設定の有無です。（あり：`true`　なし：`false`）

サンプルレスポンス

以下は、category=23632&query=サンプル のクエリーの結果です。

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet 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/V2/search.xsd" totalResultsAvailable="18" totalResultsReturned="18" firstResultPosition="1">
 <Result>
  <Item>
   <AuctionID>x12345</AuctionID>
   <Title>サンプルタイトル１</Title>
   <Seller>
    <Id>hogehoge</Id>
    <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?appid=sampl_appid&sellerID=hogehoge</ItemListUrl>
    <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?appid=sampl_appid&id=hogehoge</RatingUrl>
   </Seller>
   <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?appid=sampl_appid&auctionID=x12345</ItemUrl>
   <Image width="36" height="100">http://img239.auctions.yahoo.co.jp/users/2/6/8/8/test-thumb.jpg</Image>
   <CurrentPrice>25000.00</CurrentPrice>
   <Bids>0</Bids>
   <EndTime>2009-03-10T22:56:19+09:00</EndTime>
   <BidOrBuy>26800.00</BidOrBuy>
   <IsReserved>false</IsReserved>
   <Option>
    <NewIcon>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif</NewIcon>
    <NewItemIcon>http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif</NewItemIcon>
    <YBankIcon>http://i.yimg.jp/images/sicons/bank16.gif</YBankIcon>
    <BuynowIcon>http://image.auctions.yahoo.co.jp/images/buynow.gif</BuynowIcon>
    <EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif</EasyPaymentIcon>
    <IsBold>false</IsBold>
    <IsBackGroundColor>false</IsBackGroundColor>
   </Option>
  </Item>
  <Item>
   <AuctionID>x67890</AuctionID>
   <Title>サンプルタイトル２</Title>
   <Seller>
    <Id>hogehoge</Id>
    <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?appid=sampl_appid&sellerID=hogehoge</ItemListUrl>
    <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?appid=sampl_appid&id=hogehoge</RatingUrl>
   </Seller>
   <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?appid=sampl_appid&auctionID=x67890</ItemUrl>
   <Image width="100" height="100">http://img249.auctions.yahoo.co.jp/users/2/6/8/8/test-thumb.jpg</Image>
   <CurrentPrice>9800.00</CurrentPrice>
   <Bids>0</Bids>
   <EndTime>2009-03-10T23:16:53+09:00</EndTime>
   <BidOrBuy>9800.00</BidOrBuy>
   <IsReserved>false</IsReserved>
   <Option>
    <NewIcon>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif</NewIcon>
    <FreeShippingIcon>http://image.auctions.yahoo.co.jp/images/pstfree.gif</FreeShippingIcon>
    <NewItemIcon>http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif</NewItemIcon>
    <YBankIcon>http://i.yimg.jp/images/sicons/bank16.gif</YBankIcon>
    <BuynowIcon>http://image.auctions.yahoo.co.jp/images/buynow.gif</BuynowIcon>
    <EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif</EasyPaymentIcon>
    <IsBold>false</IsBold>
    <IsBackGroundColor>false</IsBackGroundColor>
   </Option>
  </Item>
  <Item>
   <AuctionID>a09876</AuctionID>
   <Title>サンプルタイトル３</Title>
   <Seller>
    <Id>foofoo</Id>
    <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?appid=sampl_appid&sellerID=foofoo</ItemListUrl>
    <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?appid=sampl_appid&id=foofoo</RatingUrl>
   </Seller>
   <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?appid=sampl_appid&auctionID=a09876</ItemUrl>
   <Image width="134" height="100">http://img131.auctions.yahoo.co.jp/users/6/5/5/7/test-thumb.jpg</Image>
   <CurrentPrice>14000.00</CurrentPrice>
   <Bids>0</Bids>
   <EndTime>2009-03-11T14:45:25+09:00</EndTime>
   <BidOrBuy>14000.00</BidOrBuy>
   <IsReserved>false</IsReserved>
   <Option>
    <NewIcon>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif</NewIcon>
    <NewItemIcon>http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif</NewItemIcon>
    <YBankIcon>http://i.yimg.jp/images/sicons/bank16.gif</YBankIcon>
    <BuynowIcon>http://image.auctions.yahoo.co.jp/images/buynow.gif</BuynowIcon>
    <EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif</EasyPaymentIcon>
    <IsBold>false</IsBold>
    <IsBackGroundColor>false</IsBackGroundColor>
   </Option>
  </Item>

  （以下 <Item>要素繰り返し）

 </Result>
</ResultSet>

サンプルレスポンス（PHPserialize）

以下は、query=ipod のクエリーの結果です。

array (
  'ResultSet' => 
  array (
    'totalResultsAvailable' => '18',
    'totalResultsReturned' => '18',
    'firstResultPosition' => '1',
    'Result' => 
    array (
      'Item' => 
      array (
        0 => 
        array (
          'AuctionID' => 'x12345',
          'Title' => 'サンプルタイトル１',
          'Seller' => 
          array (
            'Id' => 'hogehoge',
            'ItemListUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=hogehoge',
            'RatingUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=hogehoge',
          ),
          'ItemUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=x12345',
          'Image' => 'http://img239.auctions.yahoo.co.jp/users/2/6/8/8/test-thumb.jpg',
          'CurrentPrice' => '25000.00',
          'Bids' => '0',
          'EndTime' => '2009-03-10T22:56:19+09:00',
          'BidOrBuy' => '26800.00',
          'IsReserved' => false,
          'Option' => 
          array (
            'NewIcon' => 'http://image.auctions.yahoo.co.jp/i/auctions/new3.gif',
            'NewItemIcon' => 'http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif',
            'YBankIcon' => 'http://i.yimg.jp/images/sicons/bank16.gif',
            'BuynowIcon' => 'http://image.auctions.yahoo.co.jp/images/buynow.gif',
            'EasyPaymentIcon' => 'http://i.yimg.jp/images/pay/icon_s16.gif',
            'IsBold' => false,
            'IsBackGroundColor' => false,
          ),
        ),
        1 => 
        array (
          'AuctionID' => 'x67890',
          'Title' => 'サンプルタイトル２',
          'Seller' => 
          array (
            'Id' => 'hogehoge',
            'ItemListUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=hogehoge',
            'RatingUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=hogehoge',
          ),
          'ItemUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=x67890',
          'Image' => 'http://img249.auctions.yahoo.co.jp/users/2/6/8/8/test-thumb.jpg',
          'CurrentPrice' => '9800.00',
          'Bids' => '0',
          'EndTime' => '2009-03-10T23:16:53+09:00',
          'BidOrBuy' => '9800.00',
          'IsReserved' => false,
          'Option' => 
          array (
            'NewIcon' => 'http://image.auctions.yahoo.co.jp/i/auctions/new3.gif',
            'FreeShippingIcon' => 'http://image.auctions.yahoo.co.jp/images/pstfree.gif',
            'NewItemIcon' => 'http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif',
            'YBankIcon' => 'http://i.yimg.jp/images/sicons/bank16.gif',
            'BuynowIcon' => 'http://image.auctions.yahoo.co.jp/images/buynow.gif',
            'EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif',
            'IsBold' => false,
            'IsBackGroundColor' => false,
          ),
        ),
        2 => 
        array (
          'AuctionID' => 'a09876',
          'Title' => 'サンプルタイトル３',
          'Seller' => 
          array (
            'Id' => 'foofoo',
            'ItemListUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=foofoo',
            'RatingUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=foofoo',
          ),
          'ItemUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a09876',
          'Image' => 'http://img131.auctions.yahoo.co.jp/users/6/5/5/7/test-thumb.jpg',
          'CurrentPrice' => '14000.00',
          'Bids' => '0',
          'EndTime' => '2009-03-11T14:45:25+09:00',
          'BidOrBuy' => '14000.00',
          'IsReserved' => false,
          'Option' => 
          array (
            'NewIcon' => 'http://image.auctions.yahoo.co.jp/i/auctions/new3.gif',
            'NewItemIcon' => 'http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif',
            'YBankIcon' => 'http://i.yimg.jp/images/sicons/bank16.gif',
            'BuynowIcon' => 'http://image.auctions.yahoo.co.jp/images/buynow.gif',
            'EasyPaymentIcon' => 'http://i.yimg.jp/images/pay/icon_s16.gif',
            'IsBold' => false,
            'IsBackGroundColor' => false,
          ),
        ),

        (以下、 繰り返し)

      ),
    ),
  ),
)

サンプルレスポンス（JSONP）

以下は、query=ipod, callback=loaded のクエリーの結果です。

loaded(
{
    "AuctionSearchResult":
    {
        "@attributes":
        {
            "totalAuctions":"14994",
            "totalPage":"300",
            "curPage":"1",
            "categoryId":"0"
        },
        "item":[
        {
            "auctionID":"x12345",
            "title":"\u2606\u5373\u6c7a\u2606ipod\u3000nano\u98a8mp4\u30d7\u30ec\u30fc\u30e4\u30fc8G\u30e1\u30e2\u30ea\u5185\u8535\u25ce\u52d5\u753b\u97f3\u697d\u518d\u751f",
            "seller":
            {
                "id":"hogehoge",
                "itemlist":"http:\/\/api.auctions.yahoo.co.jp\/AuctionWebService\/V2\/SellingList?sellerID=hogehoge",
                "rating":"http:\/\/rating3.auctions.yahoo.co.jp\/jp\/show\/rating?userID=hogehoge"
            },
            "url":"http:\/\/page14.auctions.yahoo.co.jp\/jp\/auction\/x12345",
            "img":"http:\/\/img239.auctions.yahoo.co.jp\/users\/2\/6\/8\/8\/test-thumb.jpg",
            "price":"4,980 \u5186",
            "bids":"0",
            "endtime":"3\u6708 24\u65e5 21\u6642 15\u5206",
            "bidorbuy":"5,980 \u5186",
            "option":
            {
                "store":"http:\/\/image.auctions.yahoo.co.jp\/images\/premium.gif",
                "buynow":"http:\/\/image.auctions.yahoo.co.jp\/images\/buynow.gif",
                "easypayment":"http:\/\/i.yimg.jp\/images\/pay\/icon_s16.gif"
            }
        },
        {
            "auctionID":"x67890",
            "title":"\u25ceipod\u98a8mp3\u30d7\u30ec\u30fc\u30e4\u30fc\uff12GB\u5185\u8535\u30af\u30ea\u30c3\u30d7\u5f0f5\u8272\u5bfe\u5fdc\u54c1\u5145\u96fb\u5f0f",
            "seller":
            {
                "id":"hogehoge",
                "itemlist":"http:\/\/api.auctions.yahoo.co.jp\/AuctionWebService\/V1\/SellingList?sellerID=hogehoge",
                "rating":"http:\/\/rating3.auctions.yahoo.co.jp\/jp\/show\/rating?userID=hogehoge"
            },
            "url":"http:\/\/page14.auctions.yahoo.co.jp\/jp\/auction\/x67890",
            "img":"http:\/\/img249.auctions.yahoo.co.jp\/users\/2\/6\/8\/8\/test-thumb.jpg",
            "price":"1,900 \u5186",
            "bids":"0",
            "endtime":"3\u6708 24\u65e5 21\u6642 16\u5206",
            "bidorbuy":"1,980 \u5186",
            "option":
            {
                "store":"http:\/\/image.auctions.yahoo.co.jp\/images\/premium.gif",
                "buynow":"http:\/\/image.auctions.yahoo.co.jp\/images\/buynow.gif",
                "easypayment":"http:\/\/i.yimg.jp\/images\/pay\/icon_s16.gif"
            }
        },
        {
            "auctionID":"a09876",
            "title":"\u25ceipod\u98a8mp3\u30d7\u30ec\u30fc\u30e4\u30fc\uff12GB\u5185\u8535\u30af\u30ea\u30c3\u30d7\u5f0f5\u8272\u5bfe\u5fdc\u54c1\u5145\u96fb\u5f0f",
            "seller":
            {
                "id":"hogehoge",
                "itemlist":"http:\/\/api.auctions.yahoo.co.jp\/AuctionWebService\/V1\/SellingList?sellerID=hogehoge",
                "rating":"http:\/\/rating3.auctions.yahoo.co.jp\/jp\/show\/rating?userID=hogehoge"
            },
            "url":"http:\/\/page14.auctions.yahoo.co.jp\/jp\/auction\/a09876",
            "img":"http:\/\/img249.auctions.yahoo.co.jp\/users\/2\/6\/8\/8\/test-thumb.jpg",
            "price":"1,900 \u5186",
            "bids":"0",
            "endtime":"3\u6708 24\u65e5 21\u6642 16\u5206",
            "bidorbuy":"1,980 \u5186",
            "option":
            {
                "store":"http:\/\/image.auctions.yahoo.co.jp\/images\/premium.gif",
                "buynow":"http:\/\/image.auctions.yahoo.co.jp\/images\/buynow.gif",
                "easypayment":"http:\/\/i.yimg.jp\/images\/pay\/icon_s16.gif"
            }
        },

        （以下 要素繰り返し）

        }]
    }
})

エラー

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

検索

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

サンプルレスポンス（PHPserialize）

サンプルレスポンス（JSONP）

エラー

利用制限

検索を使用した開発に関するQ＆A

お役立ち度の高い解決済みの質問

Web APIとその他のサービス

API

その他

このAPIを使ったサンプルコード

関連ドキュメント

開発者ブログ

開発者コミュニティ

開発のヒント

法人デベロッパー専用お問い合わせ