API
Brädspelspriser.se offers an API to access the price information for single products. At the moment a WordPress plugin is offered, which uses this API. You can get this plugin here. With this plugin, you can display real-time prices on your WordPress blog for board games.
Feel free use the API for your own project, as long as you link back to this site when the information is presented, and be sure to cache obtained information for at least one hour. If you feel something is missing, let us know.
Price information endpoint
URL: https://bradspelspriser.se/api/info
This endpoint will obtain price information for the given items. This contains (almost) all information shown in the product listings. The only thing missing is the actual store behind each offering. For that, you must forward your user to Brädspelspriser.se.
Query parameters
- sitename
- Required. An url to your site.
- id
- Comma-separated list of items to obtain information for, based on IDs for Brädspelspriser.se
- eid
- Comma-separated list of items to obtain information for, based on BoardGameGeek IDs. Might return multiple items for each 'eid'.
- currency
- The currency to use for prices. Supported values are DKK, GBP, SEK, EUR and USD, though any currency should work.
- destination
- The delivery destination for shipping calculations. Supported values are DK, SE, GB, DE and US.
- delivery
- Comma-separated list of delivery methods to allow in the shippping calculations. Valid values are PACKAGE, OFFICE, PICKUPBOX, POSTOFFICE and LETTER. Default is PACKAGE,POSTOFFICE.
- sort
- The sorting to use for the returned prices. Valid values are SMART = default sorting for the site, which favors cheapest offer in stock from a local store, CHEAP1 = sorted by total price, including shipping and fees, CHEAP2 = sorted by product price, STOCK = sorted by offers in stock, then by total price. Default is SMART.
- locale
- The locale to use for texts and currency formatting. Valid values are da, en, sv, fr and de.
- preferred_language
- When returning multiple items, sort those with this language version at the start. Valid values are GB, SE, DK, etc. (yes, those are countries, but should be languages.)
At least one of id or eid must be provided. Multiple of each can be provided.
Output
The following is returned from the endpoint.
- currency
- The currency used for all amounts.
- logo
- URL for the site's logo, localized to the requested domain. Should be used when presenting the data.
- sitename
- The name of the site, localized to the requested domain. Should be used when presenting the data.
- url
- The URL of the site, localized to the requested domain. Should be used for backlinks.
- items
- A list of all items found, which matches the given ids and eids. Each item contains the following fields:
- id
- The id of the item.
- external_id
- The BoardGameGeek id of the item, if known.
- name
- The name of the item.
- image
- URL of the item image, if available.
- thumbnail
- URL of a thumbnail image, if available.
- url
- Direct URL to the price list of the item. Should be used when linking to the item.
- versions
- A list of key/value pairs for the specific version of the item. Possible key values includes 'lang' and 'version'.
- prices
- A list of all known offers for the item, sorted as requested by the input parameter 'sort'. Each element contains the following fields:
- price
- The total price for the offer, including shipping and fees.
- product
- The price for the product itself.
- shipping
- Shipping rate for the product. '0' indicates free shipping.
- shipping_known
- Boolean indicating if the shipping is known. If 'false', the shipping rate is '0', but should not be used.
- fee
- The amount of fees applied to the product. This can be payment fees, or taxes.
- stock
- The stock of this offer, if known. Valid values are Y = in stock, N = not in stock, P = pre-order, ? or blank = unknown.
- country
- The country of the store behind the offer.
- link
- A link to show the offer in the store. Please use this for your users, so they are going by our site before continuing.
Examples
GET https://Brädspelspriser.se/api/info?id=12,844,2096,13857¤cy=DKK&destination=DK&delivery=PACKAGE,POSTOFFICE&sort=SMART&sitename=boardgameprices.co.uk
Get all offers for items 12, 844, 2096 and 13857 with shipping calculation targetting Denmark, allowing for delivery with pick-up at postoffices.
Search for products
URL: https://bradspelspriser.se/api/search
Searches for items matching a specific string.
Query parameters
- sitename
- Required. An url to your site.
- currency
- The currency to use for prices. Supported values are DKK, GBP, SEK, EUR and USD, though any currency should work.
- destination
- The delivery destination for shipping calculations. Supported values are DK, SE, GB, DE and US.
- delivery
- Comma-separated list of delivery methods to allow in the shippping calculations. Valid values are PACKAGE, OFFICE, PICKUPBOX, POSTOFFICE and LETTER. Default is PACKAGE,POSTOFFICE.
- stock
- Set to 'Y' if only offers in stock should be returned.
- search
- The term(s) to search for.
- tags
- Comma-separated list of tags-ids to limit the search to.
- page
- The page number to return in results, if multiple pages of results are founds.