Blocktane User API v2 (2.4.0)

Download OpenAPI specification:Download

API for Blocktane.

Authentication

Key

Authenticated routes (.../xt/account/* and .../xt/market/*) may require the headers: X-Auth-Apikey, X-Auth-Nonce, X-Auth-Signature

Security Scheme Type API Key
Header parameter name: X-Auth-Apikey

public

Operations about publics

postPublicWebhooksEvent

Bitgo Transfer Webhook

path Parameters
event
required
string
Enum: "deposit" "withdraw"

Name of event can be deposit or withdraw

Request Body schema: application/x-www-form-urlencoded
type
required
string

Type of event.

hash
required
string

Transfer txid.

transfer
required
string

Transfer id.

coin
required
string

Currency code.

wallet
required
string

Wallet id.

Responses

201

Bitgo Transfer Webhook

post /xt/public/webhooks/{event}
https://trade.blocktane.io/api/v2/xt/public/webhooks/{event}

getPublicTradingFees

Returns trading_fees table as paginated collection

query Parameters
group
string

Member group for define maker/taker fee.

market_id
string
Enum: "btcbrl" "ethbrl" "ltcbrl" "bchbrl" "paxbrl" "xrpbrl" "xlmbrl" "eursbrl" "dashbrl" "paxgbrl" "ethbtc" "btceurs" "btcpax" "bchpax" "ltcpax" "xlmpax" "paxgpax" "btcusd" "ethusd" "bchusd" "ltcusd" "xrpusd" "any"

Market id for define maker/taker fee.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Limit the number of returned paginations. Defaults to 100.

page
integer <int32>
Default: 1

Specify the page of paginated results.

ordering
string
Default: "asc"
Enum: "asc" "desc"

If set, returned values will be sorted in specific order, defaults to 'asc'.

order_by
string
Default: "id"

Name of the field, which result will be ordered by.

Responses

200

Returns trading_fees table as paginated collection

get /xt/public/trading_fees
https://trade.blocktane.io/api/v2/xt/public/trading_fees

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

getPublicHealthReady

Get application readiness status

Responses

200

Get application readiness status

get /xt/public/health/ready
https://trade.blocktane.io/api/v2/xt/public/health/ready

getPublicHealthAlive

Get application liveness status

Responses

200

Get application liveness status

get /xt/public/health/alive
https://trade.blocktane.io/api/v2/xt/public/health/alive

getPublicVersion

Get running Peatio version and build details.

Responses

200

Get running Peatio version and build details.

get /xt/public/version
https://trade.blocktane.io/api/v2/xt/public/version

getPublicTimestamp

Get server current time, in seconds since Unix epoch.

Responses

200

Get server current time, in seconds since Unix epoch.

get /xt/public/timestamp
https://trade.blocktane.io/api/v2/xt/public/timestamp

getPublicMemberLevels

Returns hash of minimum levels and the privileges they provide.

Responses

200

Returns hash of minimum levels and the privileges they provide.

get /xt/public/member-levels
https://trade.blocktane.io/api/v2/xt/public/member-levels

getPublicMarketsMarketTickers

Get ticker of specific market.

path Parameters
market
required
string
Enum: "btcbrl" "btcpax" "ethbrl" "ethbtc"

Responses

200

Get ticker of specific market.

get /xt/public/markets/{market}/tickers
https://trade.blocktane.io/api/v2/xt/public/markets/{market}/tickers

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "at": 0,
  • "ticker":
    {
    }
}

getPublicMarketsTickers

Get ticker of all markets (For response doc see /:market/tickers/ response).

Responses

200

Get ticker of all markets (For response doc see /:market/tickers/ response).

get /xt/public/markets/tickers
https://trade.blocktane.io/api/v2/xt/public/markets/tickers

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "at": 0,
  • "ticker":
    {
    }
}

getPublicMarketsMarketKLine

Get OHLC(k line) of specific market.

path Parameters
market
required
string
Enum: "btcbrl" "btcpax" "ethbrl" "ethbtc"
query Parameters
period
integer <int32>
Default: 1
Enum: 1 5 15 30 60 120 240 360 720 1440 4320 10080

Time period of K line, default to 1. You can choose between 1, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 4320, 10080

time_from
integer <int32>

An integer represents the seconds elapsed since Unix epoch. If set, only k-line data after that time will be returned.

time_to
integer <int32>

An integer represents the seconds elapsed since Unix epoch. If set, only k-line data till that time will be returned.

limit
integer <int32> [ 1 .. 10000 ]
Default: 30

Limit the number of returned data points default to 30. Ignored if time_from and time_to are given.

Responses

200

Get OHLC(k line) of specific market.

get /xt/public/markets/{market}/k-line
https://trade.blocktane.io/api/v2/xt/public/markets/{market}/k-line

getPublicMarketsMarketDepth

Get depth or specified market. Both asks and bids are sorted from highest price to lowest.

path Parameters
market
required
string
Enum: "btcbrl" "btcpax" "ethbrl" "ethbtc"
query Parameters
limit
integer <int32> [ 1 .. 1000 ]
Default: 300

Limit the number of returned price levels. Default to 300.

Responses

200

Get depth or specified market. Both asks and bids are sorted from highest price to lowest.

get /xt/public/markets/{market}/depth
https://trade.blocktane.io/api/v2/xt/public/markets/{market}/depth

getPublicMarketsMarketTrades

Get recent trades on market, each trade is included only once. Trades are sorted in reverse creation order.

path Parameters
market
required
string
Enum: "btcbrl" "btcpax" "ethbrl" "ethbtc"
query Parameters
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Limit the number of returned trades. Default to 100.

timestamp
integer <int32>

An integer represents the seconds elapsed since Unix epoch.If set, only trades executed before the time will be returned.

order_by
string
Default: "desc"
Enum: "asc" "desc"

If set, returned trades will be sorted in specific order, default to 'desc'.

Responses

200

Get recent trades on market, each trade is included only once. Trades are sorted in reverse creation order.

get /xt/public/markets/{market}/trades
https://trade.blocktane.io/api/v2/xt/public/markets/{market}/trades

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

getPublicMarketsMarketOrderBook

Get the order book of specified market.

path Parameters
market
required
string
Enum: "btcbrl" "btcpax" "ethbrl" "ethbtc"
query Parameters
asks_limit
integer <int32> [ 1 .. 200 ]
Default: 20

Limit the number of returned sell orders. Default to 20.

bids_limit
integer <int32> [ 1 .. 200 ]
Default: 20

Limit the number of returned buy orders. Default to 20.

Responses

200

Get the order book of specified market.

get /xt/public/markets/{market}/order-book
https://trade.blocktane.io/api/v2/xt/public/markets/{market}/order-book

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

getPublicMarkets

Get all available markets.

query Parameters
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Limit the number of returned paginations. Defaults to 100.

page
integer <int32>
Default: 1

Specify the page of paginated results.

ordering
string
Default: "asc"
Enum: "asc" "desc"

If set, returned values will be sorted in specific order, defaults to 'asc'.

order_by
string
Default: "position"
Enum: "id" "position"

Name of the field, which result will be ordered by.

base_unit
string

Strict filter for base unit

quote_unit
string

Strict filter for quote unit

search
json
search[base_code]
string

Search base currency code using LIKE

search[quote_code]
string

Search qoute currency code using LIKE

search[base_name]
string

Search base currency name using LIKE

search[quote_name]
string

Search quote currency name using LIKE

Responses

200

Get all available markets.

get /xt/public/markets
https://trade.blocktane.io/api/v2/xt/public/markets

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

getPublicCurrencies

Get list of currencies

query Parameters
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Limit the number of returned paginations. Defaults to 100.

page
integer <int32>
Default: 1

Specify the page of paginated results.

type
string
Enum: "fiat" "coin"

Currency type

search
json
search[code]
string

Search by currency code using SQL LIKE

search[name]
string

Search by currency name using SQL LIKE

Responses

200

Get list of currencies

get /xt/public/currencies
https://trade.blocktane.io/api/v2/xt/public/currencies

Response samples

Content type
application/json
Copy
Expand all Collapse all
[]

getPublicCurrenciesId

Get a currency

path Parameters
id
required
string
Enum: "brl" "btc" "eth" "pax" "BRL" "BTC" "ETH" "PAX"

Currency code.

Responses