/

Inventory

Market API (0.0.1)

use the Market API Fetch real-time and historical market data, including:

Order books
Recent trades
Tickers and price feeds

Download OpenAPI description

Overview

License

Servers

Production server

https://data-api.hibachi.xyz/

Market

Market API endpoints

Operations

Exchange Info

Request

curl -i -X GET \
  https://data-api.hibachi.xyz/market/exchange-info

Responses

Exchange Info

Bodyapplication/json

One of:

statusstringrequired

Value"NORMAL"

maintenanceWindowArray of objects(MaintenanceWindow)required

beginstringrequired

endstringrequired

notestringrequired

feeConfigobject(ExchangeFeeConfig)required

depositFeesstringrequired

instantWithdrawDstPublicKeystring or null

instantWithdrawalFeesArray of items or null

tradeMakerFeeRatestringrequired

tradeTakerFeeRatestringrequired

transferFeeRatestringrequired

withdrawalFeesstringrequired

futureContractsArray of objects(ContractData)required

displayNamestringrequired

idinteger(int32)(u32)>= 0required

maintenanceFactorForPositionsstringrequired

marketCloseTimestampstring or null

marketOpenTimestampstring or null

orderbookGranularitiesArray of stringsrequired

riskFactorForOrdersstringrequired

riskFactorForPositionsstringrequired

settlementDecimalsinteger(int32)>= 0required

settlementSymbolstringrequired

statusstring(ContractStatus)required

Enum"LISTED""PRE_OPEN""LIVE""PAUSED""CLOSED"

symbolstringrequired

underlyingDecimalsinteger(int32)>= 0required

underlyingSymbolstringrequired

minNotionalstringrequired

minOrderSizestringrequired

stepSizestringrequired

tickSizestringrequired

instantWithdrawalLimitobject(InstantWithdrawalLimit)required

lowerLimitstring or null

upperLimitstring or null

Response

application/json

{
  "status": "UNSCHEDULED_MAINTENANCE",
  "maintenanceWindow": [
    { … }
  ],
  "feeConfig": {
    "depositFees": "string",
    "instantWithdrawDstPublicKey": "string",
    "instantWithdrawalFees": [ … ],
    "tradeMakerFeeRate": "string",
    "tradeTakerFeeRate": "string",
    "transferFeeRate": "string",
    "withdrawalFees": "string"
  },
  "futureContracts": [
    { … }
  ],
  "instantWithdrawalLimit": {
    "lowerLimit": "string",
    "upperLimit": "string"
  }
}

Inventory

Request

curl -i -X GET \
  https://data-api.hibachi.xyz/market/inventory

Responses

Market Inventory value

Bodyapplication/json

crossChainAssetsArray of objects(CrossChainAsset)required

chainstringrequired

exchangeRateFromUSDTstringrequired

exchangeRateToUSDTstringrequired

instantWithdrawalLowerLimitInUSDTstring or null

instantWithdrawalUpperLimitInUSDTstring or null

tokenstringrequired

feeConfigobject(ExchangeFeeConfig)required

depositFeesstringrequired

instantWithdrawDstPublicKeystring or null

instantWithdrawalFeesArray of items or null

tradeMakerFeeRatestringrequired

tradeTakerFeeRatestringrequired

transferFeeRatestringrequired

withdrawalFeesstringrequired

marketsArray of objects(Market)required

contractobject(ContractData)required

displayNamestringrequired

idinteger(int32)(u32)>= 0required

maintenanceFactorForPositionsstringrequired

marketCloseTimestampstring or null

marketOpenTimestampstring or null

orderbookGranularitiesArray of stringsrequired

riskFactorForOrdersstringrequired

riskFactorForPositionsstringrequired

settlementDecimalsinteger(int32)>= 0required

settlementSymbolstringrequired

statusstring(ContractStatus)required

Enum"LISTED""PRE_OPEN""LIVE""PAUSED""CLOSED"

symbolstringrequired

underlyingDecimalsinteger(int32)>= 0required

underlyingSymbolstringrequired

minNotionalstringrequired

minOrderSizestringrequired

stepSizestringrequired

tickSizestringrequired

infoobject(MarketInfo)required

categorystring or null

markPricestring or null

price24hAgostring or null

priceLateststring or null

tagsArray of stringsrequired

tradingTiersArray of objects(TradingTier)required

levelinteger(int32)required

lowerThresholdstringrequired

titlestringrequired

upperThresholdstringrequired

Response

application/json

{
  "crossChainAssets": [
    { … }
  ],
  "feeConfig": {
    "depositFees": "string",
    "instantWithdrawDstPublicKey": "string",
    "instantWithdrawalFees": [ … ],
    "tradeMakerFeeRate": "string",
    "tradeTakerFeeRate": "string",
    "transferFeeRate": "string",
    "withdrawalFees": "string"
  },
  "markets": [
    { … }
  ],
  "tradingTiers": [
    { … }
  ]
}

Prices

Request

Get market prices for a specific symbol

Query

symbolstringrequired

Example: symbol=ETH/USDT-P

curl -i -X GET \
  'https://data-api.hibachi.xyz/market/data/prices?symbol={symbol}'

Responses

Market Prices

Bodyapplication/json

askPricestring or null

bidPricestring or null

fundingRateEstimationnull or FundingRateEstimation (object)

One of:

null

markPricestring or null

spotPricestring or null

symbolstringrequired

tradePricestring or null

Response

application/json

{
  "askPrice": "string",
  "bidPrice": "string",
  "fundingRateEstimation": {},
  "markPrice": "string",
  "spotPrice": "string",
  "symbol": "string",
  "tradePrice": "string"
}

Stats

Request

Get market stats for a specific symbol

Query

symbolstringrequired

curl -i -X GET \
  'https://data-api.hibachi.xyz/market/data/stats?symbol={symbol}'

Responses

Market Stats

Bodyapplication/json

high24hstring or null

low24hstring or null

symbolstringrequired

volume24hstring or null

Response

application/json

{
  "high24h": "string",
  "low24h": "string",
  "symbol": "string",
  "volume24h": "string"
}

Trades

Request

Get recent trades for a specific symbol

Query

symbolstringrequired

Example: symbol=ETH/USDT-P

curl -i -X GET \
  'https://data-api.hibachi.xyz/market/data/trades?symbol={symbol}'

Responses

Market Trades

Bodyapplication/json

tradesArray of objects(Trade)required

pricestringrequired

quantitystringrequired

takerSidestring(TakerSide)required

Enum"Sell""Buy"

timestampinteger(int64)>= 0required

Response

application/json

{
  "trades": [
    { … }
  ]
}

Candlesticks

Request

Get the candlesticks for a future contract.

Path

symbolstringrequired

intervalstringrequired

fromMsinteger or null(int64)>= 0required

toMsinteger or null(int64)>= 0required

curl -i -X GET \
  'https://data-api.hibachi.xyz/market/data/klines?interval={interval}&symbol={symbol}'

Responses

Market Inventory value

Bodyapplication/json

klinesArray of objects(Kline)required

closestringrequired

highstringrequired

intervalstringrequired

lowstringrequired

openstringrequired

timestampinteger(int64)>= 0required

volumeNotionalstringrequired

Response

application/json

{
  "klines": [
    { … }
  ]
}

Open Interest

Request

Get the open interest for one future contract. It will return the total open position from each side.

Path

symbolstringrequired

The symbol of the contract to get open interest for.

Example: ETH/USDT-P

curl -i -X GET \
  'https://data-api.hibachi.xyz/market/data/open-interest?symbol=ETH/USDT-P'

Responses

Bodyapplication/json

totalQuantitystringrequired

open interest for one future contract

Example: "6.326719254"

Response

application/json

{
  "totalQuantity": "6.326719254"
}

Orderbook

Request

Path

symbolstringrequired

depthinteger or null(int32)>= 0required

granularitystring or nullrequired

curl -i -X GET \
  https://data-api.hibachi.xyz/market/data/orderbook

Responses

Market Orderbook

Bodyapplication/json

asknull or PriceLevelsDetail (object)required

One of:

null

bidnull or PriceLevelsDetail (object)required

One of:

null

Response

application/json

{
  "ask": {},
  "bid": {}
}

Volumes

Request

curl -i -X GET \
  https://data-api.hibachi.xyz/exchange/stats/volumes

Responses

Exchange Stats Volumes

Bodyapplication/json

chain_volumesArray of objects(ChainVolume)required

chain_namestringrequired

volumenumber(double)required

future_contractsArray of objects(ExchangeMarketStats)required

high24hstring or null

idinteger(int32)(u32)>= 0required

low24hstring or null

symbolstringrequired

volume24hstring or null

timestampstring(date-time)required

Response

application/json

{
  "chain_volumes": [
    { … }
  ],
  "future_contracts": [
    { … }
  ],
  "timestamp": "2019-08-24T14:15:22Z"
}