AuctionWidgets.COM API - Developer Informations

AuctionWidgets eBay API developer informations

Accessing and parsing our API is easy and straight forward in nearly every programming language. This page gives you a quick overview on what to parse and how to.

Understanding the API request URL

Example: //api.auctionwidgets.com/ebay-store-listing/json/Schatzkammer-Flintbek-Grevenkrug/grey/de-DE/de

//

The // at the start of the URL makes it usable with both HTTP and HTTPS connections.

api.auctionwidgets.com

The server adress. It always stays the same

ebay-store-listing

The first URL parameter select the type of data being requested. Currently there's only "ebay-store-listing" and "ebay-user-profile" available.

json

This parameter selects the output format. Allowed values are: "html", "json" and "js".

Schatzkammer-Flintbek-Grevenkrug

The next parameter is the ID of the store or user for which/whom the data is being requested. Use the same parameter as on the eBay-URL and it will work.

grey

The color scheme. This parameter only affects the html and js output and not the json one.

de-DE

The language in which the widget will be displayed

de

Requests a certain ebay site, in this ebay.de. Use your local ebay.

Example: A JSON results for an eBay store.


{  
   "storeUrl":"http:\/\/rover.ebay.com\/rover\/1\/711-53200-19255-0\/1?campid=5337592115&customid=&toolid=10020&mpre=http%3A%2F%2Fstores.ebay.com%2Fschatzkammerflintbek",
   "displayName":"Schatzkammer Flintbek",
   "lastUpdate":"1507216315",
   "aboutMeUrl":"http:\/\/rover.ebay.com\/rover\/1\/711-53200-19255-0\/1?campid=5337592115&customid=&toolid=10020&mpre=http%3A%2F%2Fmembers.ebay.com%2Fws%2FeBayISAPI.dll%3FViewUserPage%26userid%3Dtroedelflintbek2020",
   "feedbackUrl":"http:\/\/rover.ebay.com\/rover\/1\/711-53200-19255-0\/1?campid=5337592115&customid=&toolid=10020&mpre=http%3A%2F%2Ffeedback.ebay.com%2Fws%2FeBayISAPI.dll%3FViewFeedback%26userid%3Dtroedelflintbek2020%26ssPageName%3DSTRK%3AME%3AUFS",
   "profile":{  
      "positiveReviewsInPercent":100,
      "ratingStars":0,
      "ratingStarColor":"Purple",
      "feedbackScore":676,
      "ratingStarImageUrl":"http:\/\/pics.ebaystatic.com\/aw\/pics\/stars-8.gif"
   },
   "averages":{  
      "itemAsDescribed":{  
         "rating":4.97,
         "count":31
      },
      "communication":{  
         "rating":4.97,
         "count":30
      },
      "shippingTime":{  
         "rating":4.94,
         "count":31
      },
      "charges":{  
         "rating":4.94,
         "count":33
      }
   },
   "feedbackHistory":{  
      "periods":[  
         0,
         7,
         30,
         180,
         365
      ],
      "positiveFeedbacks":{  
         "periods":[  
            0,
            7,
            30,
            180,
            365
         ],
         "counts":[  
            733,
            0,
            0,
            4,
            49
         ]
      },
      "neutralFeedbacks":{  
         "periods":[  
            0,
            7,
            30,
            180,
            365
         ],
         "counts":[  
            1,
            0,
            0,
            0,
            0
         ]
      },
      "negativeFeedbacks":{  
         "periods":[  
            0,
            7,
            30,
            180,
            365
         ],
         "counts":[  
            2,
            0,
            0,
            0,
            0
         ]
      }
   },
   "listing":[  
      {  
         "photo":"http:\/\/thumbs4.ebaystatic.com\/m\/mQbYu_whAR0b6aD3OjD90dg\/140.jpg",
         "product":"Vintage 50 iger Jahre Schale Konfektschale Olivenschale Keramik gelb rosa oval",
         "price":"\u20ac9,00",
         "timeLeft":{  
            "d":3,
            "h":1,
            "m":51,
            "s":11
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182796873267",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182796873267",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs3.ebaystatic.com\/m\/mnzbEmm2cged15toi6h4jbA\/140.jpg",
         "product":"Rosenthal Studio Line Romanze blau Relief B. Wiinblad Kuchenteller rund 28 cm ",
         "price":"\u20ac19,00",
         "timeLeft":{  
            "d":20,
            "h":20,
            "m":26,
            "s":57
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172427285186",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172427285186",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs4.ebaystatic.com\/m\/m3DKZDRhojh7y_8dgAwsjsw\/140.jpg",
         "product":"Melitta Kaffeefilter 102 H Porzellan dunkelblau mit Henkel Stiel 2 Loch Filter",
         "price":"\u20ac25,00",
         "timeLeft":{  
            "d":3,
            "h":2,
            "m":10,
            "s":23
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182796881183",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182796881183",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs1.ebaystatic.com\/m\/mAfuuDIebHKVug9rHbnzvjg\/140.jpg",
         "product":"Rosenthal Studio Line Romanze blau Relief B. Wiinblad 100. Jubil\u00e4umsjahr Teller",
         "price":"\u20ac19,00",
         "timeLeft":{  
            "d":20,
            "h":20,
            "m":42,
            "s":24
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172427297768",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172427297768",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs4.ebaystatic.com\/m\/mX4oq04xbYG9CsYWqIfglBg\/140.jpg",
         "product":"Venezianische Theatermaske m\u00e4nnlich lange Nase handgefertigt Gips edel Patina",
         "price":"\u20ac69,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227147",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227147",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs4.ebaystatic.com\/m\/mzI3xIpxvV_p6kWxFifAiDQ\/140.jpg",
         "product":"Holzschild Vintage Shabby Grandmas Kitchen open 24 hour Wood Board 100 cm ",
         "price":"\u20ac49,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988091",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988091",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs1.ebaystatic.com\/m\/mMKxRHomzE7iAItxnE5CZug\/140.jpg",
         "product":"Venezianische Theatermaske Harlekin handgefertigt Gips edel Patina",
         "price":"\u20ac79,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988096",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988096",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs2.ebaystatic.com\/m\/mSH0DLlIGkvVALt39I2kOHw\/140.jpg",
         "product":"Holzschild Vintage Shabby Free Beer tomorrow Woman Wood Board",
         "price":"\u20ac40,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227141",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227141",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs2.ebaystatic.com\/m\/mQU50Nf53uB0mtBitYECYhw\/140.jpg",
         "product":"Villeroy und Boch Amapola Porzellan Kaffeegedeck 3teilig Vitro Mohnblume Mohn ",
         "price":"\u20ac29,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227149",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227149",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs3.ebaystatic.com\/m\/mog5HwrnOBAuFgZqz22NFAQ\/140.jpg",
         "product":"Villeroy und Boch Amapola Porzellan Mohnblume Mohn Geb\u00e4ckschale oval ",
         "price":"\u20ac19,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227142",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227142",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs2.ebaystatic.com\/m\/mSJfJbLT_GR42Q8TTB6VtFw\/140.jpg",
         "product":"Holzschild Vintage Shabby Blue Crab Fresh Daily Wood Board",
         "price":"\u20ac30,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988089",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988089",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs4.ebaystatic.com\/m\/mGyJ5xheERhrY7kJTMMNuwQ\/140.jpg",
         "product":"Rosenthal Studio Line Romanze blau Relief B. Wiinblad Kaffeekanne ca. 1,3 Liter ",
         "price":"\u20ac25,00",
         "timeLeft":{  
            "d":20,
            "h":20,
            "m":31,
            "s":51
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182371832515",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182371832515",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs2.ebaystatic.com\/m\/mJdTGFImGfLVYs32NSpSUAQ\/140.jpg",
         "product":"Venezianische Theatermaske Gladiator Krieger handgefertigt Gips edel Patina",
         "price":"\u20ac59,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":3
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988093",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=172876988093",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs4.ebaystatic.com\/m\/mQOD5PjJNShcgT7g4dGVY1g\/140.jpg",
         "product":"Rosenthal Romanze blau Relief Bj\u00f6rn Wiinblad Kaffeegedeck 3 teilig ",
         "price":"\u20ac25,00",
         "timeLeft":{  
            "d":20,
            "h":20,
            "m":18,
            "s":48
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182371824331",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182371824331",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs1.ebaystatic.com\/m\/mbKseztRsGSTRkMKaEtL1pw\/140.jpg",
         "product":"Alfred Voigt Sitzendorf Porzellan Pokal Prunkgef\u00e4\u00df Sockel Putte Putten Engel ",
         "price":"\u20ac199,00",
         "timeLeft":{  
            "d":3,
            "h":1,
            "m":52,
            "s":58
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182796866560",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182796866560",
         "internalTimestamp":""
      },
      {  
         "photo":"http:\/\/thumbs2.ebaystatic.com\/m\/mnoOeIkI-G6BEBcYZQEqFfA\/140.jpg",
         "product":"Holzschild Vintage Shabby Cherry Cup Cake Wood Board",
         "price":"\u20ac30,00",
         "timeLeft":{  
            "d":15,
            "h":20,
            "m":10,
            "s":4
         },
         "url":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227153",
         "instantBuy":"http:\/\/rover.ebay.com\/rover\/1\/707-53477-19255-0\/1?ff3=2&toolid=10044&campid=5337592115&customid=&lgeo=1&vectorid=229487&item=182780227153",
         "internalTimestamp":""
      }
   ],
   "feedback":[  
      {  
         "user":"p***e",
         "userScore":566,
         "text":"Super Verk\u00e4ufer!sehr zuverl\u00e4ssig und wirklich hilfsbereit! Sehr zu empfehlen!",
         "time":"2017-06-27T18:12:55.000Z",
         "type":"Positive",
         "itemTitle":"n\/a",
         "itemPrice":"n\/a",
         "itemId":"1102219849026",
         "userRole":"Seller"
      },
      {  
         "user":"p***e",
         "userScore":566,
         "text":"Alles super gelaufen vielen dank !!!",
         "time":"2017-06-27T18:11:16.000Z",
         "type":"Positive",
         "itemTitle":"Villeroy und Boch Amapola, Porzellan Mohnblume Mohn Marmeladentopf",
         "itemPrice":{  
            "Value":18.81,
            "CurrencyID":"USD"
         },
         "itemId":"1102219281026",
         "userRole":"Seller"
      },
      {  
         "user":"p***e",
         "userScore":566,
         "text":"Ein ganz hervorragender Verk\u00e4ufer. Super Ware. Besser geht nicht!!! Vielen Dank",
         "time":"2017-06-27T18:10:03.000Z",
         "type":"Positive",
         "itemTitle":"Villeroy und Boch Amapola Porzellan Kaffeekanne Kanne Vitro Mohnblume Mohn ",
         "itemPrice":{  
            "Value":30.57,
            "CurrencyID":"USD"
         },
         "itemId":"1102218810026",
         "userRole":"Seller"
      },
      {  
         "user":"p***e",
         "userScore":566,
         "text":"netter Kontakt, super Ware, schneller Versand, vielen vielen Dank",
         "time":"2017-06-27T18:09:17.000Z",
         "type":"Positive",
         "itemTitle":"Villeroy und Boch Amapola Porzellan Kaffeegedeck 3teilig Vitro Mohnblume Mohn ",
         "itemPrice":{  
            "Value":35.27,
            "CurrencyID":"USD"
         },
         "itemId":"1102218543026",
         "userRole":"Seller"
      },
      {  
         "user":"h***g",
         "userScore":220,
         "text":"Genau wie erwartet, danke",
         "time":"2017-03-14T18:52:04.000Z",
         "type":"Positive",
         "itemTitle":"n\/a",
         "itemPrice":"n\/a",
         "itemId":"1067079187026",
         "userRole":"Seller"
      }
   ]
}               

As you can see, the JSON reply is an nested array/object structure containing ALL details for the store along with a variable named lastUpdate that provide a sql timestamp containing the time of the last non cached update right from eBay.

Accessing the eBay store listing JSON API using Javascript/jQuery

Here's a JSFiddle that explains how to access the API using jQuery. As you can see it's trivial to parse the output and display a table with the auctions, that there's not much to explain. Still, if you have questions or suggestions, I am all ears!