Public API

Public API

Note: In API "Label" like BTC_FSC where BTC is currency and FSC is market respectively.

Get Currencies

To return all currency data

Parameters

Currency (Optional to get single currency data)

Request

GET https://fivestarexchange.in/public/get-currencies
GET https://fivestarexchange.in/public/get-currencies/btc
GET https://fivestarexchange.in/public/get-currencies/1
OR
GET https://fivestarexchange.in/cmc/asset
Note:

btc is symbol & 1 is Id in Response.

Response

{
"Status":1,
"Message":"Success",
"Data":[{
"Id":"1",
"Name":"Bitcoin",
"Symbol":"BTC",
"MinDeposit":"0.0016",
"WithdrawFee":"0.0005",
"MinWithdraw":"0.00050001",
"ListingStatus":"Acitve"
},
{
...
}]
}

Get Trade Pairs

To return all Trade Pair

Parameters

Currency & base currency both are optional

Request

GET https://fivestarexchange.in/public/get-trade-pair
GET https://fivestarexchange.in/public/get-trade-pair/fsc
GET https://fivestarexchange.in/public/get-trade-pair/5
GET https://fivestarexchange.in/public/get-trade-pair/fsc/btc
GET https://fivestarexchange.in/public/get-trade-pair/5/2
OR
GET https://fivestarexchange.in/cmc/trades/btc_fsc
Note:

fsc is symbol & 5 is Id in above get-currencies api.

btc is base symbol & 2 is Id in response bellow.

Response

{
"Status":1,
"Message":"Success",
"Data":[{
"Id":"2",
"Name":"Five Star Coin",
"Symbol":"FSC",
"BaseSymbol":"BTC",
"Label":"BTC_FSC",
"MinimumTrade":"0.0002",
"TradeFee":"0.2%",
"Status":"Acitve"
},
{
...
}]
}

Get market history

To return all market history data

Parameters

Base Currency is required.

Currency & limit (Record limit) both are optional

Request

GET https://fivestarexchange.in/public/get-market-history/fsc
GET https://fivestarexchange.in/public/get-market-history/1
GET https://fivestarexchange.in/public/get-market-history/fsc/btc
GET https://fivestarexchange.in/public/get-market-history/1/1
GET https://fivestarexchange.in/public/get-market-history/fsc/btc/50
GET https://fivestarexchange.in/public/get-market-history/fsc/1/50
Note:

fsc is symbol & 1 is Id in get-trade-pair api.

btc is base symbol & 1 is Id in get-currencies api.

50 is record limit.

Response

{
"Status":1,
"Message":"Success",
"Data":[{
"Timestamp":"1545428992.586780",
"Label":"FSC_BTC",
"Type":"Sell",
"Price":"300000.00000000",
"Amount":"0.50000000",
"Total":"150000.00000000",
},
{
...
}]
}

Order Book

To return order book.

Parameters

Request

GET https://fivestarexchange.in/cmc/orderbook/fsc_btc

Response

{
"Status":1,
"Message":"Success",
"Data":{
"FSC_BTC":{
"Ask":[
["0.00000300" , "178.28000000"],
...
["0.00000400" , "500.00000000"]
],
"Bid":[
["0.00000030" , "1500.00000000,
...
["0.00000029" , "2500.00000000"]
],
}
}

Ticker

To return ticker last 24 hours.

Parameters

Currency & Base Currency both are optional.

Request

GET https://fivestarexchange.in/public/ticker
GET https://fivestarexchange.in/public/ticker/fsc/
GET https://fivestarexchange.in/public/ticker/5/
GET https://fivestarexchange.in/public/ticker/fsc/btc
GET https://fivestarexchange.in/public/ticker/1/1
OR
GET https://fivestarexchange.in/cmc/ticker
OR
GET https://fivestarexchange.in/cmc/summary
Note:

fsc is symbol & 1 is Id in get-currencies api.

btc is base symbol & 1 is Id in get-trade-pair api.

Response

{
"Status":1,
"Message":"Success",
"Data":{
"BTC_FSC":{
"ID":"5",
"last":"0.00000265",
"lowestAskBid":"0.00000265",
"highestBid":"0.00000251",
"percentChange":"0.00",
"baseVolume":"0.00182320",
"quoteVolume":"688.00000000",
"isFrozen":"0",
"high24hr":"0.00000251",
"low24hr":"0.00000251",
},
"BTC_BAT":{
...
}
}