BGG Wiki - Revision History - BGG XML API

BGG XML API: - No Comment

2009-03-17T22:54:40-05:00

From zefquaavius 2009-03-17 22:53:43		To zefquaavius 2009-03-17 22:54:40

	=== Search for games by name and by AKAs ===		=== Search for games by name and by AKAs ===

-	'''/xmlapi/search'''	+	/xmlapi/'''search'''

	* Parameters:		* Parameters:

BGG XML API: - No Comment

2009-03-17T22:53:43-05:00

From zefquaavius 2009-03-17 12:38:11		To zefquaavius 2009-03-17 22:53:43

	== Games Data XML Snapshot ==		== Games Data XML Snapshot ==

-	[[BGG_XML_Snapshot]]	+	[[BGG XML Snapshot]]

BGG XML API: - geeklist example

2009-03-17T12:38:11-05:00

From zefquaavius 2009-03-17 12:36:43		To zefquaavius 2009-03-17 12:38:11

	/xmlapi/'''geeklist'''/''<listid>''		/xmlapi/'''geeklist'''/''<listid>''

-	Parameters	+	* ''Example:'' http://www.boardgamegeek.com/xmlapi/geeklist/11205
	* '''start''': Item to start with (0 indexed) (default = 0)		* '''start''': Item to start with (0 indexed) (default = 0)
	* '''count''': Number of items to retrieve (default and max = 150)		* '''count''': Number of items to retrieve (default and max = 150)

BGG XML API: - thread example

2009-03-17T12:36:43-05:00

From zefquaavius 2009-03-17 12:33:10		To zefquaavius 2009-03-17 12:36:43

	/xmlapi/'''thread'''/''<threadid>''		/xmlapi/'''thread'''/''<threadid>''

		+	* ''Example:'' http://www.boardgamegeek.com/xmlapi/thread/381021 [''Note:'' Your browser may interpret this as a request to subscribe to an RSS feed.]
	* '''start''': Start article (default = 0)		* '''start''': Start article (default = 0)
	* '''count''': Number of articles (default and max = 100)		* '''count''': Number of articles (default and max = 100)

BGG XML API: - plays filter

2009-03-17T12:33:10-05:00

From zefquaavius 2009-03-17 12:30:21		To zefquaavius 2009-03-17 12:33:10

	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?maxbggrating=2 - games in zefquaavius' collection with an average BGG rating no more than 2 [''Note:'' May be broken in BGG 2.0, or may require other parameters.]		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?maxbggrating=2 - games in zefquaavius' collection with an average BGG rating no more than 2 [''Note:'' May be broken in BGG 2.0, or may require other parameters.]
	** '''minplays''': minumum and maximum number of recorded plays		** '''minplays''': minumum and maximum number of recorded plays
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''minplays'''=''<number>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minplays=50 - games zefquaavius has played 50 or more times
	** '''maxplays'''		** '''maxplays'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''maxplays'''=''<number>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minplays=50&maxplays=99 - games zefquaavius has played more than 49 times, but fewer than 100 times
	* Other parameters:		* Other parameters:
	** '''showprivate''': Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own collection, when you are logged in.		** '''showprivate''': Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own collection, when you are logged in.

BGG XML API: - bunch of parameter stuff

2009-03-17T12:30:21-05:00

From zefquaavius 2009-03-17 12:05:47		To zefquaavius 2009-03-17 12:30:21


	* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider		* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider
-	* Filters:	+	* Filters: (You can use any combination of the below)
	** '''own''': In (or exclude for 0) a user's collection. That is, the user currently owns it. Collections include games that		** '''own''': In (or exclude for 0) a user's collection. That is, the user currently owns it. Collections include games that
	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''own'''=''<0,1>''		*** ''Syntax:'' /xmlapi/collection/''<username>''?'''own'''=''<0,1>''

	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?played=1 - games for which zefquaavius has logged plays		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?played=1 - games for which zefquaavius has logged plays
	** '''comment''': include (or exclude) games with comments		** '''comment''': include (or exclude) games with comments
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''comment'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=0 - games in zefquaavius' collection upon which he currently has comments
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=1 - games upon which zefquaavius has comments
	** '''trade''': games listed for trade		** '''trade''': games listed for trade
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''trade'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?trade=0 - games in zefquaavius' collection he is not offering for trade
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?trade=1 - games zefquaavius is offering for trade
	** '''want'''		** '''want'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''want'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=0 - games in zefquaavius' collection for which he is not trying to trade anything (i.e. He's not looking to trade for your copy of it.)
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=1 - games for which zefquaavius is willing to make a trade
	** '''wishlist'''		** '''wishlist'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wishlist'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wishlist=0 - games in zefquaavius' collection that are not on his wishlist
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wishlist=1 - games in zefquaavius' wishlist
	** '''wanttoplay'''		** '''wanttoplay'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wanttoplay'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttoplay=0 - games in zefquaavius' collection which he has no pressing desire to play
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttoplay=1 - games zefquaavius currently wants to play
	** '''wanttobuy'''		** '''wanttobuy'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wanttobuy'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttobuy=0 - games in zefquaavius' collection he doesn't wish to buy
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttobuy=1 - games zefquaavius wishes to buy
	** '''prevowned'''		** '''prevowned'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''prevowned'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?prevowned=1 - games zefquaavius previously owned
	** '''preordered'''		** '''preordered'''
-	** '''wishlist'''	+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''preordered'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?preordered=1 - games zefquaavius has pre-ordered
	** '''hasparts'''		** '''hasparts'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''hasparts'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?hasparts=1 - zefquaavius has spare parts of these games up for offer
	** '''wantparts'''		** '''wantparts'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wantparts'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wantparts=1 - zefquaavius is looking for spare parts for these games
	** '''notifycontent'''		** '''notifycontent'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''notifycontent'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?notifycontent=1 - zefquaavius gets a geekmail whenever these games receive new content on BGG
	** '''notifysale'''		** '''notifysale'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''notifysale'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?notifysale=1 - zefquaavius gets a geekmail whenever a copy of these games are listed in [[BGGM]]
	** '''notifyauction'''		** '''notifyauction'''
-	** '''showprivate''': Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own c ollection, when you are logged in.	+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''notifyauction'''=''<0,1>''
-	* You may also set the following parameters with numerical values. They should be largely self-explanatory:	+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?notifyauction=1 - zefquaavius gets a geekmail whenever a copy is listed in a [[geekgold]] or eBay auction that's listed on BGG
	** '''wishlistpriority''': (a number from 1 to 5)		** '''wishlistpriority''': (a number from 1 to 5)
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wishlistpriority'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wishlistpriority=4 - games zefquaavius has given a wishlist priority of 4 ("Thinking about it")
	** '''minrating''': minimum and maximum user rating		** '''minrating''': minimum and maximum user rating
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''minrating'''=''<1-10>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minrating=9 - games zefquaavius has given a rating of at least 9
	** '''maxrating'''		** '''maxrating'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''maxrating'''=''<1-10>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?maxrating=2 - games zefquaavius has given a rating of no more than 2 [''Note:'' May be broken in BGG 2.0, or may require other parameters.]
	** '''minbggrating''': minimum and maximum bgg rating		** '''minbggrating''': minimum and maximum bgg rating
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''minbggrating'''=''<1-10>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minbggrating=8 - games in zefquaavius' collection with an average BGG rating of at least 8
	** '''maxbggrating'''		** '''maxbggrating'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''maxbggrating'''=''<1-10>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?maxbggrating=2 - games in zefquaavius' collection with an average BGG rating no more than 2 [''Note:'' May be broken in BGG 2.0, or may require other parameters.]
	** '''minplays''': minumum and maximum number of recorded plays		** '''minplays''': minumum and maximum number of recorded plays
	** '''maxplays'''		** '''maxplays'''
		+	* Other parameters:
		+	** '''showprivate''': Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own collection, when you are logged in.
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''showprivate'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?showprivate=1 - include private info zefquaavius has listed, provided you're zefquaavius
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?showprivate=0 - If you're zefquaavius, see what everyone else sees when viewing your collection: No private info

	=== Retrieve the messages from a forum/game thread ===		=== Retrieve the messages from a forum/game thread ===

BGG XML API: - played filter

2009-03-17T12:05:47-05:00

From zefquaavius 2009-03-17 12:03:42		To zefquaavius 2009-03-17 12:05:47


	/xmlapi/'''collection'''/''<username>''		/xmlapi/'''collection'''/''<username>''
-	Retrieve games in a user's collection. '''Important definition:''' A user's ''collection'' includes any games the user has added to her collection on BGG. This includes games she owns, games she used to own, games she's rated, games upon which she's commented, and games on her wishlist, just to name a few. In this section, references to the ''collection'' mean this broader sense of BGG collection, not the user's personal stash of games.	+	Retrieve games in a user's collection. '''Important definition:''' A user's ''collection'' includes any games the user has added to her collection on BGG. This includes games she owns, games she used to own, games she's rated, games upon which she's commented, games she's played, and games on her wishlist, just to name a few. In this section, references to the ''collection'' mean this broader sense of BGG collection, not the user's personal stash of games.

	* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider		* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider

	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?rated=1 - games zefquaavius has rated		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?rated=1 - games zefquaavius has rated
	** '''played'''		** '''played'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''played'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?played=0 - games in zefquaavius' collection for which he has never logged any plays
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?played=1 - games for which zefquaavius has logged plays
	** '''comment''': include (or exclude) games with comments		** '''comment''': include (or exclude) games with comments
	** '''trade''': games listed for trade		** '''trade''': games listed for trade

BGG XML API: - rated filter

2009-03-17T12:03:42-05:00

From zefquaavius 2009-03-17 11:58:44		To zefquaavius 2009-03-17 12:03:42


	/xmlapi/'''collection'''/''<username>''		/xmlapi/'''collection'''/''<username>''
-	Retrieve games in a user's collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.	+	Retrieve games in a user's collection. '''Important definition:''' A user's ''collection'' includes any games the user has added to her collection on BGG. This includes games she owns, games she used to own, games she's rated, games upon which she's commented, and games on her wishlist, just to name a few. In this section, references to the ''collection'' mean this broader sense of BGG collection, not the user's personal stash of games.

	* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider		* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider

	** '''own''': In (or exclude for 0) a user's collection. That is, the user currently owns it. Collections include games that		** '''own''': In (or exclude for 0) a user's collection. That is, the user currently owns it. Collections include games that
	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''own'''=''<0,1>''		*** ''Syntax:'' /xmlapi/collection/''<username>''?'''own'''=''<0,1>''
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=0 - games zefquaavius doesn't own, but perhaps has rated, put on a wishlist, previously owned, or otherwise stuck in the collection	+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=0 - games in zefquaavius' collection that he doesn't own
	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=1 - games zefquaavius owns		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=1 - games zefquaavius owns
	** '''rated'''		** '''rated'''
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''rated'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?rated=0 - games in zefquaavius' collection that he has not rated
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?rated=1 - games zefquaavius has rated
	** '''played'''		** '''played'''
	** '''comment''': include (or exclude) games with comments		** '''comment''': include (or exclude) games with comments

BGG XML API: - collection own filter example

2009-03-17T11:58:44-05:00

From zefquaavius 2009-03-17 11:53:22		To zefquaavius 2009-03-17 11:58:44


	* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider		* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider
-	* Parameters:	+	* Filters:
-	** '''own''': In (or exclude for 0) a user's collection.	+	** '''own''': In (or exclude for 0) a user's collection. That is, the user currently owns it. Collections include games that
		+	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''own'''=''<0,1>''
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=0 - games zefquaavius doesn't own, but perhaps has rated, put on a wishlist, previously owned, or otherwise stuck in the collection
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=1 - games zefquaavius owns
	** '''rated'''		** '''rated'''
	** '''played'''		** '''played'''

BGG XML API: - formatting for other commands

2009-03-17T11:53:22-05:00

From zefquaavius 2009-03-17 11:50:45		To zefquaavius 2009-03-17 11:53:22

	=== Retrieve the messages from a forum/game thread ===		=== Retrieve the messages from a forum/game thread ===

-	'''/xmlapi/thread/<threadid>'''	+	/xmlapi/'''thread'''/''<threadid>''

-	* start: Start article (default = 0)	+	* '''start''': Start article (default = 0)
-	* count: Number of articles (default and max = 100)	+	* '''count''': Number of articles (default and max = 100)
-	* username: Username to filter for	+	* '''username''': Username to filter for

	=== Retrieve entries from a geeklist ===		=== Retrieve entries from a geeklist ===

-	'''/xmlapi/geeklist/<listid>'''	+	/xmlapi/'''geeklist'''/''<listid>''

	Parameters		Parameters
-	* start: Item to start with (0 indexed) (default = 0)	+	* '''start''': Item to start with (0 indexed) (default = 0)
-	* count: Number of items to retrieve (default and max = 150)	+	* '''count''': Number of items to retrieve (default and max = 150)
-	* comments: Retrieve comments? (default absent, set to 1 if you want comments)	+	* '''comments''': Retrieve comments? (default absent, set to 1 if you want comments)

	== Old Documentation ==		== Old Documentation ==

BGG XML API: - Collection formatting.

2009-03-17T11:50:45-05:00

From zefquaavius 2009-03-17 11:38:51		To zefquaavius 2009-03-17 11:50:45

	=== Retrieve information about a particular game or games ===		=== Retrieve information about a particular game or games ===

-	'''/xmlapi/boardgame/<gameid>'''	+	/xmlapi/'''boardgame'''/''<gameid>''
-	'''/xmlapi/boardgame/<gameid>,<gameid2>...'''	+	/xmlapi/'''boardgame'''/''<gameid>'',''<gameid2>''[...]

	* ''Example, single game:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424		* ''Example, single game:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424

	=== Retrieve games in a user's collection ===		=== Retrieve games in a user's collection ===

-	'''/xmlapi/collection/<username>'''	+	/xmlapi/'''collection'''/''<username>''
	Retrieve games in a user's collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.		Retrieve games in a user's collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.
-	Parameters	+
-	* own: In (or exclude for 0) a user's collection.	+	* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider
-	* rated	+	* Parameters:
-	* played	+	** '''own''': In (or exclude for 0) a user's collection.
-	* comment: include (or exclude) games with comments	+	** '''rated'''
-	* trade: games listed for trade	+	** '''played'''
-	want	+	** '''comment''': include (or exclude) games with comments
-	wishlist	+	** '''trade''': games listed for trade
-	wanttoplay	+	** '''want'''
-	wanttobuy	+	** '''wishlist'''
-	prevowned	+	** '''wanttoplay'''
-	preordered	+	** '''wanttobuy'''
-	wishlist	+	** '''prevowned'''
-	hasparts	+	** '''preordered'''
-	wantparts	+	** '''wishlist'''
-	notifycontent	+	** '''hasparts'''
-	notifysale	+	** '''wantparts'''
-	notifyauction	+	** '''notifycontent'''
-	* showprivate: Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own c ollection, when you are logged in.	+	** '''notifysale'''
-	You may also set the following parameters with numerical values. They should be largely self-explanatory:	+	** '''notifyauction'''
-	* wishlistpriority: (a number from 1 to 5)	+	** '''showprivate''': Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own c ollection, when you are logged in.
-	* minrating: minimum and maximum user rating	+	* You may also set the following parameters with numerical values. They should be largely self-explanatory:
-	maxrating	+	** '''wishlistpriority''': (a number from 1 to 5)
-	* minbggrating: minimum and maximum bgg rating	+	** '''minrating''': minimum and maximum user rating
-	maxbggrating	+	** '''maxrating'''
-	* minplays: minumum and maximum number of recorded plays	+	** '''minbggrating''': minimum and maximum bgg rating
-	maxplays	+	** '''maxbggrating'''
		+	** '''minplays''': minumum and maximum number of recorded plays
		+	** '''maxplays'''

	=== Retrieve the messages from a forum/game thread ===		=== Retrieve the messages from a forum/game thread ===

BGG XML API: - boardgame examples

2009-03-17T11:38:51-05:00

From zefquaavius 2009-03-17 11:29:34		To zefquaavius 2009-03-17 11:38:51


	* Parameters:		* Parameters:
-	** search: String to search for ('''required''')	+	** '''search''': String to search for ('''required''')
-	*** ''Syntax:'' /xmlapi/search?search=''<searchString>''	+	*** ''Syntax:'' /xmlapi/search?'''search'''=''<searchString>''
	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults
-	** exact: Exact name/aka search only (set it to 1, absent by default) ['''exact''' doesn't seem to work yet in BGG 2.0]	+	** '''exact''': Exact name/aka search only (set it to 1, absent by default) ['''exact''' doesn't seem to work yet in BGG 2.0]
-	*** ''Syntax:'' /xmlapi/search?search=''<searchString>''&exact=1	+	*** ''Syntax:'' /xmlapi/search?search=''<searchString>''&'''exact'''=1
	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1


	* ''Example, multiple games:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860		* ''Example, multiple games:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860
	* Parameters:		* Parameters:
-	** comments: Show brief user comments on games (set it to 1, absent by default)	+	** '''comments''': Show users' comments on games (set it to 1, absent by default)
-	** stats: Include game statistics (set it to 1, absent by default)	+	*** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?'''comments'''=1
-	** historical: Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.	+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860?comments=1
-	*** from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )	+	** '''stats''': Include game statistics (set it to 1, absent by default)
-	*** to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )	+	*** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?'''stats'''=1
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/2860?stats=1
		+	** '''historical''': Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.
		+	*** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?'''historical'''=1
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860?historical=1
		+	*** '''from''': Set the start date to include historical data (format: YYYY-MM-DD, absent by default )
		+	*** '''to''': Set the end date to include historical data (format: YYYY-MM-DD, absent by default )
		+	**** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?historical=1&'''from'''=''<date>''&'''to'''=''<date>''
		+	**** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860?historical=1&from=2009-01-01&to=2009-03-17

	=== Retrieve games in a user's collection ===		=== Retrieve games in a user's collection ===

BGG XML API: - introduced TOC

2009-03-17T11:29:34-05:00

From zefquaavius 2009-03-17 11:19:02		To zefquaavius 2009-03-17 11:29:34

-	'''BoardGameGeek XML API'''	+	[[toc]]
-	You can access some information from the geek via this XML API. Each base URI is described and the various parameters are listed. The parameters and their values are url-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described h ere, but XML is "self-describing" right? The output should be quite clear from simple inspection.	+
		+	== Introduction ==
		+
		+	You can access some information from the geek via the '''BoardGameGeek XML API'''. Each base URI is described and the various parameters are listed. The parameters and their values are URL-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described here, but XML is "self-describing" right? The output should be quite clear from simple inspection.
		+
		+	For all of the parameters mentioned below, the first parameter you list follows a '''?''' (question mark), and each subsequent parameter follows an '''&''' (ampersand).
		+
		+	== Commands ==
		+
		+	=== Search for games by name and by AKAs ===
		+
		+	'''/xmlapi/search'''

-	'''/xmlapi/search?search=<searchString>''' ['''&exact=1''']
-	Search for games by name and by AKAs.
	* Parameters:		* Parameters:
	** search: String to search for ('''required''')		** search: String to search for ('''required''')
		+	*** ''Syntax:'' /xmlapi/search?search=''<searchString>''
	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults
	** exact: Exact name/aka search only (set it to 1, absent by default) ['''exact''' doesn't seem to work yet in BGG 2.0]		** exact: Exact name/aka search only (set it to 1, absent by default) ['''exact''' doesn't seem to work yet in BGG 2.0]
		+	*** ''Syntax:'' /xmlapi/search?search=''<searchString>''&exact=1
	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1		*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1
		+
		+	=== Retrieve information about a particular game or games ===

	'''/xmlapi/boardgame/<gameid>'''		'''/xmlapi/boardgame/<gameid>'''
	'''/xmlapi/boardgame/<gameid>,<gameid2>...'''		'''/xmlapi/boardgame/<gameid>,<gameid2>...'''
-	Retrieve information about a particular game or games.	+
	* ''Example, single game:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424		* ''Example, single game:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424
	* ''Example, multiple games:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860		* ''Example, multiple games:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860

	*** from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )		*** from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )
	*** to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )		*** to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )
		+
		+	=== Retrieve games in a user's collection ===

	'''/xmlapi/collection/<username>'''		'''/xmlapi/collection/<username>'''
-	Retrieve games in a users collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.	+	Retrieve games in a user's collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.
	Parameters		Parameters
	* own: In (or exclude for 0) a user's collection.		* own: In (or exclude for 0) a user's collection.

	* minplays: minumum and maximum number of recorded plays		* minplays: minumum and maximum number of recorded plays
	maxplays		maxplays
		+
		+	=== Retrieve the messages from a forum/game thread ===

	'''/xmlapi/thread/<threadid>'''		'''/xmlapi/thread/<threadid>'''
-	Retrieve the messages in a forum/game thread.	+
	* start: Start article (default = 0)		* start: Start article (default = 0)
	* count: Number of articles (default and max = 100)		* count: Number of articles (default and max = 100)
	* username: Username to filter for		* username: Username to filter for
		+
		+	=== Retrieve entries from a geeklist ===

	'''/xmlapi/geeklist/<listid>'''		'''/xmlapi/geeklist/<listid>'''
-	Retrieve entries in a geeklist.	+
	Parameters		Parameters
	* start: Item to start with (0 indexed) (default = 0)		* start: Item to start with (0 indexed) (default = 0)

	* comments: Retrieve comments? (default absent, set to 1 if you want comments)		* comments: Retrieve comments? (default absent, set to 1 if you want comments)

-	Old Documentation:	+	== Old Documentation ==
		+
	http://boardgamegeek.com/xmlapi		http://boardgamegeek.com/xmlapi

-	Discussion thread:	+	== Discussion thread ==
		+
	http://www.boardgamegeek.com/thread/99401		http://www.boardgamegeek.com/thread/99401

-	Games Data XML Snapshot:	+	== Games Data XML Snapshot ==
		+
	[[BGG_XML_Snapshot]]		[[BGG_XML_Snapshot]]

BGG XML API: - moved examples

2009-03-17T11:19:02-05:00

From zefquaavius 2009-03-17 11:11:24		To zefquaavius 2009-03-17 11:19:02

	You can access some information from the geek via this XML API. Each base URI is described and the various parameters are listed. The parameters and their values are url-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described h ere, but XML is "self-describing" right? The output should be quite clear from simple inspection.		You can access some information from the geek via this XML API. Each base URI is described and the various parameters are listed. The parameters and their values are url-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described h ere, but XML is "self-describing" right? The output should be quite clear from simple inspection.

-	'''/xmlapi/search?search=<searchString>''' - e.g. http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults	+	'''/xmlapi/search?search=<searchString>''' ['''&exact=1''']
-	'''''&exact=1''''' - e.g. http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1 [''exact'' doesn't seem to work yet in BGG 2.0]	+
	Search for games by name and by AKAs.		Search for games by name and by AKAs.
-	Parameters	+	* Parameters:
-	* search: String to search for (required)	+	** search: String to search for ('''required''')
-	* exact: Exact name/aka search only (set it to 1, absent by default)	+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults
		+	** exact: Exact name/aka search only (set it to 1, absent by default) ['''exact''' doesn't seem to work yet in BGG 2.0]
		+	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1

-	'''/xmlapi/boardgame/<gameid>''' - e.g. http://www.boardgamegeek.com/xmlapi/boardgame/35424	+	'''/xmlapi/boardgame/<gameid>'''
-	'''/xmlapi/boardgame/<gameid>,<gameid2>...''' - e.g. http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860	+	'''/xmlapi/boardgame/<gameid>,<gameid2>...'''
	Retrieve information about a particular game or games.		Retrieve information about a particular game or games.
-	Parameters	+	* ''Example, single game:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424
-	* comments: Show brief user comments on games (set it to 1, absent by default)	+	* ''Example, multiple games:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860
-	* stats: Include game statistics (set it to 1, absent by default)	+	* Parameters:
-	* historical: Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.	+	** comments: Show brief user comments on games (set it to 1, absent by default)
-	from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )	+	** stats: Include game statistics (set it to 1, absent by default)
-	to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )	+	** historical: Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.
		+	*** from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )
		+	*** to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )

	'''/xmlapi/collection/<username>'''		'''/xmlapi/collection/<username>'''

BGG XML API: - Added search examples.

2009-03-17T11:11:24-05:00

From zefquaavius 2009-03-17 10:51:05		To zefquaavius 2009-03-17 11:11:24

	You can access some information from the geek via this XML API. Each base URI is described and the various parameters are listed. The parameters and their values are url-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described h ere, but XML is "self-describing" right? The output should be quite clear from simple inspection.		You can access some information from the geek via this XML API. Each base URI is described and the various parameters are listed. The parameters and their values are url-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described h ere, but XML is "self-describing" right? The output should be quite clear from simple inspection.

-	'''/xmlapi/search'''	+	'''/xmlapi/search?search=<searchString>''' - e.g. http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults
		+	'''''&exact=1''''' - e.g. http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1 [''exact'' doesn't seem to work yet in BGG 2.0]
	Search for games by name and by AKAs.		Search for games by name and by AKAs.
	Parameters		Parameters

BGG XML API: - added boardgame examples

2009-03-17T10:51:05-05:00

From zefquaavius 2009-03-17 10:49:02		To zefquaavius 2009-03-17 10:51:05

	* exact: Exact name/aka search only (set it to 1, absent by default)		* exact: Exact name/aka search only (set it to 1, absent by default)

-	'''/xmlapi/boardgame/<gameid>'''	+	'''/xmlapi/boardgame/<gameid>''' - e.g. http://www.boardgamegeek.com/xmlapi/boardgame/35424
-	'''/xmlapi/boardgame/<gameid>,<gameid2>...'''	+	'''/xmlapi/boardgame/<gameid>,<gameid2>...''' - e.g. http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860
	Retrieve information about a particular game or games.		Retrieve information about a particular game or games.
	Parameters		Parameters

BGG XML API: - updated game to boardgame

2009-03-17T10:49:02-05:00

From JeffyJeff 2009-03-09 16:16:28		To zefquaavius 2009-03-17 10:49:02

	* exact: Exact name/aka search only (set it to 1, absent by default)		* exact: Exact name/aka search only (set it to 1, absent by default)

-	'''/xmlapi/game/<gameid>'''	+	'''/xmlapi/boardgame/<gameid>'''
-	'''/xmlapi/game/<gameid>,<gameid2>...'''	+	'''/xmlapi/boardgame/<gameid>,<gameid2>...'''
	Retrieve information about a particular game or games.		Retrieve information about a particular game or games.
	Parameters		Parameters

BGG XML API: - make parameters wiki lists

2009-03-09T16:16:28-05:00

BGG XML API: - add link to bgg xml snapshot wiki

2009-03-09T14:42:48-05:00

From JeffyJeff 2009-03-09 14:41:34		To JeffyJeff 2009-03-09 14:42:48

	http://www.boardgamegeek.com/thread/99401		http://www.boardgamegeek.com/thread/99401

-	Gamees Data XML Snapshot:	+	Games Data XML Snapshot:
-	http://www.boardgamegeek.com/wiki/page/BGG_XML_Snapshot	+	[[BGG_XML_Snapshot]]

BGG XML API: - No Comment

2009-03-09T14:41:34-05:00

From JeffyJeff 2009-03-09 14:37:56		To JeffyJeff 2009-03-09 14:41:34


	Discussion thread:		Discussion thread:
-	http://www.boardgamegeek.com/thread/99401	+	http://www.boardgamegeek.com/thread/99401
		+
		+	Gamees Data XML Snapshot:
		+	http://www.boardgamegeek.com/wiki/page/BGG_XML_Snapshot

BGG XML API: - initial load

2009-03-09T14:37:56-05:00

From zefquaavius 2009-03-17 22:54:40		To JeffyJeff 2009-03-09 14:37:56

-	[[toc]]	+	'''BoardGameGeek XML API'''
		+	You can access some information from the geek via this XML API. Each base URI is described and the various parameters are listed. The parameters and their values are url-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described h ere, but XML is "self-describing" right? The output should be quite clear from simple inspection.

-	== Introduction ==	+	'''/xmlapi/search'''
		+	Search for games by name and by AKAs.
		+	Parameters
		+	search: String to search for (required)
		+	exact: Exact name/aka search only (set it to 1, absent by default)

-	You can access some information from the geek via the '''BoardGameGeek XML API'''. Each base URI is described and the various parameters are listed. The parameters and their values are URL-encoded in the standard manner. There are some examples at the end. The resultant output XML is not described here, but XML is "self-describing" right? The output should be quite clear from simple inspection.	+	'''/xmlapi/game/<gameid>'''
		+	'''/xmlapi/game/<gameid>,<gameid2>...'''
		+	Retrieve information about a particular game or games.
		+	Parameters
		+	comments: Show brief user comments on games (set it to 1, absent by default)
		+	stats: Include game statistics (set it to 1, absent by default)
		+	historical: Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.
		+	from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )
		+	to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )

-	For all of the parameters mentioned below, the first parameter you list follows a '''?''' (question mark), and each subsequent parameter follows an '''&''' (ampersand).	+	'''/xmlapi/collection/<username>'''
		+	Retrieve games in a users collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.
		+	Parameters
		+	own: In (or exclude for 0) a user's collection.
		+	rated
		+	played
		+	comment: include (or exclude) games with comments
		+	trade: games listed for trade
		+	want
		+	wishlist
		+	wanttoplay
		+	wanttobuy
		+	prevowned
		+	preordered
		+	wishlist
		+	hasparts
		+	wantparts
		+	notifycontent
		+	notifysale
		+	notifyauction
		+	showprivate: Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own c ollection, when you are logged in.
		+	You may also set the following parameters with numerical values. They should be largely self-explanatory:
		+	wishlistpriority: (a number from 1 to 5)
		+	minrating: minimum and maximum user rating
		+	maxrating
		+	minbggrating: minimum and maximum bgg rating
		+	maxbggrating
		+	minplays: minumum and maximum number of recorded plays
		+	maxplays

-	== Commands ==	+	'''/xmlapi/thread/<threadid>'''
		+	Retrieve the messages in a forum/game thread.
		+	start: Start article (default = 0)
		+	count: Number of articles (default and max = 100)
		+	username: Username to filter for

-	=== Search for games by name and by AKAs ===	+	'''/xmlapi/geeklist/<listid>'''
-		+	Retrieve entries in a geeklist.
-	/xmlapi/'''search'''	+	Parameters
-		+	start: Item to start with (0 indexed) (default = 0)
-	* Parameters:	+	count: Number of items to retrieve (default and max = 150)
-	** '''search''': String to search for ('''required''')	+	comments: Retrieve comments? (default absent, set to 1 if you want comments)
-	*** ''Syntax:'' /xmlapi/search?'''search'''=''<searchString>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults	+
-	** '''exact''': Exact name/aka search only (set it to 1, absent by default) ['''exact''' doesn't seem to work yet in BGG 2.0]	+
-	*** ''Syntax:'' /xmlapi/search?search=''<searchString>''&'''exact'''=1	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/search?search=Crossbows%20and%20Catapults&exact=1	+
-		+
-	=== Retrieve information about a particular game or games ===	+
-		+
-	/xmlapi/'''boardgame'''/''<gameid>''	+
-	/xmlapi/'''boardgame'''/''<gameid>'',''<gameid2>''[...]	+
-		+
-	* ''Example, single game:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424	+
-	* ''Example, multiple games:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860	+
-	* Parameters:	+
-	** '''comments''': Show users' comments on games (set it to 1, absent by default)	+
-	*** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?'''comments'''=1	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860?comments=1	+
-	** '''stats''': Include game statistics (set it to 1, absent by default)	+
-	*** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?'''stats'''=1	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/2860?stats=1	+
-	** '''historical''': Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.	+
-	*** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?'''historical'''=1	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860?historical=1	+
-	*** '''from''': Set the start date to include historical data (format: YYYY-MM-DD, absent by default )	+
-	*** '''to''': Set the end date to include historical data (format: YYYY-MM-DD, absent by default )	+
-	**** ''Syntax:'' /xmlapi/boardgame/''<gameId>''?historical=1&'''from'''=''<date>''&'''to'''=''<date>''	+
-	**** ''Example:'' http://www.boardgamegeek.com/xmlapi/boardgame/35424,2860?historical=1&from=2009-01-01&to=2009-03-17	+
-		+
-	=== Retrieve games in a user's collection ===	+
-		+
-	/xmlapi/'''collection'''/''<username>''	+
-	Retrieve games in a user's collection. '''Important definition:''' A user's ''collection'' includes any games the user has added to her collection on BGG. This includes games she owns, games she used to own, games she's rated, games upon which she's commented, games she's played, and games on her wishlist, just to name a few. In this section, references to the ''collection'' mean this broader sense of BGG collection, not the user's personal stash of games.	+
-		+
-	* ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/eekspider	+
-	* Filters: (You can use any combination of the below)	+
-	** '''own''': In (or exclude for 0) a user's collection. That is, the user currently owns it. Collections include games that	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''own'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=0 - games in zefquaavius' collection that he doesn't own	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?own=1 - games zefquaavius owns	+
-	** '''rated'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''rated'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?rated=0 - games in zefquaavius' collection that he has not rated	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?rated=1 - games zefquaavius has rated	+
-	** '''played'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''played'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?played=0 - games in zefquaavius' collection for which he has never logged any plays	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?played=1 - games for which zefquaavius has logged plays	+
-	** '''comment''': include (or exclude) games with comments	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''comment'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=0 - games in zefquaavius' collection upon which he currently has comments	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=1 - games upon which zefquaavius has comments	+
-	** '''trade''': games listed for trade	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''trade'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?trade=0 - games in zefquaavius' collection he is not offering for trade	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?trade=1 - games zefquaavius is offering for trade	+
-	** '''want'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''want'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=0 - games in zefquaavius' collection for which he is not trying to trade anything (i.e. He's not looking to trade for your copy of it.)	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?comment=1 - games for which zefquaavius is willing to make a trade	+
-	** '''wishlist'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wishlist'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wishlist=0 - games in zefquaavius' collection that are not on his wishlist	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wishlist=1 - games in zefquaavius' wishlist	+
-	** '''wanttoplay'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wanttoplay'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttoplay=0 - games in zefquaavius' collection which he has no pressing desire to play	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttoplay=1 - games zefquaavius currently wants to play	+
-	** '''wanttobuy'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wanttobuy'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttobuy=0 - games in zefquaavius' collection he doesn't wish to buy	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wanttobuy=1 - games zefquaavius wishes to buy	+
-	** '''prevowned'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''prevowned'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?prevowned=1 - games zefquaavius previously owned	+
-	** '''preordered'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''preordered'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?preordered=1 - games zefquaavius has pre-ordered	+
-	** '''hasparts'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''hasparts'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?hasparts=1 - zefquaavius has spare parts of these games up for offer	+
-	** '''wantparts'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wantparts'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wantparts=1 - zefquaavius is looking for spare parts for these games	+
-	** '''notifycontent'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''notifycontent'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?notifycontent=1 - zefquaavius gets a geekmail whenever these games receive new content on BGG	+
-	** '''notifysale'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''notifysale'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?notifysale=1 - zefquaavius gets a geekmail whenever a copy of these games are listed in [[BGGM]]	+
-	** '''notifyauction'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''notifyauction'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?notifyauction=1 - zefquaavius gets a geekmail whenever a copy is listed in a [[geekgold]] or eBay auction that's listed on BGG	+
-	** '''wishlistpriority''': (a number from 1 to 5)	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''wishlistpriority'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?wishlistpriority=4 - games zefquaavius has given a wishlist priority of 4 ("Thinking about it")	+
-	** '''minrating''': minimum and maximum user rating	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''minrating'''=''<1-10>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minrating=9 - games zefquaavius has given a rating of at least 9	+
-	** '''maxrating'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''maxrating'''=''<1-10>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?maxrating=2 - games zefquaavius has given a rating of no more than 2 [''Note:'' May be broken in BGG 2.0, or may require other parameters.]	+
-	** '''minbggrating''': minimum and maximum bgg rating	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''minbggrating'''=''<1-10>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minbggrating=8 - games in zefquaavius' collection with an average BGG rating of at least 8	+
-	** '''maxbggrating'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''maxbggrating'''=''<1-10>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?maxbggrating=2 - games in zefquaavius' collection with an average BGG rating no more than 2 [''Note:'' May be broken in BGG 2.0, or may require other parameters.]	+
-	** '''minplays''': minumum and maximum number of recorded plays	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''minplays'''=''<number>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minplays=50 - games zefquaavius has played 50 or more times	+
-	** '''maxplays'''	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''maxplays'''=''<number>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?minplays=50&maxplays=99 - games zefquaavius has played more than 49 times, but fewer than 100 times	+
-	* Other parameters:	+
-	** '''showprivate''': Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own collection, when you are logged in.	+
-	*** ''Syntax:'' /xmlapi/collection/''<username>''?'''showprivate'''=''<0,1>''	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?showprivate=1 - include private info zefquaavius has listed, provided you're zefquaavius	+
-	*** ''Example:'' http://www.boardgamegeek.com/xmlapi/collection/zefquaavius?showprivate=0 - If you're zefquaavius, see what everyone else sees when viewing your collection: No private info	+
-		+
-	=== Retrieve the messages from a forum/game thread ===	+
-		+
-	/xmlapi/'''thread'''/''<threadid>''	+
-		+
-	* ''Example:'' http://www.boardgamegeek.com/xmlapi/thread/381021 [''Note:'' Your browser may interpret this as a request to subscribe to an RSS feed.]	+
-	* '''start''': Start article (default = 0)	+
-	* '''count''': Number of articles (default and max = 100)	+
-	* '''username''': Username to filter for	+
-		+
-	=== Retrieve entries from a geeklist ===	+
-		+
-	/xmlapi/'''geeklist'''/''<listid>''	+
-		+
-	* ''Example:'' http://www.boardgamegeek.com/xmlapi/geeklist/11205	+
-	* '''start''': Item to start with (0 indexed) (default = 0)	+
-	* '''count''': Number of items to retrieve (default and max = 150)	+
-	* '''comments''': Retrieve comments? (default absent, set to 1 if you want comments)	+
-		+
-	== Old Documentation ==	+

		+	Old Documentation:
	http://boardgamegeek.com/xmlapi		http://boardgamegeek.com/xmlapi

-	== Discussion thread ==	+	Discussion thread:
-		+	http://www.boardgamegeek.com/thread/99401
-	http://www.boardgamegeek.com/thread/99401	+
-		+
-	== Games Data XML Snapshot ==	+
-		+
-	[[BGG XML Snapshot]]	+

From JeffyJeff 2009-03-09 14:42:48		To JeffyJeff 2009-03-09 16:16:28

	Search for games by name and by AKAs.		Search for games by name and by AKAs.
	Parameters		Parameters
-	search: String to search for (required)	+	* search: String to search for (required)
-	exact: Exact name/aka search only (set it to 1, absent by default)	+	* exact: Exact name/aka search only (set it to 1, absent by default)

	'''/xmlapi/game/<gameid>'''		'''/xmlapi/game/<gameid>'''

	Retrieve information about a particular game or games.		Retrieve information about a particular game or games.
	Parameters		Parameters
-	comments: Show brief user comments on games (set it to 1, absent by default)	+	* comments: Show brief user comments on games (set it to 1, absent by default)
-	stats: Include game statistics (set it to 1, absent by default)	+	* stats: Include game statistics (set it to 1, absent by default)
-	historical: Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.	+	* historical: Include historical game statistics (set it to 1, absent by default) - Use from/end parameters to set starting and ending dates. Returns all data starting from 2006-03-18.
	from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )		from: Set the start date to include historical data (format: YYYY-MM-DD, absent by default )
	to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )		to: Set the end date to include historical data (format: YYYY-MM-DD, absent by default )

	Retrieve games in a users collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.		Retrieve games in a users collection, as well as games the user has rated, commented on, put on their wishlist, put on their wantlist, offered for sale, or offered for trade. The default behavior is to only list all games in a users collection. You may set a variety of filters to 1 or 0. If, for example, you set own=1, you wi ll get only games marked as owned by the user. If you set own=0, you will get only games NOT owned by the user.
	Parameters		Parameters
-	own: In (or exclude for 0) a user's collection.	+	* own: In (or exclude for 0) a user's collection.
-	rated	+	* rated
-	played	+	* played
-	comment: include (or exclude) games with comments	+	* comment: include (or exclude) games with comments
-	trade: games listed for trade	+	* trade: games listed for trade
	want		want
	wishlist		wishlist

	notifysale		notifysale
	notifyauction		notifyauction
-	showprivate: Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own c ollection, when you are logged in.	+	* showprivate: Show the private fields (purchase price, etc). Default is 1 for logged in users, 0 otherwise, and showprivate=1 only works on your own c ollection, when you are logged in.
	You may also set the following parameters with numerical values. They should be largely self-explanatory:		You may also set the following parameters with numerical values. They should be largely self-explanatory:
-	wishlistpriority: (a number from 1 to 5)	+	* wishlistpriority: (a number from 1 to 5)
-	minrating: minimum and maximum user rating	+	* minrating: minimum and maximum user rating
	maxrating		maxrating
-	minbggrating: minimum and maximum bgg rating	+	* minbggrating: minimum and maximum bgg rating
	maxbggrating		maxbggrating
-	minplays: minumum and maximum number of recorded plays	+	* minplays: minumum and maximum number of recorded plays
	maxplays		maxplays

	'''/xmlapi/thread/<threadid>'''		'''/xmlapi/thread/<threadid>'''
	Retrieve the messages in a forum/game thread.		Retrieve the messages in a forum/game thread.
-	start: Start article (default = 0)	+	* start: Start article (default = 0)
-	count: Number of articles (default and max = 100)	+	* count: Number of articles (default and max = 100)
-	username: Username to filter for	+	* username: Username to filter for

	'''/xmlapi/geeklist/<listid>'''		'''/xmlapi/geeklist/<listid>'''
	Retrieve entries in a geeklist.		Retrieve entries in a geeklist.
	Parameters		Parameters
-	start: Item to start with (0 indexed) (default = 0)	+	* start: Item to start with (0 indexed) (default = 0)
-	count: Number of items to retrieve (default and max = 150)	+	* count: Number of items to retrieve (default and max = 150)
-	comments: Retrieve comments? (default absent, set to 1 if you want comments)	+	* comments: Retrieve comments? (default absent, set to 1 if you want comments)

	Old Documentation:		Old Documentation: