MtGox/API/HTTP/v1 - Revision history

Neofutur: /* App activation */

2013-05-30T20:32:17Z

App activation

← Older revision		Revision as of 20:32, 30 May 2013
Line 524:		Line 524:
	==== App activation ====		==== App activation ====

	https://~~data.~~mtgox.com/api/1/generic/api/activate		https://mtgox.com/api/1/generic/api/activate

	parameters:		parameters:
	* '''key''' - Activation key		* '''key''' - Activation key

Neofutur at 00:20, 26 May 2013

2013-05-26T00:20:53Z

← Older revision		Revision as of 00:20, 26 May 2013
Line 44:		Line 44:
	* last_orig include data of the original last trade ( currency,price in currency . . . ),		* last_orig include data of the original last trade ( currency,price in currency . . . ),
	* last is always the same as last_all		* last is always the same as last_all

			==== Fast Ticker ====

			http://data.mtgox.com/api/1/BTCUSD/ticker_fast



	==== Multi Currency depth ====		==== Multi Currency depth ====

Neofutur: /* Your open orders */

2013-05-16T14:32:21Z

Your open orders

← Older revision		Revision as of 14:32, 16 May 2013
Line 381:		Line 381:
	https://data.mtgox.com/api/1/generic/private/orders		https://data.mtgox.com/api/1/generic/private/orders

	Returns a list of all your currently existing orders with oid and status .		Returns a list of all your currently existing orders with oid and status .

	Valid order statuses are: pending, executing, post-pending, open, stop, and invalid.		Valid order statuses are: pending, executing, post-pending, open, stop, and invalid.

	The order can have 2 amounts, the valid amount and the invalid ( unfunded ) amount.		The order can have 2 amounts, the valid amount and the invalid ( unfunded ) amount.
	valid amount and invalid amount will be updated when funds are added or when other orders are removed		valid amount and invalid amount will be updated when funds are added or when other orders are removed

Neofutur: /* Your open orders */

2013-05-16T14:32:01Z

Your open orders

← Older revision		Revision as of 14:32, 16 May 2013
Line 381:		Line 381:
	https://data.mtgox.com/api/1/generic/private/orders		https://data.mtgox.com/api/1/generic/private/orders

	Returns ~~information about~~ your ~~current open~~ orders~~. Valid order statuses are: pending, executing, post-pending, open, stop,~~ and ~~invalid~~.		Returns a list of all your currently existing orders with oid and status .

	The order can have 2 amounts, the valid amount and the invalid ( unfunded ) amount.		Valid order statuses are: pending, executing, post-pending, open, stop, and invalid.

			The order can have 2 amounts, the valid amount and the invalid ( unfunded ) amount.
	valid amount and invalid amount will be updated when funds are added or when other orders are removed		valid amount and invalid amount will be updated when funds are added or when other orders are removed

Neofutur: /* Multi Currency Ticker */

2013-04-13T05:41:05Z

Multi Currency Ticker

← Older revision		Revision as of 05:41, 13 April 2013
Line 10:		Line 10:

	returns the current ticker for the selected currency :		returns the current ticker for the selected currency :

			caching and rate limit :30 seconds

	<source lang="php">		<source lang="php">

GenBTC: /* Cancel an Order */

2013-04-05T08:58:27Z

Cancel an Order

← Older revision		Revision as of 08:58, 5 April 2013
Line 352:		Line 352:
	<br>		<br>

	~~parameters~~: ~~<br>~~		;Parameters:
	* oid <the order ID> <br>		* oid <the order ID> <br>

	;Example Response:		;Example Response:
			<source lang="javascript">
	{		{
	"return": {		"return": {
Line 363:		Line 364:
	"result": "success"		"result": "success"
	}		}
			</source>

	;Example Error:		;Example Error:
			<source lang="javascript">
	{		{
	"token": "unknown_error",		"token": "unknown_error",
Line 370:		Line 373:
	"error": "Order not found"		"error": "Order not found"
	}		}
			</source>

	==== Your open orders ====		==== Your open orders ====

GenBTC: /* Cancel an Order */

2013-04-05T08:56:52Z

Cancel an Order

← Older revision		Revision as of 08:56, 5 April 2013
Line 347:		Line 347:
	==== Cancel an Order ====		==== Cancel an Order ====
	API v2 URL: https://data.mtgox.com/api/2/BTCUSD/money/order/cancel <br>		API v2 URL: https://data.mtgox.com/api/2/BTCUSD/money/order/cancel <br>
	API v1 URL ~~(guessing)~~: https://data.mtgox.com/api/1/BTCUSD/private/order/cancel <br>		API v1 URL: https://data.mtgox.com/api/1/BTCUSD/private/order/cancel <br>

			Both are the format as shown below, but with API2, all "return" keys are changed to "data" <br>
	~~Returns data in~~ the ~~same~~ format as ~~above~~, (with API2, all "return" keys are changed to "data" <br>		<br>
	~~If order not found: {"result":"error","error":"Order not found","token":"unknown_error"}~~ <br>

	parameters: <br>		parameters: <br>
	* oid <the order ID> <br>		* oid <the order ID> <br>

			;Example Response:
			{
			"return": {
			"qid": "09354767-455f-412e-9a0c-efb7bb98c958",
			"oid": "fda8917a-63d3-4415-b827-758408013690"
			},
			"result": "success"
			}

			;Example Error:
			{
			"token": "unknown_error",
			"result": "error",
			"error": "Order not found"
			}

	==== Your open orders ====		==== Your open orders ====

GenBTC: /* Order result */

2013-04-05T08:18:51Z

Order result

← Older revision		Revision as of 08:18, 5 April 2013
Line 420:		Line 420:
	==== Order result ====		==== Order result ====

	https://data.mtgox.com/api/1/generic/private/order/result		https://data.mtgox.com/api/1/generic/private/order/result (the /private is not needed anymore)

	parameters : type ( bid or ask ) and order (the order id)		parameters : type ( bid or ask ) and order (the order id)

	~~returns~~ a ~~json array like this :~~		Returns JSON. trades is a list. everything is a string.

	<source lang="javascript">		<source lang="javascript">
	order_id: ~~'1234234~~-~~e9ef~~-~~4b75~~-~~aa1c~~-~~90cd109d24ea'~~,		{
	trades:		"return": {
	[ { trade_id: ~~'1336611143363429'~~,		"order_id": "30f3311c-1d6d-4313-b22d-f45c048fd004",
	~~primary~~: ~~'N'~~,		"total_spent": {
	currency: 'USD',		"value_int": "8484299",
	~~type~~: ~~'ask'~~,		"currency": "USD",
	~~properties~~: ~~'market~~,~~mixed_currency'~~,		"display_short": "$84.84",
	~~item~~: 'BTC',		"display": "$84.84299",
	~~amount~~: ~~[Object]~~,		"value": "84.84299"
	~~price~~: ~~[Object]~~,		},
	date: ~~'2012~~-05~~-10 00~~:52:~~23'~~ } ],		"trades": [{
	total_amount:		"item": "BTC",
	{ value: '0.~~01000000'~~,		"price": {
	value_int: ~~'1000000'~~,		"value_int": "10384000",
	display: '0.~~01000000 BTC'~~,		"currency": "USD",
	~~display_short~~: '0.~~01 BTC'~~,		"display_short": "$103.84",
	~~currency~~: ~~'BTC' }~~ }</source>		"display": "$103.84000",
			"value": "103.84000"
			},
			"trade_id": "1364879059328495",
			"spent": {
			"value_int": "8484299",
			"currency": "USD",
			"display_short": "$84.84",
			"display": "$84.84299",
			"value": "84.84299"
			},
			"primary": "Y",
			"currency": "USD",
			"amount": {
			"value_int": "81705496",
			"currency": "BTC",
			"display_short":
			"0.82\u00a0BTC",
			"display": "0.81705496\u00a0BTC",
			"value": "0.81705496"},
			"date": "2013-04-02 05:04:19",
			"type": "ask",
			"properties": "market"
			}],
			"total_amount": {
			"value_int": "81705496",
			"currency": "BTC",
			"display_short": "0.82\u00a0BTC",
			"display": "0.81705496\u00a0BTC",
			"value": "0.81705496"
			},
			"avg_cost": {
			"value_int": "10384000",
			"currency": "USD",
			"display_short": "$103.84",
			"display": "$103.84000",
			"value": "103.84000"}
			},
			"result": "success"
			}
			</source>

	=== Application API ===		=== Application API ===

GenBTC: /* Withdraw bitcoins */

2013-04-04T22:42:01Z

Withdraw bitcoins

← Older revision		Revision as of 22:42, 4 April 2013
Line 299:		Line 299:

	Answer unknown at the time of writing		Answer unknown at the time of writing

			;Example Error:
			{u'token': u'unknown_error', u'result': u'error', u'error': u'Parameter amount_int or amount is required'}

	==== idKey ====		==== idKey ====

GenBTC: /* HTTP API version 1 methods */

2013-04-02T09:44:26Z

HTTP API version 1 methods

← Older revision		Revision as of 09:44, 2 April 2013
Line 224:		Line 224:
	==== Private info ====		==== Private info ====

	https://mtgox.com/api/1/generic/private/info		https://data.mtgox.com/api/1/generic/private/info

	returns information about your account, funds, fees, API privileges, withdraw limits . . .		returns information about your account, funds, fees, API privileges, withdraw limits . . .
Line 230:		Line 230:
	==== get a bitcoin deposit address ====		==== get a bitcoin deposit address ====

	https://mtgox.com/api/1/generic/bitcoin/address		https://data.mtgox.com/api/1/generic/bitcoin/address

	get a bitcoin address linked to your account.		get a bitcoin address linked to your account.
Line 253:		Line 253:
	==== redeem a private key ====		==== redeem a private key ====

	https://mtgox.com/api/1/generic/private/bitcoin/addpriv		https://data.mtgox.com/api/1/generic/private/bitcoin/addpriv

	allows you to add a private key to your account		allows you to add a private key to your account
Line 266:		Line 266:
	==== redeem a wallet.dat ====		==== redeem a wallet.dat ====

	https://mtgox.com/api/1/generic/bitcoin/wallet_add		https://data.mtgox.com/api/1/generic/bitcoin/wallet_add

	allows you to add a wallet.dat file to your account		allows you to add a wallet.dat file to your account
Line 277:		Line 277:

	==== Withdraw bitcoins ====		==== Withdraw bitcoins ====
	https://mtgox.com/api/1/generic/bitcoin/send_simple		https://data.mtgox.com/api/1/generic/bitcoin/send_simple

	Send bitcoins from your account to a bitcoin address.		Send bitcoins from your account to a bitcoin address.
Line 302:		Line 302:
	==== idKey ====		==== idKey ====

	https://mtgox.com/api/1/generic/private/idkey		https://data.mtgox.com/api/1/generic/private/idkey

	Returns the idKey used to subscribe to a user's private updates channel in the websocket API. The key is valid for 24 hours.		Returns the idKey used to subscribe to a user's private updates channel in the websocket API. The key is valid for 24 hours.
Line 309:		Line 309:
	==== Your wallet history ====		==== Your wallet history ====

	https://mtgox.com/api/1/generic/private/wallet/history		https://data.mtgox.com/api/1/generic/private/wallet/history

	'''README!''' if the above call does not work please use: https://mtgox.com/api/1/generic/wallet/history		'''README!''' if the above call does not work please use: https://mtgox.com/api/1/generic/wallet/history
Line 325:		Line 325:
	==== Submit an order ====		==== Submit an order ====

	https://mtgox.com/api/1/BTCUSD/private/order/add		https://data.mtgox.com/api/1/BTCUSD/private/order/add

	parameters:		parameters:
Line 341:		Line 341:
	"result": "success"		"result": "success"
	}</source>		}</source>

			==== Cancel an Order ====
			API v2 URL: https://data.mtgox.com/api/2/BTCUSD/money/order/cancel <br>
			API v1 URL (guessing): https://data.mtgox.com/api/1/BTCUSD/private/order/cancel <br>


			Returns data in the same format as above, (with API2, all "return" keys are changed to "data" <br>
			If order not found: {"result":"error","error":"Order not found","token":"unknown_error"} <br>

			parameters: <br>
			* oid <the order ID> <br>

	==== Your open orders ====		==== Your open orders ====

	https://mtgox.com/api/1/generic/private/orders		https://data.mtgox.com/api/1/generic/private/orders

	Returns information about your current open orders. Valid order statuses are: pending, executing, post-pending, open, stop, and invalid.		Returns information about your current open orders. Valid order statuses are: pending, executing, post-pending, open, stop, and invalid.
Line 406:		Line 417:
	==== Order result ====		==== Order result ====

	https://mtgox.com/api/1/generic/private/order/result		https://data.mtgox.com/api/1/generic/private/order/result

	parameters : type ( bid or ask ) and order (the order id)		parameters : type ( bid or ask ) and order (the order id)
Line 435:		Line 446:
	==== HOTP key ====		==== HOTP key ====

	https://mtgox.com/api/1/generic/hotp_gen		https://data.mtgox.com/api/1/generic/hotp_gen

	used to generate a new HOTP key ( useful for developers )		used to generate a new HOTP key ( useful for developers )
Line 441:		Line 452:
	==== App activation ====		==== App activation ====

	https://mtgox.com/api/1/generic/api/activate		https://data.mtgox.com/api/1/generic/api/activate

	parameters:		parameters:
Line 454:		Line 465:
	==== Order Creation ====		==== Order Creation ====

	https://mtgox.com/api/1/generic/private/merchant/order/create		https://data.mtgox.com/api/1/generic/private/merchant/order/create

	===== Required Parameters: =====		===== Required Parameters: =====