MtGox/API/HTTP/v2 - Revision history

Karlb at 08:33, 1 November 2013

2013-11-01T08:33:41Z

← Older revision		Revision as of 08:33, 1 November 2013
Line 40:		Line 40:
	====Python v 2.7.3====		====Python v 2.7.3====

			https://bitbucket.org/karlb/gox2 - A minimalistic API wrapper <br>
	http://pastebin.com/aXQfULyq - Remove any proprietary unlock_api_key stuff. You'll need [https://github.com/genbtc/trader.python/blob/master/lib/json_ascii.py json_ascii] also. Works on API 0/1/2. Link to git-repo: [https://github.com/genbtc/trader.python/ genbtc's trader.python] <br>		http://pastebin.com/aXQfULyq - Remove any proprietary unlock_api_key stuff. You'll need [https://github.com/genbtc/trader.python/blob/master/lib/json_ascii.py json_ascii] also. Works on API 0/1/2. Link to git-repo: [https://github.com/genbtc/trader.python/ genbtc's trader.python] <br>

Kakobrekla: /* Code Examples: */

2013-09-30T02:19:51Z

Code Examples:

← Older revision		Revision as of 02:19, 30 September 2013
Line 44:		Line 44:
	====Perl====		====Perl====
	https://en.bitcoin.it/wiki/MtGox/API/HTTP#PHP The Perl example on the main page is compatible with v2		https://en.bitcoin.it/wiki/MtGox/API/HTTP#PHP The Perl example on the main page is compatible with v2

			====PHP====
			https://github.com/pathaksa/MtGox-PHP-API-V2

Neofutur: /* Differences between v1 and v2: */

2013-05-26T00:18:19Z

Differences between v1 and v2:

← Older revision		Revision as of 00:18, 26 May 2013
Line 13:		Line 13:
	* The '''URL''' is now something along the lines of BTCUSD/money/order/add instead of BTCUSD/private/order/add in api1. All current known methods are found in the money category.		* The '''URL''' is now something along the lines of BTCUSD/money/order/add instead of BTCUSD/private/order/add in api1. All current known methods are found in the money category.
	* The ''requested path'' must now be included when you compute your '''hashed signature (Rest-Sign)''' for added security.<br><br> In version 1, Rest-Sign is created through base64-encoding the 256-digest HMAC hashing of your post data (which of course must include your nonce) with your API secret, previously base64 decoded. Now in version 2, you must simply add ''before'' your post data the relative path you are requesting (anything after the /api/2/ base, ie: BTCUSD/money/ticker), concatenated with a NUL character (ASCII code 0). So the signature is now made starting from your relative path + NUL character + post data (which must include your nonce!).		* The ''requested path'' must now be included when you compute your '''hashed signature (Rest-Sign)''' for added security.<br><br> In version 1, Rest-Sign is created through base64-encoding the 256-digest HMAC hashing of your post data (which of course must include your nonce) with your API secret, previously base64 decoded. Now in version 2, you must simply add ''before'' your post data the relative path you are requesting (anything after the /api/2/ base, ie: BTCUSD/money/ticker), concatenated with a NUL character (ASCII code 0). So the signature is now made starting from your relative path + NUL character + post data (which must include your nonce!).

			* fast ticker
			http://data.mtgox.com/api/2/BTCUSD/money/ticker_fast

			and

			http://data.mtgox.com/api/2/BTCUSD/money/ticker_fast?pretty

	=== Explanation of Methods ===		=== Explanation of Methods ===

HamNotEggs: /* Documentation */ trying to clear up things a bit

2013-04-27T21:38:20Z

Documentation: trying to clear up things a bit

← Older revision		Revision as of 21:38, 27 April 2013
Line 5:		Line 5:

	=== Documentation ===		=== Documentation ===
	'''~~unofficial~~''' documentation (So far the best we have) is provided at :		'''Unofficial''' documentation (So far the best we have) is provided at : https://bitbucket.org/nitrous/mtgox-api/overview (The bitcointalk forum link is: https://bitcointalk.org/index.php?topic=164404.0 )

	'''~~https://bitbucket.org/nitrous/mtgox-api/overview~~''' ~~<br>~~		'''Official''' docs are on: https://github.com/MtGox/mtgox-doc
	~~(The bitcointalk forum link is~~: ~~'''~~https://~~bitcointalk~~.~~org~~/~~index.php?topic=164404.0'''~~
	~~<br>~~

	~~'''official''' docs are on~~ :		===== Differences between v1 and v2: =====

	'''~~https:~~//~~github.com~~/~~MtGox~~/~~mtgox-doc'~~''		* The '''URL''' is now something along the lines of BTCUSD/money/order/add instead of BTCUSD/private/order/add in api1. All current known methods are found in the money category.
			* The ''requested path'' must now be included when you compute your '''hashed signature (Rest-Sign)''' for added security.<br><br> In version 1, Rest-Sign is created through base64-encoding the 256-digest HMAC hashing of your post data (which of course must include your nonce) with your API secret, previously base64 decoded. Now in version 2, you must simply add ''before'' your post data the relative path you are requesting (anything after the /api/2/ base, ie: BTCUSD/money/ticker), concatenated with a NUL character (ASCII code 0). So the signature is now made starting from your relative path + NUL character + post data (which must include your nonce!).
	~~===== Technical Use Explanation: =====~~

	~~The~~ requested path ~~(anything after the /2/)~~ must now be included when you compute your hashed signature (Rest-Sign) for added security.

	~~This is how it was done for~~ version 1:

	~~You have your params(post_data) = the word nonce, followed by the actual ''nonce'' integer (params = [(u'nonce'~~,~~nonce)])~~

	~~You have your header made up of ''Rest-Key'' (your API-KEY) and ''Rest-Sign'' (a hashed signature)~~

	Rest-Sign is created ~~by doing : base64encode(~~ HMAC ~~hash( base64decoded~~(API-secret), ~~the nonce, with SHA512 digest))~~

	~~'''What differs~~ in version 2 ~~is now''' : BEFORE the nonce~~, you ~~are adding the~~ '''relative path you are requesting~~'''~~(ie: BTCUSD/money/ticker) ~~'''+~~ a NUL ~~char~~ (~~ascii~~ code 0)~~'''~~.

	~~'''The URL is now ''' something along~~ the ~~lines of BTCUSD/money/order/add instead of BTCUSD/private/order/add in api1. <br>~~
	~~So in my python code below which~~ is ~~very readable you can see everything remains the same as API v1 except~~ now ~~we are using api2postdatatohash =~~ path + ~~chr~~(0) ~~+ post_data #new way to hash for API 2, includes path + NUL~~.

	=== Explanation of Methods ===		=== Explanation of Methods ===

Advanced at 14:07, 26 April 2013

2013-04-26T14:07:22Z

← Older revision		Revision as of 14:07, 26 April 2013
Line 40:		Line 40:

	=== Code Examples: ===		=== Code Examples: ===

			====Java:====

			https://github.com/adv0r/mtgox-api-v2-java Java lib for API V2, under development

	====C# :====		====C# :====

GenBTC: /* API Version 2: */

2013-04-12T00:26:55Z

API Version 2:

← Older revision		Revision as of 00:26, 12 April 2013
Line 32:		Line 32:
	So in my python code below which is very readable you can see everything remains the same as API v1 except now we are using api2postdatatohash = path + chr(0) + post_data #new way to hash for API 2, includes path + NUL.		So in my python code below which is very readable you can see everything remains the same as API v1 except now we are using api2postdatatohash = path + chr(0) + post_data #new way to hash for API 2, includes path + NUL.

			=== Explanation of Methods ===
	BTCUSD/money/order/quote		'''BTCUSD/money/order/quote''' <br>
	<@MagicalTux> it estimate the result of running an order at a given price based on market depth		<@MagicalTux> it estimate the result of running an order at a given price based on market depth<br>
			'''BTCUSD/money/ticker_fast'''<br>
			Solves the problem of ticker lag. (supposedly)<br>

Dxbydt at 08:11, 8 April 2013

2013-04-08T08:11:44Z

← Older revision		Revision as of 08:11, 8 April 2013
Line 41:		Line 41:
	====C# :====		====C# :====

	https://~~github~~.~~com~~/pipe2grep/~~GoxSharp~~ C# lib for V2 API and socketIO		https://bitbucket.org/pipe2grep/cryptocoinxchange C# lib for V2 API and socketIO

	====Python v 2.7.3====		====Python v 2.7.3====

GenBTC: /* Python v 2.7.3 */

2013-04-08T06:28:32Z

Python v 2.7.3

← Older revision		Revision as of 06:28, 8 April 2013
Line 45:		Line 45:
	====Python v 2.7.3====		====Python v 2.7.3====

	http://pastebin.com/aXQfULyq - Remove any proprietary unlock_api_key stuff. You'll need json_ascii also. Works on API 0/1/2.<br>		http://pastebin.com/aXQfULyq - Remove any proprietary unlock_api_key stuff. You'll need [https://github.com/genbtc/trader.python/blob/master/lib/json_ascii.py json_ascii] also. Works on API 0/1/2. Link to git-repo: [https://github.com/genbtc/trader.python/ genbtc's trader.python] <br>

	====Perl====		====Perl====
	https://en.bitcoin.it/wiki/MtGox/API/HTTP#PHP The Perl example on the main page is compatible with v2		https://en.bitcoin.it/wiki/MtGox/API/HTTP#PHP The Perl example on the main page is compatible with v2

GenBTC at 06:24, 8 April 2013

2013-04-08T06:24:59Z

← Older revision		Revision as of 06:24, 8 April 2013
Line 1:		Line 1:
	== API Version 2: ==		== API Version 2: ==
	~~v2 api~~ is ~~found at~~ :		The V2 API URL is:

	'''https://data.mtgox.com/api/2/'''		'''https://data.mtgox.com/api/2/'''

	official docs are on :		=== Documentation ===
			'''unofficial''' documentation (So far the best we have) is provided at :

			'''https://bitbucket.org/nitrous/mtgox-api/overview''' <br>
			(The bitcointalk forum link is: '''https://bitcointalk.org/index.php?topic=164404.0'''
			<br>

			'''official''' docs are on :

	'''https://github.com/MtGox/mtgox-doc'''		'''https://github.com/MtGox/mtgox-doc'''

			===== Technical Use Explanation: =====

	The requested path (anything after the /2/) must now be included when you compute your hashed signature (Rest-Sign) for added security.		The requested path (anything after the /2/) must now be included when you compute your hashed signature (Rest-Sign) for added security.

	~~===== Explanation: =====~~

	This is how it was done for version 1:		This is how it was done for version 1:

GenBTC: /* Python */

2013-04-04T19:43:05Z

Python

← Older revision		Revision as of 19:43, 4 April 2013
Line 36:		Line 36:
	https://github.com/pipe2grep/GoxSharp C# lib for V2 API and socketIO		https://github.com/pipe2grep/GoxSharp C# lib for V2 API and socketIO

	====Python====		====Python v 2.7.3====

	http://pastebin.com/aXQfULyq<br />		http://pastebin.com/aXQfULyq - Remove any proprietary unlock_api_key stuff. You'll need json_ascii also. Works on API 0/1/2.<br>

	====Perl====		====Perl====
	https://en.bitcoin.it/wiki/MtGox/API/HTTP#PHP The Perl example on the main page is compatible with v2		https://en.bitcoin.it/wiki/MtGox/API/HTTP#PHP The Perl example on the main page is compatible with v2