Bitbegin provides a simple and powerful REST API to allow you to programmatically perform nearly all actions you can from our web interface. All requests use the application/json content type and go over https. The base url is https://ifx24.com/api. All requests are GET requests and all responses come in a default response object with the result in the result field. Always check the success flag to ensure that your API call succeeded.
Used to get the open and available trading markets at Bitbegin along with other meta data.
None
https://ifx24.com/api/getmarkets
{
"success" : true,
"message" : "",
"result" : [ {
"MarketCurrency" : "BTC",
"BaseCurrency" : "NGN",
"MarketCurrencyLong" : "NAIRA",
"BaseCurrencyLong" : "BITCOIN",
"MinTradeSize" : null,
"MarketName" : "BTC_NGN",
"IsActive" : true,
"Created" : "2018-09-10 17:45:47.0"
}, {
"MarketCurrency" : "BINS",
"BaseCurrency" : "NGN",
"MarketCurrencyLong" : "BITSENSE",
"BaseCurrencyLong" : "NAIRA",
"MinTradeSize" : null,
"MarketName" : "BINS_NGN",
"IsActive" : true,
"Created" : "2018-09-10 17:44:39.0"
}]
}
Used to get the last 24 hour summary of all active markets.
None
https://ifx24.com/api/getmarketsummaries
{
"success" : true,
"message" : "",
"result" : [ {
"MarketName" : "BINS_ETH",
"High" : 0.00033368,
"Low" : 0.00023368,
"Volume" : 1279.010091,
"Last" : 0.00033368,
"BaseVolume" : 0.42678009,
"OpenOrders" : 24,
}, {
"MarketName" : "BINS_BTC",
"High" : 0.00033368,
"Low" : 0.00023368,
"Volume" : 1279.010091,
"Last" : 0.00033368,
"BaseVolume" : 0.42678009,
"OpenOrders" : 13,
}]
}
This allows you to place a buy order in a specific market. Make sure to specify a valid API key for this call to work.
https://ifx24.com/api/market/buy?apikey=API_KEY&market;=BINS_ETH&quantity;=1.2&rate;=1.3
{
"success" : true,
"message" : "",
"result" : {
"uuid" : "38493393",
}
}
This allows you to place a buy order in a specific market. Make sure to specify a valid API key for this call to work.
https://ifx24.com/api/market/sell?apikey=API_KEY&market;=BINS_ETH&quantity;=1.2&rate;=1.3
{
"success" : true,
"message" : "",
"result" : {
"uuid" : "38493393",
}
}
Get all orders that you currently have opened in a specific market.
https://ifx24.com/api/market/getopenorders?apikey=API_KEY&market;=BINS_ETH
{
"success" : true,
"message" : "",
"result" : [ {
"OrderUuid" : 398482929
"Exchange" : "BINS_ETH",
"OrderType" : "SELL",
"Quantity" : 4.00033368,
"QuantityRemaining" : 4.00033368,
"Price" : 0.00033368,
"Created" : "2018-09-10 17:45:47.0"
}, {
"OrderUuid" : 398482929
"Exchange" : "BINS_ETH",
"OrderType" : "BUY",
"Quantity" : 4.00033368,
"QuantityRemaining" : 4.00033368,
"Price" : 0.00033368,
"Created" : "2018-09-10 17:45:47.0"
}]
}
Used to retrieve all balances from your account.
None
https://ifx24.com/api/account/getbalances?apikey=API_KEY
{
"success" : true,
"message" : "",
"result" : [ {
"Currency" : "BINS"
"Balance" : 4.00033368,
"Available" : 4.00033368
}, {
"Currency" : "ETH"
"Balance" : 0.20000000,
"Available" : 0.20000000
}]
}
Used to retrieve the balance from your account for a specific currency.
https://ifx24.com/api/account/getbalance?apikey=API_KEY&symbol;=BINS
{
"success" : true,
"message" : "",
"result" : {
"Currency" : "BINS",
"Balance" : 2.21549076,
"Available" : 2.21549076,
}
}
Used to retrieve or generate an address for a specific symbol.
https://ifx24.com/api/account/getdepositaddress?apikey=API_KEY&symbol;=BINS
{
"success" : true,
"message" : "",
"result" : {
"Currency" : "BINS",
"Address" : "0x8085FECd052a75C305bb1Be3dE70acC9b82a5d64"
}
}
Used to withdraw funds from your account. Note: please account for txfee.
https://ifx24.com/api/account/withdraw?apikey=API_KEY&symbol;=BINS&quantity;=20.40&address;=EAC_ADDRESS
{
"success" : true,
"message" : "",
"result" : {
"uuid" : 398482929
}
}
Used to retrieve a single order by uuid.
https://ifx24.com/api/account/getorder?apikey=API_KEY&uuid;=398482929
{
"success" : true,
"message" : "",
"result" : {
"OrderUuid" : 398482929
"Exchange" : "BINS_ETH",
"OrderType" : "BUY",
"Quantity" : 4.00033368,
"QuantityRemaining" : 4.00033368,
"Price" : 0.00033368,
"Created" : "2018-09-10 17:45:47.0"
}
}
Used to retrieve your order history.
None
https://ifx24.com/api/account/getorderhistory?apikey=API_KEY
{
"success" : true,
"message" : "",
"result" : [ {
"OrderUuid" : 398482929
"Exchange" : "BINS_ETH",
"OrderType" : "SELL",
"Quantity" : 4.00033368,
"QuantityRemaining" : 4.00033368,
"Price" : 0.00033368,
"Created" : "2018-09-10 17:45:47.0"
}, {
"OrderUuid" : 398482929
"Exchange" : "ETH_BTC",
"OrderType" : "BUY",
"Quantity" : 4.00033368,
"QuantityRemaining" : 4.00033368,
"Price" : 0.00033368,
"Created" : "2018-09-10 17:45:47.0"
}]
}
Used to retrieve your withdrawal history.
https://ifx24.com/api/account/getwithdrawalhistory?symbol=BTC
{
"success" : true,
"message" : "",
"result" : [ {
"PaymentUuid" : 398482929
"Currency" : "BTC",
"Amount" : 34.78430000,
"Address" : "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
"Date" : ""2014-07-09T04:24:47.217"",
"Authorized" : true,
"TxCost" : 0.00020000,
"TxId" : "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e"
}, {
"PaymentUuid" : 398482929
"Currency" : "BTC",
"Amount" : 34.78430000,
"Address" : "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
"Date" : ""2014-07-09T04:24:47.217"",
"Authorized" : true,
"TxCost" : 0.00020000,
"TxId" : "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e"
}]
}
Used to retrieve your deposit history.
https://ifx24.com/api/account/getdeposithistory?symbol=BTC
{
"success" : true,
"message" : "",
"result" : [ {
"PaymentUuid" : 398482929
"Currency" : "BTC",
"Amount" : 34.78430000,
"Address" : "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
"Date" : ""2014-07-09T04:24:47.217"",
"Authorized" : true,
"TxId" : "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e"
}, {
"PaymentUuid" : 398482929
"Currency" : "BTC",
"Amount" : 34.78430000,
"Address" : "1DeaaFBdbB5nrHj87x3NHS4onvw1GPNyAu",
"Date" : ""2014-07-09T04:24:47.217"",
"Authorized" : true,
"TxId" : "b4a575c2a71c7e56d02ab8e26bb1ef0a2f6cf2094f6ca2116476a569c1e84f6e"
}]
}