Documentation Powered by ReDoc

Birake Network API (v6)

Download OpenAPI specification:Download

Available Public and Private calls are described below

Authentication

AUTH_KEY

Value for the AUTH-KEY header parameter.

Security Scheme Type API Key
Header parameter name: AUTH-KEY

Public

Retrieves a Assets resource.

symbol: example BIR or SAPP or BTC or any available symbols

Authorizations:
AUTH_KEY
path Parameters
symbol
required
string

Resource identifier

Responses

Response samples

Content type
application/json
application/json
text/html
{
  • "id": 0,
  • "name": "string",
  • "decimals": 0,
  • "coininfo": "string",
  • "walletEnabled": true,
  • "symbol": "string"
}

Retrieves the collection of Assets resources.

Retrieves the collection of Assets resources.

Authorizations:
AUTH_KEY

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves a Markets resource.

market: example BIR_BTC or SAPP_BTC or LTC_BTC or any available markets

Authorizations:
AUTH_KEY
path Parameters
market
required
string

Resource identifier

Responses

Response samples

Content type
application/json
application/json
text/html
{
  • "id": 0,
  • "market": "string",
  • "quote": "string",
  • "base": "string",
  • "tickSize": 0,
  • "minPrice": 0,
  • "minVolume": 0
}

Retrieves the collection of Markets resources.

Retrieves the collection of Markets resources.

Authorizations:
AUTH_KEY

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves the collection of OrderBook resources.

Retrieves the collection of OrderBook resources.

Authorizations:
AUTH_KEY
query Parameters
market
required
string

Please specify the market (example BIR_BTC, SAPP_BTC )

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves a Ticker resource.

Retrieves a Ticker resource.

Authorizations:
AUTH_KEY
path Parameters
market
required
string

Resource identifier

Responses

Response samples

Content type
application/json
application/json
text/html
{
  • "id": 0,
  • "lastUpdateTimestamp": "string",
  • "market": "string",
  • "lastPrice": 0,
  • "lowestAsk": 0,
  • "highestBid": 0,
  • "tradingUrl": "string",
  • "baseVolume24h": 0,
  • "quoteVolume24h": 0
}

Retrieves the collection of Ticker resources.

Retrieves the collection of Ticker resources.

Authorizations:
AUTH_KEY

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves the collection of TradeHistory resources.

Retrieves the collection of TradeHistory resources.

Authorizations:
AUTH_KEY
query Parameters
market
required
string

Please specify the market (example BIR_BTC, SAPP_BTC )

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

AUTH key

AUTH-KEY header is needed for below Private calls

Authorizations:
AUTH_KEY
Request Body schema: application/json

Please enter your username and password from the trading platform. This API key will be encrypted with your secret string. If you want to invalidate the previous API key just do another call with a different secret string

username
string
password
string
secret
string

Responses

Request samples

Content type
application/json
{
  • "username": "YOUR_TRADING_PLATFORM_USERNAME",
  • "password": "YOUR_TRADING_PLATFORM_PASSWORD",
  • "secret": "zCjYLyh7I5"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Private

Retrieves a Balance resource.

Retrieves a Balance resource.

Authorizations:
AUTH_KEY
path Parameters
symbol
required
string

Resource identifier

Responses

Response samples

Content type
application/json
application/json
text/html
{
  • "symbol": "string",
  • "free": 0,
  • "used": 0,
  • "total": 0
}

Retrieves the collection of Balance resources.

Retrieves the collection of Balance resources.

Authorizations:
AUTH_KEY

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves a Deposits resource.

Retrieves a Deposits resource.

Authorizations:
AUTH_KEY
path Parameters
symbol
required
string

Resource identifier

Responses

Response samples

Content type
application/json
application/json
text/html
{
  • "address": "string"
}

Retrieves the collection of Deposits resources.

Retrieves the collection of Deposits resources.

Authorizations:
AUTH_KEY

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves the collection of LimitOrders resources.

Retrieves the collection of LimitOrders resources.

Authorizations:
AUTH_KEY
query Parameters
market
required
string

Please specify the market (example BIR_BTC, SAPP_BTC )

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves the collection of MyFilledOrders resources.

Retrieves the collection of MyFilledOrders resources.

Authorizations:
AUTH_KEY
query Parameters
market
required
string

Please specify the market (example BIR_BTC, SAPP_BTC )

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves the collection of MyOpenOrders resources.

Retrieves the collection of MyOpenOrders resources.

Authorizations:
AUTH_KEY
query Parameters
market
required
string

Please specify the market (example BIR_BTC, SAPP_BTC )

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]

Retrieves a Order resource.

Retrieves a Order resource.

Authorizations:
AUTH_KEY
path Parameters
orderId
required
string

Resource identifier

Responses

Response samples

Content type
application/json
application/json
text/html
{
  • "id": "string",
  • "amount": 0,
  • "filled": 0,
  • "remaining": 0,
  • "side": "string",
  • "price": 0,
  • "status": "string",
  • "market": "string"
}

Submit a new order

market: example BIR_BTC or any available markets
type: buy or sell
price: price for selling or buying
amount: amount for selling or buying

Authorizations:
AUTH_KEY
Request Body schema: application/json
market
string
type
string
price
float
amount
float

Responses

Request samples

Content type
application/json
{
  • "market": "BIR_BTC",
  • "type": "buy",
  • "price": 0.0000015,
  • "amount": 1
}

Response samples

Content type
application/json
application/json
text/html
{
  • "id": "string"
}

Cancel order by orderId

Replaces the Order resource.

Authorizations:
AUTH_KEY
path Parameters
orderId
required
string

Resource identifier

Request Body schema:
application/json
application/json
text/html

The updated Order resource

object (Order-write_put)

Responses

Request samples

Content type
application/json
application/json
text/html
{ }

Response samples

Content type
application/json
application/json
text/html
{
  • "id": "string",
  • "canceled": 0
}

Retrieves the collection of Withdrawals resources.

Retrieves the collection of Withdrawals resources.

Authorizations:
AUTH_KEY

Responses

Response samples

Content type
application/json
application/json
text/html
[
  • {
    }
]
Available formats: json html
Other API docs: Swagger UI GraphiQL