Bitcoin Wiki - User contributions [en]

https://en.bitcoin.it/w/api.php?action=feedcontributions&feedformat=atom&user=Molecular Bitcoin Wiki - User contributions [en] 2026-04-18T02:54:50Z User contributions MediaWiki 1.43.8 https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=21995 MtGox/API 2012-01-10T22:24:25Z

<p>Molecular: </p> <hr /> <div>The [[MtGox]] API provides methods to access information from the market, place orders, and more.<br /> <br /> Two APIs are currently available: the HTTP API (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> ==Number Formats==<br /> <br /> In the "old API", currency- and amount-values (price, volume,...) were given as '''float'''. These values are likely being deprecated and replaced by fields of the same name with "_int" as suffix. These are '''fixed-decimal''', so you have to move the decimal point yourself (divide). The exponent differs based on the kind of the value.<br /> <br /> In order to convert the '''int''' to a '''decimal''' you can...<br /> <br /> {| class="wikitable"<br /> |-<br /> ! kind of field !! ...divide by !! ...multiply by<br /> |-<br /> | BTC (volume, amount) || 1E8 (10,000,000) || 0.00000001<br /> |-<br /> | USD (price) || 1E5 (100,000) || 0.00001<br /> |-<br /> | JPY (price) || 1E3 (1,000) || 0.001<br /> |}<br /> <br /> Implementation advice: it's probably best to use '''int''' or '''Decimal''' (if your language/db offers such a type) in your clients. Using '''float''' will likely lead to nasty rounding problems.<br /> <br /> == Currency Symbols ==<br /> List of the currency symbols available with the API:<br /> <br /> USD, AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, JPY, NZD, PLN, RUB, SEK, SGD, THB<br /> <br /> == HTTP API ==<br /> This API is available in <nowiki>https://mtgox.com/api/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc. There is also a [https://rubygems.org/gems/mtgox Ruby gem] and [[Finance::MtGox|Perl module]] for interacting with the HTTP API.<br /> <br /> === Authentication ===<br /> <br /> <br /> Authentication is performed by signing each request using HMAC-SHA512. The request must contain an extra value "nonce" which must be an always incrementing numeric value. A reference implementation is provided here:<br /> <source lang="php"><br /> <?php<br /> <br /> function mtgox_query($path, array $req = array()) {<br /> // API settings<br /> $key = '';<br /> $secret = '';<br /> <br /> // generate a nonce as microtime, with as-string handling to avoid problems with 32bits systems<br /> $mt = explode(' ', microtime());<br /> $req['nonce'] = $mt[1].substr($mt[0], 2, 6);<br /> <br /> // generate the POST data string<br /> $post_data = http_build_query($req, '', '&');<br /> <br /> // generate the extra headers<br /> $headers = array(<br /> 'Rest-Key: '.$key,<br /> 'Rest-Sign: '.base64_encode(hash_hmac('sha512', $post_data, base64_decode($secret), true)),<br /> );<br /> <br /> // our curl handle (initialize if required)<br /> static $ch = null;<br /> if (is_null($ch)) {<br /> $ch = curl_init();<br /> curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);<br /> curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/4.0 (compatible; MtGox PHP client; '.php_uname('s').'; PHP/'.phpversion().')');<br /> }<br /> curl_setopt($ch, CURLOPT_URL, 'https://mtgox.com/api/'.$path);<br /> curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);<br /> curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);<br /> <br /> // run the query<br /> $res = curl_exec($ch);<br /> if ($res === false) throw new Exception('Could not get reply: '.curl_error($ch));<br /> $dec = json_decode($res, true);<br /> if (!$dec) throw new Exception('Invalid data received, please make sure connection is working and requested API exists');<br /> return $dec;<br /> }<br /> <br /> // example 1: get infos about the account, plus the list of rights we have access to<br /> var_dump(mtgox_query('0/info.php'));<br /> <br /> // old api (get funds)<br /> var_dump(mtgox_query('0/getFunds.php'));<br /> <br /> // trade example<br /> // var_dump(mtgox_query('0/buyBTC.php', array('amount' => 1, 'price' => 15)));<br /> </source><br /> <br /> Python version here: https://bitcointalk.org/index.php?topic=49789.msg592388#msg592388<br /> <br /> === Cache ===<br /> <br /> All of the API methods below have cached results, ticker, depth . . . have a 10 seconds cache .<br /> No need to poll more often, you wont have more results, you could just be blocked by the prolexic anti ddos features.<br /> <br /> === Methods API version 0===<br /> <br /> ==== 0/data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> * data is returned in standard json format like :<br /> <source lang="php"><br /> [<br /> {"date":1279408157,<br /> "price":"0.04951",<br /> "amount":"20",<br /> "price_int":"4951",<br /> "amount_int":"2000000000",<br /> "tid":"1",<br /> "price_currency":"USD",<br /> "item":"BTC",<br /> "trade_type":""<br /> "primary":"Y"<br /> },<br /> {"date":1279424586,"price":"0.05941","amount":"50.01","price_int":"5941","amount_int":"5001000000","tid":"2","price_currency":"USD","item":"BTC","trade_type":""}]<br /> </source><br /> <br /> ==== 0/getDepth.php ====<br /> Get the current Market depth<br /> <br /> https://mtgox.com/api/0/data/getDepth.php?Currency=PLN<br /> <br /> https://mtgox.com/api/0/data/getDepth.php?Currency=AUD<br /> <br /> https://mtgox.com/api/0/data/getDepth.php?Currency=USD<br /> <br /> ==== 0/getFunds.php ====<br /> Get your current balance<br /> <br /> https://mtgox.com/api/0/getFunds.php<br /> <br /> getfunds is now deprecated since multi currency, please use info.php<br /> <br /> ==== 0/buyBTC.php ====<br /> Place an order to Buy BTC<br /> <br /> https://mtgox.com/api/0/buyBTC.php<br /> <br /> POST data: amount=#&price=#&Currency=PLN<br /> <br /> returns a list of your open orders<br /> <br /> you can omit the price to do a market order<br /> <br /> ==== 0/sellBTC.php ====<br /> Place an order to Sell BTC<br /> <br /> https://mtgox.com/api/0/sellBTC.php<br /> <br /> POST data: &amount=#&price=#&Currency=PLN <br /> <br /> returns a list of your open orders<br /> <br /> you can omit the price to do a market order<br /> <br /> ==== 0/getOrders.php ====<br /> Fetch a list of your open Orders<br /> <br /> https://mtgox.com/api/0/getOrders.php<br /> <br /> oid: Order ID<br /> <br /> type: 1 for sell order or 2 for buy order<br /> <br /> status: 1 for active, 2 for not enough funds<br /> <br /> ==== 0/cancelOrder.php ====<br /> Cancel an order<br /> <br /> https://mtgox.com/api/0/cancelOrder.php<br /> <br /> POST data: oid=#&type=#<br /> <br /> oid: Order ID<br /> <br /> type: 1 for sell order or 2 for buy order<br /> <br /> ==== 0/redeemCode.php ====<br /> Used to redeem a mtgox coupon code<br /> <br /> https://mtgox.com/api/0/redeemCode.php<br /> <br /> * call with a post parameter "code" containing the code to redeem<br /> <br /> * it will return an array with amount (float amount value of code), currency (3 letters, BTC or USD), reference (the transaction id), and status<br /> <br /> ==== 0/withdraw.php ====<br /> withdraw / Send BTC<br /> <br /> https://mtgox.com/api/0/withdraw.php<br /> <br /> POST data: group1=BTC&btca=bitcoin_address_to_send_to&amount=#<br /> <br /> * pass btca parameter to withdraw to a btc adress<br /> <br /> * pass group1 for a coupon : BTC2CODE or USD2CODE<br /> <br /> * pass group1=DWUSD&dwaccount=XXX-XXX-XXXX (no btca=xxxxxxx) for a dwolla withdraw<br /> <br /> * pass green=1 to use the new greenaddress feature ( see [[GreenAddress]] )<br /> * return code and status if successful<br /> <br /> To make a withdraw in another Currency , use group1=USD2CODE and add a Currency parameter ( example Currency=EUR to get a mtgox EUR coupon )<br /> <br /> ==== 0/btcAddress.php ====<br /> get a bitcoin deposit adress for your account <br /> <br /> https://mtgox.com/api/0/btcAddress.php<br /> <br /> * pass POST data "description" to add a description that will appear in your history when this BTC address receive a deposit<br /> <br /> * returns a bitcoin deposit address<br /> <br /> ==== 0/history_[CUR].csv ====<br /> <br /> Allows downloading your activity history for a given currency (BTC or USD for now).<br /> <br /> https://mtgox.com/api/0/history_BTC.csv<br /> <br /> https://mtgox.com/api/0/history_USD.csv<br /> <br /> ==== 0/info.php ====<br /> <br /> https://mtgox.com/api/0/info.php<br /> <br /> returns info about your account, funds, fees, API privileges, withdraw limits . . . <br /> <br /> ==== 0/ticker ====<br /> <br /> http://mtgox.com/api/0/data/ticker.php<br /> <br /> returns the current ticker :<br /> <br /> <source lang="php"><br /> {"ticker":<br /> {<br /> "high":5.70653,<br /> "low":5.4145,<br /> "avg":5.561388723,<br /> "vwap":5.610932845,<br /> "vol":55698,<br /> "last":5.56915,<br /> "buy":5.51326,<br /> "sell":5.5672<br /> }<br /> }<br /> </source><br /> <br /> the time frame for high, low, vol, avg, vwap . . . is sliding 24 hours<br /> <br /> what is vwap ? <br /> <br /> please see http://en.wikipedia.org/wiki/VWAP<br /> <br /> === API version 0 examples ===<br /> <br /> ==== all api shell type CLI ====<br /> <br /> python : http://www.goxsh.info/<br /> <br /> perl : http://pastebin.com/vEpgw5nW<br /> <br /> ==== other ====<br /> <br /> https : http://stackoverflow.com/questions/7046370/https-request-with-boost-asio-and-openssl<br /> <br /> https://github.com/sje397/mtgox-plasmoid<br /> <br /> module perl : http://search.cpan.org/~mndrix/Finance-MtGox-0.02/<br /> <br /> ==== gather data ====<br /> <br /> https://github.com/Lexiks/MyBitBoard<br /> <br /> ==== gettrade ====<br /> <br /> bash : https://bitcointalk.org/index.php?topic=39402.0<br /> <br /> perl : http://pastebin.com/raw.php?i=pmhMXZJu<br /> <br /> ==== ticker ====<br /> <br /> http://pastebin.com/pd0ZR4WY<br /> <br /> === Methods API version 1===<br /> <br /> ==== Multi Currency Ticker ====<br /> <br /> https://mtgox.com/api/1/BTCUSD/public/ticker<br /> https://mtgox.com/api/1/BTCEUR/public/ticker<br /> <br /> returns the current ticker for the selected currency :<br /> <br /> <source lang="php"><br /> {<br /> "result":"success",<br /> "return":<br /> {<br /> "high": {"value":"5.70653","value_int":"570653","display":"$5.70653","currency":"USD"},<br /> "low": {"value":"5.4145","value_int":"541450","display":"$5.41450","currency":"USD"},<br /> "avg": {"value":"5.561119626","value_int":"556112","display":"$5.56112","currency":"USD"},<br /> "vwap": {"value":"5.610480461","value_int":"561048","display":"$5.61048","currency":"USD"},<br /> "vol":<br /> {<br /> "value":"55829.58960346",<br /> "value_int":"5582958960346",<br /> "display":"55,829.58960346\u00a0BTC",<br /> "currency":"BTC"<br /> },<br /> "last_local":{"value":"5.5594","value_int":"555940","display":"$5.55940","currency":"USD"},<br /> "last_orig":{"value":"5.5594","value_int":"555940","display":"$5.55940","currency":"USD"},<br /> "last":{"value":"5.5594","value_int":"555940","display":"$5.55940","currency":"USD"},<br /> "buy":{"value":"5.53587","value_int":"553587","display":"$5.53587","currency":"USD"},<br /> "sell":{"value":"5.56031","value_int":"556031","display":"$5.56031","currency":"USD"}<br /> }<br /> </source><br /> <br /> note : last_local include only the last trade in the selected currency, last_orig include data of the original last trade ( currency,price in currency . . . ),last can be a conversion of the last trde in another currency<br /> <br /> ==== Multi Currency depth ====<br /> <br /> https://mtgox.com/api/1/BTCPLN/public/depth?raw<br /> <br /> https://mtgox.com/api/1/BTCAUD/public/depth?raw<br /> <br /> ==== Multi currency trades ====<br /> <br /> https://mtgox.com/api/1/BTCPLN/public/trades?raw<br /> <br /> https://mtgox.com/api/1/BTCAUD/public/trades?raw<br /> <br /> to get only the trades since a given trade id, you can add the parameter since=<trade_id><br /> <br /> https://mtgox.com/api/1/BTCUSD/public/trades?since=0<br /> <br /> https://mtgox.com/api/1/BTCEUR/public/trades?since=1316312781670700<br /> <br /> For multi currency,also returns the primary value,"Y" or "N", the primary currency is always the buyers currency<br /> <br /> A trade can appear in more than one currency, to ignore duplicates, use only the trades having primary =Y<br /> <br /> example of returned data : <br /> <source lang="php"><br /> {"date":1316312781,<br /> "price":"3.5599",<br /> "amount":"3.6900096",<br /> "price_int":"355990",<br /> "amount_int":"369000960",<br /> "tid":"1316312781670700",<br /> "price_currency":"EUR",<br /> "item":"BTC",<br /> "trade_type":"bid",<br /> "primary":"Y",<br /> "properties":"limit,mixed_currency"<br /> }<br /> </source><br /> <br /> ==== Cancelled Trades ====<br /> <br /> https://mtgox.com/api/1/BTCUSD/public/cancelledtrades<br /> <br /> returns a list of all the cancelled trades this last month, list of trade ids in json format .<br /> <br /> ==== Full Depth ====<br /> <br /> https://mtgox.com/api/1/BTCUSD/public/fulldepth<br /> <br /> returns full depth<br /> <br /> ==== Private info ====<br /> <br /> https://mtgox.com/api/1/generic/private/info<br /> <br /> returns information about your account, funds, fees, API privileges, withdraw limits . . .<br /> <br /> ==== Your open orders ====<br /> <br /> https://mtgox.com/api/1/generic/private/orders<br /> <br /> returns information about your current open orders<br /> <br /> ==== Submit an order ====<br /> <br /> https://mtgox.com/api/1/BTCUSD/private/order/add<br /> <br /> parameters: <br /> * type (bid|ask)<br /> * amount_int <amount as int><br /> * price_int <price as int> (can be omitted to place market order)<br /> <br /> submits an order and returns info about success or error<br /> <br /> ==== Currency information ====<br /> <br /> https://mtgox.com/api/1/generic/public/currency<br /> <br /> pass parameter ?currency=<currency_symbol><br /> <br /> returns information about a currency ( number of decimals . . . )<br /> <br /> ==== HOTP key ====<br /> <br /> https://mtgox.com/api/1/generic/public/hotp_gen<br /> <br /> used to generate a new HOTP key ( useful for developpers )<br /> <br /> == Streaming API ==<br /> Real time streaming data may be obtained over the streaming API, implemented in [http://socket.io/ Socket.io]<ref>Socket.io forum announcement by MagicalTux: https://bitcointalk.org/index.php?topic=14412.msg613271#msg613271</ref>. The original WebSocket API<ref>Original WebSocket thread: https://bitcointalk.org/index.php?topic=5855.msg86219</ref> is deprecated as of 11-Nov-2011.<br /> <br /> ===Connecting===<br /> The following JavaScript code establishes a connection in the browser:<br /> <source lang="javascript"><br /> <script src="https://socketio.mtgox.com/socket.io/socket.io.js"></script><br /> <script><br /> var conn = io.connect('https://socketio.mtgox.com/mtgox');<br /> conn.on('message', function(data) {<br /> // Handle incoming data object.<br /> });<br /> </script><br /> </source><br /> <br /> The session ID expires after 30 seconds<br /> <br /> ===Handling Events===<br /> Socket.io exposes a simple interface for handling events. Handling <tt>message</tt> events is shown above, but there are other events that may be handled:<br /> <source lang="javascript"><br /> conn.on('connect', onConnect);<br /> conn.on('disconnect', onDisconnect);<br /> conn.on('error', onError);<br /> conn.on('message', onMessage);<br /> </source><br /> <br /> ===Incoming Data===<br /> Data arrives as a full object instead of as JSON text, eliminating the need to parse the data in the JavaScript handler. Messages that come across the socket to trigger the <tt>message</tt> event will contain the following minimum components:<br /> <source lang="javascript"><br /> {<br /> "op":<OPERATION_TYPE><br /> }<br /> </source><br /> <br /> The <tt>OPERATION_TYPE</tt> field may take these values:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! OPERATION_TYPE !! Description<br /> |-<br /> | subscribe || Notification that the user is subscribed to a channel<br /> |-<br /> | unsubscribe || Messages will no longer arrive over the channel<br /> |-<br /> | remark || A server message, usually a warning<br /> |-<br /> | private || The operation for depth, trade, and ticker messages<br /> |}<br /> <br /> ===op:subscribe and op:unsubscribe===<br /> The subscribe and unsubscribe message data are very simple, containing the channel and the operation.<br /> <source lang="javascript"><br /> {<br /> "channel":<CHANNEL_ID>,<br /> "op":"subscribe" OR "unsubscribe"<br /> }<br /> </source><br /> <br /> Some of the channels are:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || Trades<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || Ticker<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || Depth<br /> |}<br /> <br /> ===op:remark===<br /> The remark operation contains message and success fields.<br /> <source lang="javascript"><br /> {<br /> "op":"remark",<br /> "message":<MESSAGE FROM THE SERVER>,<br /> "success":<boolean><br /> }<br /> </source><br /> <br /> ===op:private===<br /> The payloads of the <tt>op:private</tt> messages contain the real time market information. Each message follows this form:<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":<CHANNEL_ID>,<br /> "op":"private",<br /> "private":<MESSAGE_TYPE>,<br /> <MESSAGE_TYPE>:<DATA_PAYLOAD><br /> }<br /> </source><br /> <br /> The <tt>MESSAGE_TYPE</tt> field may take the values:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! MESSAGE_TYPE !! Description<br /> |-<br /> | ticker || Ticker messages<br /> |-<br /> | trade || Trades, as they occur<br /> |-<br /> | depth || Orders placed or removed<br /> |}<br /> <br /> ====Ticker====<br /> Ticker messages contain the current inside Bid and Ask as well as daily highs, lows, and volume. The fields contained in the ticker match those defined in the version 1.0 API above. All fields contain <tt>currency</tt>, <tt>display</tt>, <tt>value</tt>, and <tt>value_int</tt> entries.<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-7ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "avg":{<br /> "currency":"USD",<br /> "display":"$2.26847",<br /> "value":"2.26847",<br /> "value_int":"226847"<br /> },<br /> "buy":{...},<br /> "high":{...},<br /> "last":{..},<br /> "last_local":{...},<br /> "last_orig":{...},<br /> "low":{...},<br /> "sell":{...},<br /> "vol":{<br /> "currency":"BTC",<br /> "display":"118,696.02104208",<br /> "value":"118696.02104208",<br /> "value_int":"11869602104208"<br /> },<br /> "vwap":{...}<br /> }<br /> }<br /> </source><br /> <br /> ====Trade====<br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "primary":"Y",<br /> "properties":"limit, mixed_currency",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "now":"1323644358437819",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "total_volume_int":"849766000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> <br /> |}<br /> <br /> ===Possible outgoing commands===<br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> === examples ===<br /> <br /> ==== ticker ====<br /> javascript, using hookio : <br /> <br /> http://www.youtube.com/watch?v=KD5ljtNK72U<br /> <br /> http://github.com/hookio<br /> <br /> http://github.com/cronopio/hook.io-mtgox<br /> <br /> Another node.js project, using plain websockets (largely based on cronopio's work) :<br /> <br /> https://github.com/dlanod/node-mtgox-websocket-client<br /> <br /> ==== arbitrage ====<br /> https://github.com/goteppo/ArBit<br /> <br /> ==== websocket ====<br /> https://github.com/cronopio/hook.io-ws<br /> <br /> https://github.com/dlanod/node-mtgox-websocket-client<br /> <br /> == References ==<br /> <references></references></div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12783 MtGox/API 2011-07-10T10:31:37Z

<p>Molecular: </p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> ==Number Formats==<br /> <br /> In the "old API", currency- and amount-values (price, volume,...) where given as '''float'''. These values are likely being deprecated and replaced by fields of the same name with "_int" as postfix. These are '''fixed-decimal''', so you have to move the decimal point yourself (divide). The exponent differs based on the kind of the value.<br /> <br /> In order to convert the '''int''' to a '''decimal''' you can...<br /> <br /> {| class="wikitable"<br /> |-<br /> ! kind of field !! ...divide by !! ...multiply by<br /> |-<br /> | BTC (volume, amount) || 1E8 (10,000,000) || 0.00000001<br /> |-<br /> | USD (price) || 1E5 (100,000) || 0.00001<br /> |-<br /> | JPY (price) || 1E3 (1,000) || 0.001<br /> |}<br /> <br /> Implementation advice: it's probably best to use '''int''' or '''Decimal''' (if your language/db offers such a type) in your clients. Using '''float''' will likely lead to nasty rounding problems.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> ported on 7/10/2011 from http://forum.bitcoin.org/index.php?topic=5855.0<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> '''ticker''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> '''order_upd''' cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12782 MtGox/API 2011-07-10T10:30:54Z

<p>Molecular: /* Number Formats */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> ==Number Formats==<br /> <br /> In the "old API", currency- and amount-values (price, volume,...) where given as '''float'''. These values are likely being deprecated and replaced by fields of the same name with "_int" as postfix. These are '''fixed-decimal''', so you have to move the decimal point yourself (divide). The exponent differs based on the kind of the value.<br /> <br /> In order to convert the '''int''' to a '''decimal''' you can...<br /> <br /> {| class="wikitable"<br /> |-<br /> ! kind of field !! ...divide by !! ...multiply by<br /> |-<br /> | BTC (volume, amount) || 1E8 (10,000,000) || 0.00000001<br /> |-<br /> | USD (price) || 1E5 (100,000) || 0.00001<br /> |-<br /> | JPY (price) || 1E3 (1,000) || 0.001<br /> |}<br /> <br /> Implementation advice: it's probably best to use '''int''' or '''Decimal''' (if your language/db offers such a type) in your clients. Using '''float''' will likely lead to nasty rounding problems.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> ported on 7/10/2011 from http://forum.bitcoin.org/index.php?topic=5855.0<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> '''ticker''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> '''order_upd''' cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12780 MtGox/API 2011-07-10T10:22:16Z

<p>Molecular: </p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> ==Number Formats==<br /> <br /> In the "old API", currency- and amount-values (price, volume,...) where given as '''float'''. These values are likely being deprecated and replaced by fields of the same name with "_int" as postfix. These are '''fixed-decimal''', so you have to move the decimal point yourself (divide). The exponent differs based on the kind of the value as follows:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Kind of Field !! divide by !! Smallest possible value<br /> |-<br /> | BTC (volume, amount) || 1E8 (10,000,000) || 0.00000001<br /> |-<br /> | USD (price) || 1E5 (100,000) || 0.00001<br /> |-<br /> | JPY (price) || 1E3 (1,000) || 0.001<br /> |}<br /> <br /> <br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> ported on 7/10/2011 from http://forum.bitcoin.org/index.php?topic=5855.0<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> '''ticker''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> '''order_upd''' cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12779 MtGox/API 2011-07-10T10:18:20Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> ported on 7/10/2011 from http://forum.bitcoin.org/index.php?topic=5855.0<br /> <br /> ===Number Formats===<br /> <br /> In the legacy API, currency- and amount-values (price, volume,...) where given as '''float'''. These values are likely being deprecated and replaced by fields of the same name with "_int" as postfix. These are '''fixed-decimal''', so you have to move the decimal point yourself (divide). The exponent differs based on the kind of the value as follows:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Kind of Field !! divide by !! Smallest possible value<br /> |-<br /> | BTC (volume, amount) || 1E8 (10,000,000) || 0.00000001<br /> |-<br /> | USD (price) || 1E5 (100,000) || 0.00001<br /> |-<br /> | JPY (price) || 1E3 (1,000) || 0.001<br /> |}<br /> <br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> '''ticker''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> '''order_upd''' cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12778 MtGox/API 2011-07-10T10:07:58Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> ported on 7/10/2011 from http://forum.bitcoin.org/index.php?topic=5855.0<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> '''ticker''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> '''order_upd''' cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12777 MtGox/API 2011-07-10T10:06:27Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> '''ticker''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> '''trade''' contains the following:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> '''depth''' contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> '''order_upd''' cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12776 MtGox/API 2011-07-10T10:04:48Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> :The '''ticker''' field contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 1E8<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened (5 decimal for USD, 3 for JPY)<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 1E8<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }</source><br /> <br /> :order_upd cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12775 MtGox/API 2011-07-10T10:00:30Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> <br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> <source lang="javascript"><br /> {<br /> "channel":"d5f06780-30a8-4a48-a2f8-ed181b4a13f",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"ticker",<br /> "ticker":{<br /> "buy":0.9515,<br /> "high":1,<br /> "low":0.91,<br /> "sell":0.9697,<br /> "vol":34349<br /> }<br /> }<br /> </source><br /> <br /> :The '''ticker''' field contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> <br /> <source lang="javascript">{<br /> "channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21",<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"trade",<br /> "trade":{<br /> "amount":2.71,<br /> "amount_int":"271000000",<br /> "date":1310279340,<br /> "item":"BTC",<br /> "price":14.43,<br /> "price_currency":"USD",<br /> "price_int":"1443000",<br /> "tid":"1310279340877902",<br /> "trade_type":"bid",<br /> "type":"trade"<br /> }<br /> }<br /> </source><br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 100000<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> <source lang="javascript">{<br /> "channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe",<br /> "depth":{<br /> "currency":"USD",<br /> "item":"BTC",<br /> "price":"14.43",<br /> "price_int":"1443000",<br /> "type":1,<br /> "type_str":"ask",<br /> "volume":"-2.71",<br /> "volume_int":"-271000000"<br /> },<br /> "op":"private",<br /> "origin":"broadcast",<br /> "private":"depth"<br /> }</source><br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened * 100000<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 100000<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> <source lang="javascript"><br /> {<br /> "channel":"(partial key)",<br /> "op":"private",<br /> "order_upd":{<br /> "amount":1000,<br /> "darkStatus":0,<br /> "date":1302836027,<br /> "oid":"(oid)",<br /> "price":0.9899,"status":1<br /> },<br /> "origin":"broadcast",<br /> "private":"order_upd"<br /> }<br /> <br /> :order_upd cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12771 MtGox/API 2011-07-10T09:43:46Z

<p>Molecular: </p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> ===Connecting===<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ===Channels===<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ===Possible outgoing commands===<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ===Incoming Data===<br /> <br /> ====Ticker====<br /> :{"channel":"d5f06780-30a8-4a48-a2f8-7ed181b4a13f","op":"private","origin":"broadcast","private":"ticker","ticker":"buy":0.9515,"high":1,"low":0.91,"sell":0.9697,"vol":34349}}<br /> <br /> :The '''ticker''' field contains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | buy || lowest bid as float<br /> |-<br /> | sell || highest ask as float<br /> |-<br /> | high || maximum rate since last close as float<br /> |-<br /> | low || minimum rate since last close as float<br /> |-<br /> | vol || traded volume since last close<br /> |}<br /> <br /> ====Trade====<br /> :{"channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21","op":"private","origin":"broadcast","private":"trade","trade":"amount":2.71,"amount_int":"271000000","date":1310279340,"item":"BTC","price":14.43,"price_currency":"USD","price_int":"1443000","tid":"1310279340877902","trade_type":"bid","type":"trade"}}<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 10000<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ====Depth====<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> :{"channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe","depth":{"currency":"USD","item":"BTC","price":"14.43","price_int":"1443000","type":1,"type_str":"ask","volume":"-2.71","volume_int":"-271000000"},"op":"private","origin":"broadcast","private":"depth"}<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened * 10000<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 10000<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> ====Order update (private)====<br /> <br /> :{"channel":"(partial key)","op":"private","order_upd":{"amount":1000,"darkStatus":0,"date":1302836027,"oid":"(oid)","price":0.9899,"status":1},"origin":"broadcast","private":"order_upd"}<br /> <br /> :order_upd cointains the following:<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || change in volume of the order<br /> |-<br /> | darkStatus || <br /> |-<br /> | oid || ID of the affected order<br /> |-<br /> | price || <br /> |-<br /> | status || <br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12770 MtGox/API 2011-07-10T09:33:54Z

<p>Molecular: </p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> ==Connecting==<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ==Channels==<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ==Possible outgoing commands==<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ==Incoming Data==<br /> <br /> ===Ticker===<br /> :{"channel":"d5f06780-30a8-4a48-a2f8-7ed181b4a13f","op":"private","origin":"broadcast","private":"ticker","ticker":"buy":0.9515,"high":1,"low":0.91,"sell":0.9697,"vol":34349}}<br /> <br /> ===Trade===<br /> :{"channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21","op":"private","origin":"broadcast","private":"trade","trade":"amount":2.71,"amount_int":"271000000","date":1310279340,"item":"BTC","price":14.43,"price_currency":"USD","price_int":"1443000","tid":"1310279340877902","trade_type":"bid","type":"trade"}}<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 10000<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> ===Depth===<br /> <br /> Changes to the market depth data are broadcast so an up-to-date market depth can be kept by clients.<br /> <br /> :{"channel":"24e67e0d-1cad-4cc0-9e7a-f8523ef460fe","depth":{"currency":"USD","item":"BTC","price":"14.43","price_int":"1443000","type":1,"type_str":"ask","volume":"-2.71","volume_int":"-271000000"},"op":"private","origin":"broadcast","private":"depth"}<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Header text !! Header text<br /> |-<br /> | currency || the currency affected<br /> |-<br /> | item || the item (BTC)<br /> |-<br /> | price || price as a float, deprecated<br /> |-<br /> | price_int || the price at which volume change happened * 10000<br /> |-<br /> | type || 1=ask, 2=bid. deprecated, use type_str<br /> |-<br /> | type_str || type of order at this depth, either "ask" or "bid"<br /> |-<br /> | volume || the volume change as float, deprecated<br /> |-<br /> | volume_int || volume change * 10000<br /> |-<br /> | || <br /> |-<br /> | || <br /> <br /> |}<br /> <br /> =MOLECULAR EDITING...=</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12769 MtGox/API 2011-07-10T09:26:27Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> ==Connecting==<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> ==Channels==<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}<br /> <br /> Additionally each user has a "own" channel which streams informations about orders (new order, deleted order, etc) and trades only the user's trades).<br /> <br /> Each message is a JSON-encoded object, with at least "op" element. The "op" element contains the operation to be done (for outgoing messages), or the type of message (for incoming messages).<br /> <br /> ==Possible outgoing commands==<br /> <br /> '''unsubscribe''' Stop receiving messages from a channel (parameter "channel")<br /> <br /> ==Incoming Data==<br /> <br /> ===Ticker===<br /> :{"channel":"d5f06780-30a8-4a48-a2f8-7ed181b4a13f","op":"private","origin":"broadcast","private":"ticker","ticker":"buy":0.9515,"high":1,"low":0.91,"sell":0.9697,"vol":34349}}<br /> <br /> ===Trade===<br /> :{"channel":"dbf1dee9-4f2e-4a08-8cb7-748919a71b21","op":"private","origin":"broadcast","private":"trade","trade":"amount":2.71,"amount_int":"271000000","date":1310279340,"item":"BTC","price":14.43,"price_currency":"USD","price_int":"1443000","tid":"1310279340877902","trade_type":"bid","type":"trade"}}<br /> <br /> :{| class="wikitable"<br /> |-<br /> ! Name !! Value<br /> |-<br /> | amount || the traded amount in item (BTC), float, deprecated<br /> |-<br /> | amount_int || the traded amount * 10000<br /> |-<br /> | date || unix timestamp of trade<br /> |-<br /> | item || What was this trade about<br /> |-<br /> | price || price per unit, float, deprecated<br /> |-<br /> | price_int || price in smallest unit as integer (5 decimals of USD, 3 in case of JPY)<br /> |-<br /> | price_currency || currency in which trade was completed<br /> |-<br /> | tid || Trade id (big integer, which is in fact trade timestamp in microseconds)<br /> |-<br /> | trade_type || Did this trade result from the execution of a bid or a ask?<br /> |-<br /> |}<br /> <br /> <br /> =MOLECULAR EDITING...=</div>

Molecular https://en.bitcoin.it/w/index.php?title=MtGox/API&diff=12768 MtGox/API 2011-07-10T09:13:41Z

<p>Molecular: /* Websocket API */</p> <hr /> <div>The [[MtGox]] API provides various methods to access different informations from the market, place orders, and more.<br /> <br /> Two APIs are available at this point: the HTTP api (available by posting to mtgox.com/code/*) and the websocket API.<br /> <br /> == Legacy API ==<br /> This API is available in <nowiki>https://mtgox.com/code/*</nowiki>, and provides various informations. It also supports making an order, a withdraw, a deposit, etc.<br /> <br /> === Authentication ===<br /> Authentication is performed by posting a username and a password in variables "name" and "pass". Some methods do not require authentication.<br /> <br /> === Methods ===<br /> <br /> ==== data/getTrades.php ====<br /> This allows retrieving all trades which happened in the last 24 hours. The returned data is cached and may not reflect latest activity.<br /> <br /> Parameters:<br /> * since: Passing a tid in "since" allows retrieving all trades since that trade. The passed id is may not exist. Ie. to get all trades from the very beginning one would just call https://mtgox.com/code/data/getTrades.php?since=0 . since returns only 100 trades, and you can call the method again by passing the latest trade you have imported in since.<br /> <br /> == Websocket API ==<br /> See: http://forum.bitcoin.org/index.php?topic=5855.0 (will be ported here soon)<br /> <br /> You can connect via: ws://websocket.mtgox.com/mtgox<br /> <br /> The websocket will subscribe you to some channels automatically:<br /> {| class="wikitable"<br /> |-<br /> ! Channel ID !! Description<br /> |-<br /> | dbf1dee9-4f2e-4a08-8cb7-748919a71b21 || trades (each time a trade happens, you get something here)<br /> |-<br /> | d5f06780-30a8-4a48-a2f8-7ed181b4a13f || the mtgox ticker (lots of updates, with often the same data)<br /> |-<br /> | 24e67e0d-1cad-4cc0-9e7a-f8523ef460fe || depth information in realtime (price + amount + type... type=1=Ask, type=2=Bid)<br /> |}</div>

Molecular https://en.bitcoin.it/w/index.php?title=Help:FAQ&diff=8662 Help:FAQ 2011-05-21T22:18:52Z

<p>Molecular: </p> <hr /> <div>Here you will find answers to the most commonly asked questions.<br /> <br /> == General ==<br /> === What are bitcoins? ===<br /> Bitcoins are the unit of currency of the Bitcoin system. A commonly used shorthand for this is “BTC” to refer to a price or amount (eg: “100 BTC”)<br /> A Bitcoin isn't actually a 'thing' you can point at. It is just a number associated with a [[Address|Bitcoin Address]]. See also an [[Introduction|easy intro]] to bitcoin.<br /> <br /> === How can I get Bitcoins? ===<br /> <br /> There are four ways to get Bitcoins:<br /> <br /> * Buy them on an exchange such as [https://www.mtgox.com/ Mt. Gox] or [http://www.bitcoin-otc.com/ #bitcoin-otc] on FreeNode.<br /> * Accept Bitcoins as payment for goods or services.<br /> * Find a local trader on [http://tradebitcoin.com tradebitcoin] (or somewhere else) and trade with him in cash<br /> * Create a new [[block]] (currently yields 50 Bitcoins).<br /> * Participate in a [[Pooled mining|mining pool]].<br /> <br /> === Can I buy Bitcoins with Paypal? ===<br /> <br /> While it's possible to find an individual who wishes to sell Bitcoin to you via Paypal, (perhaps via [http://www.bitcoin-otc.com/ #bitcoin-otc] ) most major exchanges do not allow funding through Paypal. This is due to repeated cases where someone pays for Bitcoins with Paypal, receives their Bitcoins, and then fraudulently complains to Paypal that they never received their goods. Paypal too often sides with the fraudulent buyer in this case, and so exchangers no longer allow this method of funding.<br /> <br /> Buying Bitcoins from individuals with this method is still possible, but requires mutual trust. In this case, Bitcoin seller beware.<br /> <br /> === How are new Bitcoins created? ===<br /> <br /> [[File:total_bitcoins_over_time_graph.png|thumb|Number of bitcoins over time, assuming a perfect 10-minute interval.]]<br /> New coins are generated by a network node each time it finds the solution to a certain mathematical problem (i.e. creates a new [[block]]), which is difficult to perform and can demonstrate a [[proof of work]]. The reward for solving a block is [[controlled inflation|automatically adjusted]] so that in the first 4 years of the Bitcoin network, 10,500,000 BTC will be created. The amount is halved each 4 years, so it will be 5,250,000 over years 4-8, 2,625,000 over years 8-12 and so on. Thus the total number of coins will approach 21,000,000 BTC over time.<br /> <br /> In addition, built into the network is a system that attempts to allocate new coins in blocks about every 10 minutes, on average, somewhere on the network. As the number of people who attempt to generate these new coins changes, the difficulty of creating new coins changes. This happens in a manner that is agreed upon by the network as a whole, based upon the time taken to generate the previous 2016 blocks. The difficulty is therefore related to the average computing resources devoted to generate these new coins over the time it took to create these previous blocks. The likelihood of somebody "discovering" one of these blocks is based on the computer they are using compared to all of the computers also generating blocks on the network.<br /> <br /> === What's the current total number of Bitcoins in existence? ===<br /> <br /> [http://blockexplorer.com/q/totalbc Current count]<br /> <br /> The number of blocks times the coin value of a block is the number of coins in existence. The coin value of a block is 50 BTC for each of the first 210,000 blocks, 25 BTC for the next 210,000 blocks, then 12.5 BTC, 6.25 BTC and so on.<br /> <br /> === How divisible are Bitcoins? ===<br /> <br /> Technically, a Bitcoin can be divided down to 8 decimals using existing data structures, so 0.00000001 BTC is the smallest amount currently possible. Discussions about and ideas for ways to provide for even smaller quantities of Bitcoins may be created in the future if the need for them ever arises.<br /> <br /> === How does the halving work when the number gets really small? ===<br /> <br /> The reward will go from 0.00000001 BTC to 0. Then no more coins will likely be created. <br /> <br /> The calculation is done as a right bitwise shift of a 64-bit signed integer, which means it is divided by 2 and rounded down. The integer is equal to the value in BTC * 100,000,000. This is how all Bitcoin balances/values are stored internally.<br /> <br /> Keep in mind that using current rules this will take nearly 100 years before it becomes an issue and Bitcoins may change considerably before that happens.<br /> <br /> === How long will it take to generate all the coins? ===<br /> <br /> The last block that will generate coins will be block #6,929,999. This should be generated around year 2140. Then the total number of coins in circulation will remain static at 20,999,999.9769 BTC.<br /> <br /> Even if the allowed precision is expanded from the current 8 decimals, the total BTC in circulation will always be slightly below 21 million (assuming everything else stays the same). For example, with 16 decimals of precision, the end total would be 20999999.999999999496 BTC.<br /> <br /> === If no more coins are going to be generated, will more blocks be created? ===<br /> <br /> Absolutely! Even before the creation of coins ends, the use of [[transaction fee|transaction fees]] will likely make creating new blocks more valuable from the fees than the new coins being created. When coin generation ends, what will sustain the ability to use bitcoins will be these fees entirely. There will be blocks generated after block #6,929,999, assuming that people are still using Bitcoins at that time.<br /> <br /> === But if no more coins are generated, what happens when Bitcoins are lost? Won't that be a problem? ===<br /> <br /> Not at all. Because of the law of supply and demand, when fewer Bitcoins are available the ones that are left will be in higher demand, and therefore will have a higher value. So when Bitcoins are lost, the remaining Bitcoins will increase in value to compensate. As the value of Bitcoins increase, the number of Bitcoins required to purchase an item '''de'''creases. This is known as a [[Deflationary spiral|deflationary economic model]]. Eventually, if and when it gets to the point where the largest transaction is less that 1BTC, then it's a simple matter of shifting the decimal place to the right a few places, and the system continues.<br /> <br /> === If every transaction is broadcast via the network, does BitCoin scale? ===<br /> The Bitcoin protocol allows lightweight clients that can use Bitcoin without downloading the entire transaction history. As traffic grows and this becomes more critical, implementations of the concept will be developed. Full network nodes will at some point become a more specialized service.<br /> <br /> With some modifications to the software, full BitCoin nodes could easily keep up with both VISA and MasterCard combined, using only fairly modest hardware (a couple of racks of machines using todays hardware). It's worth noting that the MasterCard network is structured somewhat like BitCoin itself - as a peer to peer broadcast network.<br /> <br /> Learn more about [[Scalability]].<br /> <br /> === Why do I have to wait 10 minutes before I can spend money I received? ===<br /> <br /> The reason you have to wait 10 minutes is that's the average time taken to find a block. It can be significantly more or less time than that depending on luck, 10 minutes is simply the average case. <br /> <br /> Blocks (shown as "confirmations" in the GUI) are how the BitCoin achieves consensus on who owns what. Once a block is found everyone agrees that you now own those coins, so you can spend them again. Until then it's possible that some network nodes believe otherwise, if somebody is attempting to defraud the system by reversing a transaction. The more confirmations a transaction has, the less risk there is of a reversal. Only 6 blocks or 1 hour is enough to make reversal computationally impractical. This is dramatically better than credit cards which can see chargebacks occur up to three months after the original transaction!<br /> <br /> Why ten minutes specifically? It is a tradeoff chosen by Satoshi between propagation time of new blocks in large networks and the amount of work wasted due to chain splits. If that made no sense to you, don't worry. Reading [http://www.bitcoin.org/bitcoin.pdf the technical paper] should make things clearer.<br /> <br /> === Do you have to wait 10 minutes in order to buy or sell things with BitCoin? ===<br /> <br /> No, it's reasonable to sell things without waiting for a confirmation as long as the transaction is not of high value.<br /> <br /> When people ask this question they are usually thinking about applications like supermarkets or snack machines, as discussed in [http://www.bitcoin.org/smf/index.php?topic=423.msg3819#msg3819 this thread from July 2010]. Zero confirmation transactions still show up in the GUI, but you cannot spend them. You can however reason about the risk involved in assuming you ''will'' be able to spend them in future. In general, selling things that are fairly cheap (like snacks, digital downloads etc) for zero confirmations will not pose a problem if you are running a well connected node.<br /> <br /> === Why does my Bitcoin address keep changing? ===<br /> <br /> Whenever the address listed in "Your address" receives a transaction, Bitcoin replaces it with a new address. This is meant to encourage you to use a new address for every transaction, which enhances [[anonymity]]. All of your old addresses are still usable: you can see them in ''Settings -> Your Receiving Addresses''.<br /> <br /> ==Economy==<br /> === Where does the value of Bitcoin stem from? What backs up Bitcoin? ===<br /> Bitcoins have value because they are accepted as payment by many. See the [[Trade|list of Bitcoin-accepting sites]].<br /> <br /> When we say that a currency is backed up by gold, we mean that there's a promise in place that you can exchange the currency for gold. In a sense, you could say that Bitcoin is "backed up" by the price tags of merchants – a price tag is a promise to exchange goods for a specified amount of currency.<br /> <br /> It's a common misconception that Bitcoins gain their value from the cost of electricity required to generate them. Cost doesn't equal value – hiring 1,000 men to shovel a big hole in the ground may be costly, but not valuable. Also, even though scarcity is a critical requirement for a useful currency, it alone doesn't make anything valuable. For example, your fingerprints are scarce, but that doesn't mean they have any exchange value.<br /> <br /> === What if someone bought up all the existing Bitcoins? ===<br /> What if somebody bought up all the gold in the world? Well, by attempting to buy it all, the buyer would just drive the prices up until he runs out of money.<br /> <br /> Not all Bitcoins are for sale. Just as with gold, no one can buy a Bitcoin that isn't available for sale.<br /> <br /> === Bitcoin's monetary policy causes a deflationary spiral ===<br /> See the article [[Deflationary spiral]].<br /> <br /> ==Networking==<br /> === Do I need to configure my firewall to run bitcoin? ===<br /> <br /> Bitcoin will connect to other nodes, usually on tcp port 8333. You will need to allow outgoing TCP connections to port 8333 if you want to allow your bitcoin client to connect to many nodes. Bitcoin will also try to connect to IRC (tcp port 6667) to meet other nodes to connect to.<br /> <br /> If you want to restrict your firewall rules to a few ips and/or don't want to allow IRC connection, you can find stable nodes in the [[Fallback Nodes|fallback nodes list]]. If your provider blocks the common IRC ports, note that lfnet also listens on port 7777. Connecting to this alternate port currently requires either recompiling Bitcoin, or changing routing rules. For example, on Linux you can evade a port 6667 block by doing something like this:<br /> <br /> echo 173.246.103.92 irc.lfnet.org >> /etc/hosts<br /> iptables -t nat -A OUTPUT -p tcp --dest 173.246.103.92 --dport 6667 -j DNAT --to-destination :7777 -m comment --comment "bitcoind irc connection"<br /> <br /> <br /> === How does the peer finding mechanism work? ===<br /> Bitcoin finds peers primarily by connecting to an IRC server (channel #bitcoin on irc.lfnet.org). If a connection to the IRC server cannot be established (like when connecting through TOR), an in-built node list will be used and the nodes will be queried for more node addresses.<br /> <br /> ==Mining==<br /> ===What is mining?===<br /> Mining is the process of spending computation power to find valid blocks and thus create new Bitcoins.<br /> <br /> ===I've been mining for a long time and haven't created any new Bitcoins. What's wrong?===<br /> <br /> In the early days of Bitcoin, it was easy for anyone to find new blocks using standard CPUs. As more and more people started mining, the [[difficulty]] of finding new blocks has greatly increased to the point where the average time for a CPU to find a single block can be many years. The only cost- or time-effective method of mining is using a high-end graphics card with special software. See here for an explanation of why: [[Why_a_GPU_mines_faster_than_a_CPU]]. Since CPU mining is essentially useless, it may be removed from new versions of the Bitcoin software.<br /> <br /> ===Is mining used for some useful computation?===<br /> The computations done when mining are internal to Bitcoin and not related to any other distributed computing projects. They serve the purpose of securing the Bitcoin network, which is useful.<br /> <br /> ===Is it not a waste of energy?===<br /> Spending energy on creating a free monetary system is hardly a waste. Also, services necessary for the operation of currently widespread monetary systems, such as banks and credit card companies, also spend energy, arguably more than Bitcoin would.<br /> <br /> ===Why don't we use calculations that are also useful for some other purpose?===<br /> To provide security for the Bitcoin network, the calculations involved need to have some very specific features. These features are incompatible with leveraging the computation for other purposes.<br /> <br /> ==Help==<br /> ===I'd like to learn more. Where can I get help?===<br /> <br /> * Read the [[Introduction|introduction to bitcoin]] <br /> * See the videos, podcasts, and blog posts from the [[Press]]<br /> * Read and post on the [[Bitcoin:Community_portal#Bitcoin_Community_Forums|forums]]<br /> * Chat on one of the [[Bitcoin:Community_portal#IRC_Chat|Bitcoin IRC]] channels<br /> * Listen to [http://omegataupodcast.net/2011/03/59-bitcoin-a-digital-decentralized-currency/ this podcast], which goes into the details of how bitcoin works<br /> <br /> ==See Also==<br /> <br /> * [[Man page]]<br /> * [[Introduction]]<br /> <br /> [[zh-cn:FAQ]]<br /> [[fr:FAQ]]<br /> {{fromold|bitcoins}}<br /> <br /> [[Category:Technical]]<br /> [[Category:Vocabulary]]</div>

Molecular https://en.bitcoin.it/w/index.php?title=Talk:Merchant_Howto&diff=8501 Talk:Merchant Howto 2011-05-18T07:55:46Z

<p>Molecular: Created page with "I think most merchant will want to also also automatically adjust their prices according to BTC market value. Has anyone here done this? It doesn't seem too hard to pull the rat..."</p> <hr /> <div>I think most merchant will want to also also automatically adjust their prices according to BTC market value.<br /> <br /> Has anyone here done this? It doesn't seem too hard to pull the rate from mtgox at a certain depth or something, but I'd hate to describe something I've never done myself.<br /> <br /> Also, I this is lacking any mention of mybitcoin and mtgox merchant apis.<br /> <br /> So please, can someone help? Making it easier for merchants to use bitcoin is important.</div>

Molecular