API docs by Redocly

Bitfox API (1.0.0)

Download OpenAPI specification:Download

Bitfox Support: team.cryptoworx@gmail.com URL: https://github.com/benjamin-keil-crypto-worx/bitfox/issuest License: ISC

This Api allows users to connect and leverage basic Bitfox Engine functionality

Bitfox API User Guide

ping

Ping the server to see if it online/offline.

Allows User to ping the Bitfox Engine Server

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "message": "pong",
  • "code": 200,
  • "success": true
}

health

Simple Health check

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "message": "Server running at : http://localhost port : 8080",
  • "endpoints": {
    },
  • "code": 200,
  • "success": true
}

getballance

Returns available ballance on target exchange

Authorizations:
ApiKey

ticker

Returns the current Ticker information of selected Currency Pair

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "symbol": "ADA/USDT",
  • "high": 0.367,
  • "low": 0.3559,
  • "bid": 0.3639,
  • "bidVolume": 26047.15,
  • "ask": 0.364,
  • "askVolume": 10967.3,
  • "vwap": 0.3621253386584188,
  • "open": 0.3578,
  • "close": 0.364,
  • "last": 0.364,
  • "change": 0.0062,
  • "percentage": 1.73,
  • "average": 0.3609,
  • "baseVolume": 6458978.66,
  • "quoteVolume": 2338959.83464,
  • "info": {
    }
}

orderbook

Returns the Current Order Book for a given Currency Pair

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "symbol": "ADAUSDT",
  • "bids": [
    ],
  • "asks": [
    ],
  • "timestamp": 1685958329885,
  • "datetime": "2023-06-05T09:45:29.885Z"
}

candles

Returns Historical Candle data from exchange for given trading pair

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
[
  • [
    ],
  • [
    ]
]

buy

Execute a Market buy order

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "id": "50001",
  • "datetime": "2023-05-27T09:53:20.393Z",
  • "timestamp": 1685181200393,
  • "lastTradeTimestamp": 1685181200393,
  • "status": "open",
  • "symbol": "ADAUSDT",
  • "type": "market",
  • "timeInForce": "GTC",
  • "side": "buy",
  • "price": { },
  • "average": { },
  • "amount": 20
}

sell

Execute a market Sell order

Authorizations:
ApiKey

Responses

Response samples

Content type
{
  • "id": "50001",
  • "datetime": "2023-05-27T09:53:54.588Z",
  • "timestamp": 1685181234588,
  • "lastTradeTimestamp": 1685181234588,
  • "status": "open",
  • "symbol": "ADAUSDT",
  • "type": "market",
  • "timeInForce": "GTC",
  • "side": "sell",
  • "price": { },
  • "average": { },
  • "amount": 20
}

shutdown

Emergency Shut Down

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "message": "Shutting Down Server",
  • "code": 200
}