オークション

検索

リクエストURL
XML
http://auctions.yahooapis.jp/AuctionWebService/V2/search
PHPserialize
http://auctions.yahooapis.jp/AuctionWebService/V2/php/search
JSONP
http://auctions.yahooapis.jp/AuctionWebService/V2/json/search

※PHPserialize、JSONPのリクエストURLは非推奨です。outputパラメータを利用してください。

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

リクエストパラメータ

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

パラメータ 説明
appid(必須) string アプリケーションのIDです。詳細はこちらをご覧ください。
output string XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
  • xml :xmlレスポンス(デフォルト)
  • php :PHPserializeレスポンス
  • json :JSONPレスポンス
(※PHPserialize、JSONP専用のエントリポイントは今後、非推奨となります。こちらのリクエスト指定をご利用ください。)
callback string JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
query(必須) string 検索キーワードです。
キーワードの指定は、こちらをご覧ください。
type string 指定検索の種類です。
  • all :全クエリー文字を含む検索結果を返します。
  • any :クエリー文字のうちいずれかを含む検索結果を返します。
category integer カテゴリIDです。指定のない場合は全カテゴリを対象として検索を行ないます。
page integer ページ番号です。指定のない場合は1ページ目のリクエストとみなします。
sort string ソート項目です。指定のない場合は終了時間の昇順(近い順)になります。ただし、その商品リストに「注目のオークション」ある場合は、「注目のオークション(注目のオークション利用料の金額の降順)」「すべてのオークション(終了時間の昇順)」の順となります。
※【注意】入札数のソートは、「入札の多い順が、昇順」、「入札の少ないもの順が、降順」となります。
  • end :終了時間
  • img :画像の有無
  • bids :入札数
  • cbids :現在価格
  • bidorbuy :即決価格
  • affiliate :アフィリエイト 【NEW】
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!かんたん決済の利用が可能な商品の絞り込み指定です。指定のない場合はすべての商品になります。
new integer 「new」アイコンのついた商品の絞り込み指定です。指定のない場合はすべての商品になります。
freeshipping integer 送料無料の商品の絞り込み指定です。指定のない場合はすべての商品になります。
wrappingicon integer 贈答品向き商品の絞り込み指定です。指定のない場合はすべての商品になります。
buynow integer 即決価格が設定されている商品の絞り込み指定です。指定のない場合はすべての商品になります。
thumbnail integer 画像のある商品の絞り込み指定です。指定のない場合はすべての商品になります。
attn integer 注目のオークションの商品の絞り込み指定です。指定のない場合はすべての商品になります。
point integer Tポイントの設定された商品の絞り込み指定です。指定のない場合はすべての商品になります。
gift_icon integer 目立ちアイコンのついた商品の絞り込み指定です。
  • 0 :指定なし
  • 2 :美品
  • 3 :非売品
  • 4 :限定品
  • 5 :保証書付
  • 6 :全巻セット
  • 7 :正規店購入
  • 8 :産地直送
指定のない場合はすべての商品になります。
item_status integer 商品状態での絞り込み指定です。
  • 0 :指定なし
  • 1 :新品
  • 2 :中古
指定のない場合はすべての商品になります。
offer integer 値下げ交渉が設定された商品の絞り込み指定です。指定のない場合はすべての商品になります。
adf integer アダルトカテゴリのオークション結果を取得する際に指定してください。 (0:指定なし, 1:あり) 指定のない場合はアダルトカテゴリのレスポンスは返りません。
min_charity integer みんなのチャリティの寄付率の絞り込みの範囲指定の下限値です。(1~100)
max_charity integer みんなのチャリティの寄付率の絞り込みの範囲指定の上限値です。(1~100)
min_affiliate integer アフィリエイト料率の絞り込みの範囲指定の下限値です。(1~100)
max_affiliate integer アフィリエイト料率の絞り込みの範囲指定の上限値です。(1~100)
timebuf integer 指定された残り時間(秒)を除外して絞り込みます。(目安として1200秒以上のリクエストから有効となります)
ranking 【NEW】 string 「sort=score」リクエスト指定時に有効になる表示順序です。
  • current :キーワードマッチ順
  • popular :人気順
seller 【NEW】 string 出品者のYahoo! JAPAN IDで絞り込みを行います。コンマ(,)区切りで複数指定可能です。
f 【NEW】 string 検索対象の指定です。
  • 0x2 :「タイトル+ストア用検索キーワード」で検索
  • 0x4 :「タイトル+本文」で検索
  • 0x8 :「タイトルのみ」で検索

サンプルリクエストURL

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


レスポンスフィールド

検索APIのスキーマの記述は、以下になります。

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable:該当件数の総個数です。
  • totalResultsReturned:返された値の個数です。
  • firstResultPosition:最初のデータが何個目に当たるかです。

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/UnitsWord 関連検索ワードです。(最大5件)
/ResultSet/Result/Item 商品(オークション)の情報を含みます。
/ResultSet/Result/Item/AuctionID 商品(オークション)のIDです。
/ResultSet/Result/Item/Title 商品(オークション)のタイトルです。
/ResultSet/Result/Item/Seller 出品者に関する情報です。
/ResultSet/Result/Item/Seller/Id 出品者のYahoo! JAPAN IDです。
/ResultSet/Result/Item/Seller/ItemListUrl この出品者の出品リストを取得するリクエストURLです。(appidは含まれていませんのでご注意ください)
/ResultSet/Result/Item/Seller/RatingUrl この出品者の評価リストを取得するリクエストURLです。(appidは含まれていませんのでご注意ください)
/ResultSet/Result/Item/ItemUrl 商品詳細APIのURLです。
/ResultSet/Result/Item/AuctionItemUrl 商品(オークション)のURLです。
/ResultSet/Result/Item/Image 画像(サムネイル)のURLです。以下の属性を持ちます。

  • width:サムネイルの横幅です。
  • height:サムネイルの縦幅です。

/ResultSet/Result/Item/CurrentPrice 現在価格です。¥記号やカンマは含みません。小数点第二位までの精度です。
/ResultSet/Result/Item/Bids 現在の入札数です。
/ResultSet/Result/Item/EndTime 終了予定日時です。RFC3339に準拠した表現を用います。
(例:2004-04-01T12:00:00+09:00)
/ResultSet/Result/Item/BidOrBuy 即決価格です。(設定されていない場合は要素なし)
/ResultSet/Result/Item/IsReserved 最低落札価格の有無です。(あり:true なし:false
/ResultSet/Result/Item/CharityOption チャリティオプションの設定です。
/ResultSet/Result/Item/CharityOption/Proportion チャリティオプション寄付率です。未設定の場合は0
/ResultSet/Result/Item/Affiliate アフィリエイトの設定です。
/ResultSet/Result/Item/Affiliate/Rate アフィリエイト料率です。
/ResultSet/Result/Item/Option 商品(オークション)に設定されているオプション情報です。
/ResultSet/Result/Item/Option/NewIcon 「new」アイコンのURLです。
/ResultSet/Result/Item/Option/StoreIcon 「ストア」アイコンのURLです。
/ResultSet/Result/Item/Option/CheckIcon 「鑑定済み」アイコンのURLです。
/ResultSet/Result/Item/Option/PublicIcon 「官公庁オークション」アイコンのURLです。
/ResultSet/Result/Item/Option/FeaturedIcon 「注目のオークション」アイコンのURLです。
/ResultSet/Result/Item/Option/FreeshippingIcon 「送料無料」アイコンのURLです。
/ResultSet/Result/Item/Option/NewItemIcon 「新品」アイコンのURLです。
/ResultSet/Result/Item/Option/WrappingIcon 「贈答品」アイコンのURLです。
/ResultSet/Result/Item/Option/BuynowIcon 「即決価格」アイコンのURLです。
/ResultSet/Result/Item/Option/EasyPaymentIcon 「Yahoo!かんたん決済」アイコンのURLです。
/ResultSet/Result/Item/Option/GiftIcon 「目立ち」アイコンのURLです。
/ResultSet/Result/Item/Option/PointIcon 「Tポイント」アイコンのURLです。
/ResultSet/Result/Item/Option/CharityOptionIcon 「チャリティオプション」アイコンのURLです。(10%用と100%用あり)
/ResultSet/Result/Item/Option/IsBold 太字設定の有無です。(あり:true なし:false
/ResultSet/Result/Item/Option/IsBackGroundColor 背景色設定の有無です。 (あり:true なし:false
/ResultSet/Result/Item/Option/IsOffer 値下げ交渉設定の有無です。 (あり:true なし:false
/ResultSet/Result/Item/Option/IsCharity 「チャリティオプション」設定の有無です。 (あり:true なし:false



サンプルレスポンス

<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="2" totalResultsReturned="2" firstResultPosition="1">
  <Result>
    <Item>
      <AuctionID>a123456789</AuctionID>
      <Title>Gmade F350・ハイラックス用 アルミアクスルハウジング</Title>
      <Seller>
        <Id>hooobaa</Id>
        <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=hooobaa </ItemListUrl>
        <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=hooobaa </RatingUrl>
      </Seller>
      <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a123456789 </ItemUrl>
      <AuctionItemUrl>http://page16.auctions.yahoo.co.jp/jp/auction/a123456789 </AuctionItemUrl>
      <Image width="134" height="100">http://auctions.c.yimg.jp/img265.auctions.yahoo.co.jp/users/8/4/4/8/hooobaa-thumb-1357470912198376.jpg </Image>
      <CurrentPrice>25000.00</CurrentPrice>
      <Bids>0</Bids>
      <EndTime>2013-03-03T21:46:42+09:00</EndTime>
      <BidOrBuy>28000.00</BidOrBuy>
      <IsReserved>false</IsReserved>
      <CharityOption>
        <Proportion>0</Proportion>
      </CharityOption>
      <Option>
        <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>
        <IsOffer>false</IsOffer>
        <IsCharity>false</IsCharity>
      </Option>
      <IsAdult>false</IsAdult>
    </Item>
    <Item>
      <AuctionID>b123456789</AuctionID>
      <Title>2T●RJC アロハシャツ上下 ハワイ●GMADE IN HAWAII/</Title>
      <Seller>
        <Id>bigman</Id>
        <ItemListUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=bigman </ItemListUrl>
        <RatingUrl>http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=bigman </RatingUrl>
      </Seller>
      <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=b123456789 </ItemUrl>
      <AuctionItemUrl>http://page.auctions.yahoo.co.jp/jp/auction/b123456789 </AuctionItemUrl>
      <Image width="132" height="100">http://auctions.c.yimg.jp/img355.auctions.yahoo.co.jp/users/3/2/1/9/bigman-thumb-1306124523236586.jpg </Image>
      <CurrentPrice>1980.00</CurrentPrice>
      <Bids>0</Bids>
      <EndTime>2013-03-05T23:23:00+09:00</EndTime>
      <IsReserved>false</IsReserved>
      <CharityOption>
        <Proportion>0</Proportion>
      </CharityOption>
      <Option>
        <NewIcon>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif </NewIcon>
        <EasyPaymentIcon>http://i.yimg.jp/images/pay/icon_s16.gif</EasyPaymentIcon>
        <IsBold>false</IsBold>
        <IsBackGroundColor>false</IsBackGroundColor>
        <IsOffer>false</IsOffer>
        <IsCharity>false</IsCharity>
      </Option>
      <IsAdult>false</IsAdult>
    </Item>
  </Result>
</ResultSet>

サンプルレスポンス(PHPserialize)

a: 1: {
  s: 9: "ResultSet";
  a: 4: {
    s: 21: "totalResultsAvailable";
    s: 1: "2";
    s: 20: "totalResultsReturned";
    s: 1: "2";
    s: 19: "firstResultPosition";
    s: 1: "1";
    s: 6: "Result";
    a: 1: {
      s: 4: "Item";
      a: 2: {
        i: 0;
        a: 16: {
          s: 9: "AuctionID";
          s: 9: "a123456789";
          s: 5: "Title";
          s: 75: "Gmade F350・ハイラックス用 アルミアクスルハウジング";
          s: 6: "Seller";
          a: 3: {
            s: 2: "Id";
            s: 11: "*****";
            s: 11: "ItemListUrl";
            s: 82: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=*****";
            s: 9: "RatingUrl";
            s: 75: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=*****";
          }
          s: 7: "ItemUrl";
          s: 81: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a123456789";
          s: 14: "AuctionItemUrl";
          s: 55: "http://page16.auctions.yahoo.co.jp/jp/auction/a123456789";
          s: 5: "Image";
          s: 106: "http://auctions.c.yimg.jp/img265.auctions.yahoo.co.jp/users/8/4/4/8/*****-thumb-1357470912198376.jpg";
          s: 10: "ImageWidth";
          s: 3: "134";
          s: 11: "ImageHeight";
          s: 3: "100";
          s: 12: "CurrentPrice";
          s: 8: "25000.00";
          s: 4: "Bids";
          s: 1: "0";
          s: 7: "EndTime";
          s: 25: "2013-03-03T21:46:42+09:00";
          s: 8: "BidOrBuy";
          s: 8: "28000.00";
          s: 10: "IsReserved";
          b: 0;
          s: 13: "CharityOption";
          a: 1: {
            s: 10: "Proportion";
            s: 1: "0";
          }
          s: 6: "Option";
          a: 6: {
            s: 10: "BuynowIcon";
            s: 51: "http://image.auctions.yahoo.co.jp/images/buynow.gif";
            s: 15: "EasyPaymentIcon";
            s: 40: "http://i.yimg.jp/images/pay/icon_s16.gif";
            s: 6: "IsBold";
            b: 0;
            s: 17: "IsBackGroundColor";
            b: 0;
            s: 7: "IsOffer";
            b: 0;
            s: 9: "IsCharity";
            b: 0;
          }
          s: 7: "IsAdult";
          b: 0;
        }
        i: 1;
        a: 15: {
          s: 9: "AuctionID";
          s: 9: "b123456789";
          s: 5: "Title";
          s: 64: "2T●RJC アロハシャツ上下 ハワイ●GMADE IN HAWAII/";
          s: 6: "Seller";
          a: 3: {
            s: 2: "Id";
            s: 8: "******";
            s: 11: "ItemListUrl";
            s: 79: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=******";
            s: 9: "RatingUrl";
            s: 72: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=******";
          }
          s: 7: "ItemUrl";
          s: 81: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=b123456789";
          s: 14: "AuctionItemUrl";
          s: 53: "http://page.auctions.yahoo.co.jp/jp/auction/b123456789";
          s: 5: "Image";
          s: 103: "http://auctions.c.yimg.jp/img355.auctions.yahoo.co.jp/users/3/2/1/9/******-thumb-1306124523236586.jpg";
          s: 10: "ImageWidth";
          s: 3: "132";
          s: 11: "ImageHeight";
          s: 3: "100";
          s: 12: "CurrentPrice";
          s: 7: "1980.00";
          s: 4: "Bids";
          s: 1: "0";
          s: 7: "EndTime";
          s: 25: "2013-03-05T23:23:00+09:00";
          s: 10: "IsReserved";
          b: 0;
          s: 13: "CharityOption";
          a: 1: {
            s: 10: "Proportion";
            s: 1: "0";
          }
          s: 6: "Option";
          a: 6: {
            s: 7: "NewIcon";
            s: 53: "http://image.auctions.yahoo.co.jp/i/auctions/new3.gif";
            s: 15: "EasyPaymentIcon";
            s: 40: "http://i.yimg.jp/images/pay/icon_s16.gif";
            s: 6: "IsBold";
            b: 0;
            s: 17: "IsBackGroundColor";
            b: 0;
            s: 7: "IsOffer";
            b: 0;
            s: 9: "IsCharity";
            b: 0;
          }
          s: 7: "IsAdult";
          b: 0;
        }
      }
    }
  }
}

サンプルレスポンス(JSONP)

loaded({
  ResultSet: {@attributes: {
      totalResultsAvailable: "2",
      totalResultsReturned: "2",
      firstResultPosition: "1"
    },
    Result: {
      Item: [{
        AuctionID: "a123456789",
        Title: "Gmade F350・ハイラックス用 アルミアクスルハウジング",
        Seller: {
          Id: "auctionsloveand",
          ItemListUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=auctionsloveand",
          RatingUrl: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=auctionsloveand"
        },
        ItemUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=a123456789",
        AuctionItemUrl: "http://page16.auctions.yahoo.co.jp/jp/auction/a123456789",
        Image: "http://auctions.c.yimg.jp/img265.auctions.yahoo.co.jp/users/8/4/4/8/auctionsloveand-thumb-1357470912198376.jpg",
        CurrentPrice: "25000.00",
        Bids: "0",
        EndTime: "2013-03-03T21:46:42+09:00",
        BidOrBuy: "28000.00",
        IsReserved: "false",
        CharityOption: {
          Proportion: "0"
        },
        Option: {
          BuynowIcon: "http://image.auctions.yahoo.co.jp/images/buynow.gif",
          EasyPaymentIcon: "http://i.yimg.jp/images/pay/icon_s16.gif",
          IsBold: "false",
          IsBackGroundColor: "false",
          IsOffer: "false",
          IsCharity: "false"
        },
        IsAdult: "false"
      }, {
        AuctionID: "b1213456789",
        Title: "2T●RJC アロハシャツ上下 ハワイ●GMADE IN HAWAII/",
        Seller: {
          Id: "bigauctionstar",
          ItemListUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/sellingList?sellerID=bigauctionstar",
          RatingUrl: "http://auctions.yahooapis.jp/AuctionWebService/V1/ShowRating?id=bigauctionstar"
        },
        ItemUrl: "http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=b1213456789",
        AuctionItemUrl: "http://page.auctions.yahoo.co.jp/jp/auction/b1213456789",
        Image: "http://auctions.c.yimg.jp/img355.auctions.yahoo.co.jp/users/3/2/1/9/bigauctionstar-thumb-1306124523236586.jpg",
        CurrentPrice: "1980.00",
        Bids: "0",
        EndTime: "2013-03-05T23:23:00+09:00",
        IsReserved: "false",
        CharityOption: {
          Proportion: "0"
        },
        Option: {
          NewIcon: "http://image.auctions.yahoo.co.jp/i/auctions/new3.gif",
          EasyPaymentIcon: "http://i.yimg.jp/images/pay/icon_s16.gif",
          IsBold: "false",
          IsBackGroundColor: "false",
          IsOffer: "false",
          IsCharity: "false"
        },
        IsAdult: "false"
      }]
    }
  }
})



エラー

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