MtGox/API: Difference between revisions
MagicalTux (talk | contribs) about websocket API |
MagicalTux (talk | contribs) No edit summary |
||
| (149 intermediate revisions by 20 users not shown) | |||
| Line 1: | Line 1: | ||
The [[MtGox]] API provides | The [[MtGox]] API provides methods to access information from the market, place orders, and more. | ||
Two APIs are available | Two APIs are currently available: | ||
* [[MtGox/API/HTTP|HTTP API]] | |||
* [[MtGox/API/Pubnub|Streaming Pubnub API]] | |||
* [[MtGox/API/Streaming|Streaming websocket API]] | |||
__TOC__ | |||
== | ==Number Formats== | ||
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. | |||
In order to convert the '''int''' to a '''decimal''' you can... | |||
== | {| class="wikitable" | ||
See: http:// | |- | ||
! kind of field !! ...divide by !! ...multiply by | |||
|- | |||
| BTC (volume, amount) || 1E8 (100,000,000) || 0.00000001 | |||
|- | |||
| USD, AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, NZD, PLN, RUB, SGD, THB, NOK, CZK (price) || 1E5 (100,000) || 0.00001 | |||
|- | |||
| JPY, SEK (price) || 1E3 (1,000) || 0.001 | |||
|} | |||
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. | |||
== Currency Symbols == | |||
List of the currency symbols available with the API: | |||
USD, AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, JPY, NZD, PLN, RUB, SEK, SGD, THB, NOK, CZK | |||
==Date and time== | |||
Most dates you will find in mtgox API are UNIX time | |||
See http://en.wikipedia.org/wiki/Unix_time | |||
Most programming languages should have tools for managing those timestamps | |||
==See Also== | |||
* [http://bitcointalk.org/index.php?topic=164404.0 MtGox API version 2: Unofficial Documentation] | |||
Latest revision as of 04:19, 15 November 2013
The MtGox API provides methods to access information from the market, place orders, and more.
Two APIs are currently available:
Number Formats
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.
In order to convert the int to a decimal you can...
| kind of field | ...divide by | ...multiply by |
|---|---|---|
| BTC (volume, amount) | 1E8 (100,000,000) | 0.00000001 |
| USD, AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, NZD, PLN, RUB, SGD, THB, NOK, CZK (price) | 1E5 (100,000) | 0.00001 |
| JPY, SEK (price) | 1E3 (1,000) | 0.001 |
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.
Currency Symbols
List of the currency symbols available with the API:
USD, AUD, CAD, CHF, CNY, DKK, EUR, GBP, HKD, JPY, NZD, PLN, RUB, SEK, SGD, THB, NOK, CZK
Date and time
Most dates you will find in mtgox API are UNIX time
See http://en.wikipedia.org/wiki/Unix_time
Most programming languages should have tools for managing those timestamps