Developer's Guide - API

Bitbegin Tech Support
Any inquires
Contact us:


Overview

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://bitbegin.io/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.


Public API

Used to get the open and available trading markets at Bitbegin along with other meta data.

Parameters

None

Request
https://bitbegin.io/api/getmarkets

Response
     
{
 "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 current tick values for a market.

Parameters
market
required
a string literal for the market (ex: BINS_ETH)

Request
https://bitbegin.io/api/getticker

Response
     
{
 "success" : true,
 "message" : "",
 "result" : {
	
		"Ask" : 0.00050001,
		"Bid" : 0.00033368,
		"Last" : 0.00033368
	}
} 

Used to get the last 24 hour summary of all active markets.

Parameters

None

Request
https://bitbegin.io/api/getmarketsummaries

Response
     
{
 "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,
		
	}]
}