{"info":{"_postman_id":"3052daca-79cc-4d7d-bc40-31e64850176a","name":"Hibachi API","description":"

Welcome to Hibachi!

We provide two ways to access our APIs:

REST
\n
Websockets
\n

The REST API provides all functionality access with easy-to-use request and response models.

Websocket API provides lower latency access to real time trading and data.

Key Definitions

API Key: An API key is an alphanumeric string that is used to identify and authenticate an application or user to interact with API/WS endpoints. This is required for almost ALL endpoints covered in this documentation except /market REST and /ws/market WS endpoints. This key is NOT used for signing; that is done using your Private/Secret key.
\n
Private/Secret Key: A private key is a cryptographic code that's used to sign transactions and to prove ownership of your Hibachi Account. NOTE: This is NOT your crypto wallet’s private key. You will ONLY use this key to generate signatures for a subset of endpoints you are interacting with.
\n
Trustless Account: A trustless account is a Hibachi Account you created via directly connecting to your crypto wallet. You will generate a signature with your ECDSA Private Key using the ECDSA method.
\n
Exchange Managed Account: An exchange managed account is a Hibachi Account you created via email or social login. You will generate a signature with HMAC Secret Key using the HMAC method.
\n
Asset Quantities:All quantities on Hibachi are represented internally as 64-bit numbers. In order to enable trading fractional quantities (e.g. 0.01 BTC), each asset on Hibachi has a specific fixed number of decimals.
\n
- Example
  \n
  - BTC may be represented with 10 decimals
    \n
  - This means 1 BTC is stored as 1 x 10^10 = 10,000,000,000 quantity on the exchange
    \n
  \n
- When making trades, querying positions and similar, Hibachi will still expose and expect numbers as \"real\" float strings (e.g. \"quantity: 1.0\" for 1 BTC).
  \n
- This way, users don't need to constantly convert numbers in order to be able to reason about them. However, this quantity notation is important when:
  \n
  - Signing any operations (trades, withdrawals, etc) since we want the traders to specify exactly what they want to trade and not leave room for misinterpretations.
    \n
  - Interacting with the Hibachi smart contracts
    \n
  \n
- The number of decimals is exposed for each contract in the /market/exchange-info endpoint response under the underlyingDecimals field.
  \n
\n
Asset Prices: Like quantities, asset prices are also 64-bit numbers that conform to decimals. Prices are used when converting between underlying and the settlement token in a market.
\n
- For example, on BTC/USDT-P a price of 100,000 may be used in a limit order to indicate that somebody is willing to sell BTC for 100,000 USDT per BTC. Price is always denoted in units of the settlementAsset.
  \n
- Since both the underlying and settlement assets have unique quantity decimals, the price is stored in the difference between both decimals (settlementDecimals - underlyingDecimals).
  \n
- In order to support higher resolution of prices, an additional price multiplier of 2^32 is used to represent prices as fixed-point decimals with 32 bits after the decimal point.
  \n
\n

Pre-requisites

You make a Deposit to your account. (Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints. We currently ONLY support three assets, and any other currencies deposited will not be refunded:
\n
1. USDT on Arbitrum One
  \n
2. USDC on Arbitrum One
  \n
3. USDC on Base Mainnet
  \n
\n

Trustless Wallet: Open the \"Wallet Balance\" Dropdown, and select \"Deposit\". First you need to Unlock your wallet with proper allowance, then you can enter the amount you would want to deposit to your Hibachi Account.

\n\n

Exchange Managed Wallet:Open the \"Wallet Balance\" Dropdown, and select \"Deposit\" to reveal wallet deposit address, then send USDT from any of your crypto wallets that holds USDT to this deposit address

\n\n

Getting Started

1. Create an API Key

After you login to your Hibachi Account from the UI, click on the gear button on the top right corner, then select API Keys
\n
Click on Create API Key, then follow below definition to choose the correct setting for your API Key, and click on Generate
\n
- Select Account: This is to choose the account you want to associate with this API Key. Note you cannot use an API Key you created to access another account you own.
  \n
- Name of the API Key: a name you want to associate with this API Key
  \n
- API Restrictions: you can choose if this API Key will have read-only or read-write permissions. By default the read-only permission is selected.
  \n
  - read-write permissions:
    \n
    - Trading: This permission is required to place orders
      \n
    - Withdraws: This permission will allow the API key to withdraw funds from the exchange account to outside destinations
      \n
    - Transfers: This permission will allow the transfer of funds to other sub-accounts related to the main account. This will not allow transferring to other users OR withdrawing unless the withdraw permission is present
      \n
    \n
  \n
\n
On the next page, save the API Key and Private Key to a safe vault (e.g password manager etc). You will ONLY be able to see the Private Key during generation, so make sure you save it before exiting the page
\n
Click on Next, save below information that will be needed for API Endpoints interaction together with your API Key
\n
- Account ID: you will see `ID: XXX` below your API Key Name
  \n
- Public Key:
  \n
\n

\n\n

2. API Authorization

For every endpoint that requires authorization (i.e. everything except /market or /ws/market), add the header Authorization:

Signing

Signing is ONLY required for the write-operations listed below. GET requests do not require a signature. Signing requires using a very specific payload structure depending on the operation. If you do not use the exact order and padding below your requests will fail signature verification. Please refer to this public js repo for examples.
\n
- Capital: Withdraw and Transfer
  \n
  - Withdraw
    \n
    - You must sign a payload made of the following fields, padded to their respective sizes, and in the following order. This signed payload needs to be 32 bytes and be passed into the signaturefield
      \n
      - asset_id: 4 bytes
        \n
      - quantity: 8 bytes
        \n
      - max_fees: 8 bytes
        \n
      - withdrawal_address: 20 bytes
        \n
      \n
    \n
  - Transfer
    \n
    - You must sign a payload comprising the following fields and pass them into the signature field
      \n
      - nonce: 8 bytes
        \n
      - asset_id: 4 bytes
        \n
      - quantity: 8 bytes
        \n
      - dst_account_public_key: 64 bytes
        \n
      - max_fees_percent: 8 bytes
        \n
      \n
    \n
  \n
- Trade
  \n
  - All write operations (place orders, edit orders, cancel orders requests) require signatures.
    \n
    - Trustless accounts: these signatures use ECDSA with the private key provided per API Key.This is a string of 65 bytes including the recovery ID. Depending on what library you're using, the ECDSA signature should give you a recovery ID byte as well. You then concatenate that bit as the 65th byte.
      \n
    - Exchange-managed accounts,:these signatures use HMAC with the private key provided per API Key.
      \n
    - Each operation has a specific method for generating the signature digest that needs to be signed. Each operation is detailed below. All numbers using the big endian byte ordering.
      \n
      - Place/Edit Order
        \n
        \n
        Structure: The payload for placing or editing orders consists of the following. For editing an order, you can use either the orderId, nonce , or clientId field to refer to the order.
        \n
        \n
        Nonce: 8 bytes
        \n
        \n
        Current timestamp serving as a unique identifier for your order
        \n
        \n
        Nonce needs to be a milli-second or micro-second unix timestamp within +- 15 seconds of the current time
        \n
        \n
        Nonce needs to be unique per subaccount (if you send two orders with the same nonce from the same account, they will be rejected by our API)
        \n
        \n
        \n
        \n
        Contract ID: 4 bytes
        \n
        \n
        Quantity: 8 bytes - See section on asset quantities for how these are computed
        \n
        \n
        Side: 4 bytes - Ask: 0 ; Bid: 1
        \n
        \n
        Price (Optional): 8 bytes
        \n
        \n
        Only applicable for limit order
        \n
        \n
        See section on asset prices for how these are computed
        \n
        \n
        \n
        \n
        Max Fees Percent: 8 bytes
        \n
        \n
        Maximum fees allowed for order operation
        \n
        \n
        Denoted in basis points (e.g. 20 => 0.2% fee)
        \n
        \n
        We can get fee information from /market/exchange-info.
        \n
        \n
        \n
        \n
        Creation Deadline (Optional)
        \n
        \n
        If our system can not place the order by the deadline, the order will be rejected
        \n
        \n
        This is useful if you are concerned about high network or system latency.
        \n
        \n
        The creationDeadline field should have the number of seconds since the Unix epoch as a floating point number
        \n
        \n
        For trigger orders, the creation deadline is applied to the order when it is triggered.
        \n
        \n
        \n
        \n
        Trigger Price (Optional)
        \n
        \n
        If present, indicates that this is a trigger order (also called stop order) that should be sent when the market price reaches the trigger price
        \n
        \n
        When modifying trigger orders:
        \n
        \n
        If order has been triggered, you should not set the updatedTriggerPrice field. You can modify the order like a regular limit order
        \n
        \n
        If the order has not been triggered yet, you should set the updatedTriggerPrice field with the new trigger price
        \n
        \n
        If the order has not been triggered yet, you can modify market orders to limit orders and vice-versa
        \n
        \n
        If updatedPrice is present, the order will be modified to a limit order with that price
        \n
        \n
        If updatedPrice is absent, the order will be modified to a market order
        \n
        \n
        \n
        \n
        When triggered, the order ends up at the back of the queue for the price level
        \n
        \n
        \n
        \n
        \n
        \n
        Example
        \n
        \n
        Let's assume we want to place the following order and contract information from /exchange-info
        \n
        \n
        \n
        \n
      \n
    \n
  \n
\n

//order  \n{  \n    \"symbol\": \"BTC/USDT-P\",  \n    \"side\": \"ASK\",  \n    \"nonce\": 1714701600000000,  \n    \"quantity\": \"1 BTC\",  \n    \"price\": \"100,000 USDT\",  \n    \"max_fees\": \"0.0005\",  //5 basis points\n}  \n//contract info from /exchange-info  \n{  \n    \"symbol\": \"BTC/USDT-P\",  \n    \"id\": 2,  \n    \"underlyingDecimals\": 10,  \n    \"underlyingSymbol\": \"BTC\",  \n    \"settlementDecimals\": 6,  \n    \"settlementSymbol\": \"USDT\",\n    \"status\":\"LIVE\"\n}\n\n

We can now compute quantity and price:

Quantity: 1 BTC x 10^10 = 10,000,000,000 since underlyingDecimals: 10
\n
Price: 100,000 USDT x 2^32 x 10^(6 - 10 = -4) = 42,949,672,960 since priceMultiplier: 2^32 and settlementDecimals - underlyingDecimals = 6 - 10 = -4
\n
Using these numbers, we can compute the elements of the buffer as**:**
\n
- Nonce: 1714701600000000 => 0x0006178313c38800
  \n
- ContractId: 2 => 0x00000002
  \n
- Quantity: 10000000000 => 0x00000002540be400
  \n
- Side: ASK => 0x00000000
  \n
- Price: 42949672960 => 0x0000000a00000000
  \n
- Fees: For fixed fees like withdraw/deposit, we should use fees * 10^6, one example: 1.23=>1230000=>0x00000000012C4B00. For rate fees, we should use rate fees * 10^8, one example: 0.0005=>5000=>0x0000000000001388
  \n
\n
Concatenating these elements gives us a buffer of: 0x0006178313c388000000000200000002540be400000000000000000a000000000000000000001388
\n
If exchange managed, we would sign this order using HMAC
\n

const hmacSignature = crypto\n   .createHmac('sha256', 'YOUR-SECRET-KEY')\n   .update(buffer)\n   .digest('hex');\n\n

If trustless account, we would sign using ECDSA

const msgHash = ethers.sha256(buffer).slice(2);\nconst ecdsaSignature = ec.sign(msgHash, 'hex', { canonical: true });\n\n

Cancel Order: For order cancellations:
\n
- If you are using orderId, the payload will be the orderId as a 64-bit integer.
  \n
  - For example, the place order operation above could result in a response payload like { \"order_id\":\"579183763093760000\"}
    \n
  - If we wanted to cancel this order, we'd need to sign 579183763093760000 as 8 bytes, which would map to 0x0809ac905ae0a800
    \n
  \n
- If you are using clientId, the payload will be the ASCII encoding of clientId.
  \n
  - If the clientId is \"hello\", the payload will be 0x68656c6c6f
  \n
\n
Cancel all orders: You can also cancel all orders by sending an HTTP delete to the /trade/orders endpoint with the account ID, a nonce, and signature signed on the nonce (64-bit integer)
\n

REST API

You can find documentation for all Hibachi REST API on this page.

We have 2 different categories of API:

Account API: for account specific query and action
\n
Market API: for market data and metadata
\n

Websocket API

For Websocket API, please use this link to access our public Postman workspace.

You can find the detailed documentation this way:

Select \"Websockets API\" and choose one of the API endpoint.
\n
Click the \"Documentation\" button on top right.
\n

Quick Links

Hibachi UI: https://hibachi.xyz
\n
Use Exchange Info API to get the list of future contracts
\n
Use Trade Order API to place orders
\n
Use Account Info API to get account status
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Key Definitions","slug":"key-definitions"},{"content":"Pre-requisites","slug":"pre-requisites"},{"content":"Getting Started","slug":"getting-started"},{"content":"Signing","slug":"signing"},{"content":"REST API","slug":"rest-api"},{"content":"Websocket API","slug":"websocket-api"},{"content":"Quick Links","slug":"quick-links"}],"owner":"38930884","collectionId":"3052daca-79cc-4d7d-bc40-31e64850176a","publishedId":"2sAXxQfD4P","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-10T16:16:37.000Z"},"item":[{"name":"Account API","item":[{"name":"Capital","item":[{"name":"/capital/balance","id":"d0657874-17ae-4b36-a45d-d9ffe6790244","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-staging.hibachi.xyz/capital/balance?accountId=","description":"

Usage

Get the balance of your account.

The returned balance is your net equity which includes unrealized PnL.

Required Request Parameter:

accountId: The account ID can be found on the UI details page of each API Key. Your Account ID will not be generated until your first deposit

Usage

Get the deposit and withdraw history of your account.

It will return most recent up to 100 deposit and 100 withdraw.

Required Request Parameter:

accountId : The account ID can be found on the UI details page of each API Key. Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints

\n","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}},"urlObject":{"path":["capital","history"],"host":["https://api-staging.hibachi.xyz"],"query":[{"key":"accountId","value":""}],"variable":[]}},"response":[{"id":"b84c9fea-b44f-43be-8b05-94a54c403557","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"API KEY Generated from UI"}],"url":{"raw":"https://api.hibachi.xyz/capital/history?accountId=128","protocol":"https","host":["api","hibachi","xyz"],"path":["capital","history"],"query":[{"key":"accountId","value":"128"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 11 Apr 2024 19:41:42 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=3zJoqPfrFQZn0taYNnwOihTPZkTavgVVGC/H49JBRdnX64rxnu6maKnUICBLPZgph0B7cq29lpCMe1AAs+WBOwfExW3R0hFjOit9A+mcmLVzusQ1OaEZNhGx8NAH; Expires=Thu, 18 Apr 2024 19:41:42 GMT; Path=/","enabled":true},{"key":"access-control-allow-credentials","value":"true","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"Set-Cookie","value":"AWSALBCORS=3zJoqPfrFQZn0taYNnwOihTPZkTavgVVGC/H49JBRdnX64rxnu6maKnUICBLPZgph0B7cq29lpCMe1AAs+WBOwfExW3R0hFjOit9A+mcmLVzusQ1OaEZNhGx8NAH; Expires=Thu, 18 Apr 2024 19:41:42 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"Set-Cookie","value":"__cf_bm=Z1bF2_DUE8XL6E5YD99W3zzCnb6X0r9nTGFUfHDtayg-1712864502-1.0.1.1-yS3mqnYuZwyWrXOYUGKchEVZD7Iz4OtJPAQNBX74e6fbq_gkcNSrB0Sd5YsKELqbWGzABiUlSOcmlvAiZGn1Tg; path=/; expires=Thu, 11-Apr-24 20:11:42 GMT; domain=.hibachi.xyz; HttpOnly; Secure; SameSite=None","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"872d74a409f753ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"transactions\": [\n {\n \"assetId\": 1,\n \"blockNumber\": 0,\n \"id\": 10,\n \"quantity\": \"20.000000\",\n \"status\": \"completed\",\n \"timestamp\": 1728510232,\n \"transactionHash\": \"0x0000000000000000000000000000000000000000000000000000000000000000\",\n \"transactionType\": \"deposit\"\n },\n {\n \"assetId\": 1,\n \"id\": 3,\n \"quantity\": \"3.061224\",\n \"status\": \"completed\",\n \"timestamp\": 1728510702,\n \"transactionType\": \"withdrawal\",\n \"withdrawalAddress\": \"0x0000000000000000000000000000000000000000\"\n },\n {\n \"assetId\": 1,\n \"id\": 13,\n \"quantity\": \"11.997367\",\n \"srcAccountId\": 134,\n \"srcAddress\": \"0x0000000000000000000000000000000000000000\",\n \"status\": \"completed\",\n \"timestamp\": 1728510867,\n \"transactionType\": \"transfer-in\"\n },\n {\n \"assetId\": 1,\n \"id\": 7,\n \"quantity\": \"10.000000\",\n \"receivingAccountId\": 134,\n \"receivingAddress\": \"0x0000000000000000000000000000000000000000\",\n \"status\": \"completed\",\n \"timestamp\": 1728510375,\n \"transactionType\": \"transfer-out\"\n }\n ]\n}"}],"_postman_id":"35125e3f-d154-4bfd-8276-a48bb1c62020"},{"name":"/capital/withdraw","id":"6421625d-3e45-45fa-be9b-d2a0e780c090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountId\": 140,\n \"coin\": \"USDT\",\n \"withdrawAddress\": \"0000000000000000000000000000000000000000\",\n \"network\": \"arbitrum\",\n \"quantity\": \"2.0113592\",\n \"maxFees\": \"0.0113592\",\n \"signature\": \"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-staging.hibachi.xyz/capital/withdraw","description":"

Usage

Submit a withdraw request.

Signing

Use below field to sign the message and pass it in to signature field (65 bytes). Refer to the Signing section for more context

assetId (4 bytes)
\n
quantity (8 bytes): should be no more than maximalWithdraw returned by /trade/account/info endpoint, otherwise it will be rejected.
\n
maxFees (8 bytes): should be at least returned by /market/exchange-info endpoint, otherwise it will be rejected.
\n
withdrawalAddress (20 bytes)
\n

Request Body Payload

Required Fields

accountId
\n
coin
\n
withdrawAddress
\n
quantity
\n
signature
\n

NOTE: Self Claim Option for trustless account: You can replace withdrawalAddress with selfWithdrawal , but you will need to follow our ABI to make direct contract interaction for claim the withdraw. Currently, the only coin we support is USDT.

\n","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}},"urlObject":{"path":["capital","withdraw"],"host":["https://api-staging.hibachi.xyz"],"query":[],"variable":[]}},"response":[{"id":"87ac1b64-f792-442a-b4df-1d0f890d36ce","name":"Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"API KEY Generated from UI"}],"body":{"mode":"raw","raw":"{\n \"accountId\": 140,\n \"coin\": \"USDT\",\n \"withdrawAddress\": \"0000000000000000000000000000000000000000\",\n \"network\": \"arbitrum\",\n \"quantity\": \"2.0113592\",\n \"maxFees\": \"0.0113592\",\n \"signature\": \"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.hibachi.xyz/capital/withdraw"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:37:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=G88/PnZwHua1H7dMaRanpZ5yvwNtsYJb8jcaOkuXlgzACgj2eBOa+9zs2geMqUGLIiIQZ73anaSY+6ZzoqFpd7DyteZlCPGv4buG2i9ug08kvh2g92C7VTXfc8nE; Expires=Tue, 16 Apr 2024 19:37:32 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=G88/PnZwHua1H7dMaRanpZ5yvwNtsYJb8jcaOkuXlgzACgj2eBOa+9zs2geMqUGLIiIQZ73anaSY+6ZzoqFpd7DyteZlCPGv4buG2i9ug08kvh2g92C7VTXfc8nE; Expires=Tue, 16 Apr 2024 19:37:32 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-credentials","value":"true","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871cf3cb7e2253ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"6421625d-3e45-45fa-be9b-d2a0e780c090"},{"name":"/capital/transfer","id":"375b600c-971b-4ed5-b61c-d5fb798720c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountId\": 140,\n \"coin\": \"USDT\",\n \"fees\": \"0\",\n \"nonce\": 1728515344533,\n \"quantity\": \"1\",\n \"dstPublicKey\": \"00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\",\n \"signature\": \"0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-staging.hibachi.xyz/capital/transfer","description":"

Usage

Submit a withdraw request.

Signing

Use below field to sign the message and pass it in to signature field (65 bytes). Refer to the Signing section for more context

nonce (8 bytes)
\n
assetId (4 bytes)
\n
quantity (8 bytes)
\n
dstPublicKey (20 bytes)
\n
maxFeesPercent(8 bytes), should be at least returned value at /market/exchange-info endpoint, otherwise, it will be rejected.
\n

Required Request Body

accountId
\n
coin
\n
fees
\n
nonce
\n
quantity
\n
receivingAddress
\n
signature
\n

Currently, the only coin we support is USDT.

Usage

Get deposit address for a given account. Sending funds to this address allows for

Required Request Parameter:

**publicKey:**The public key of the account

Deposit USDT

An internal account is not created for you until a deposit is made.

Open the \"Wallet Balance\" Dropdown, and select \"Deposit\" to reveal wallet deposit address. We currently only support three assets:

USDT on Arbitrum One
\n
USDC on Arbitrum One
\n
USDC on Base Mainnet
\n

Withdraw

To withdraw funds, you can use the /capital/withdraw endpoint.

Triggers a withdraw request for the exchange to make funds available for deposit.
\n
If accepted, the withdraw request will be submitted in the next ZK proof batch (10-30min) at which point the funds will become available for claiming.
\n
For self-withdrawals (zero-fee), the user will need to claim the funds themselves.
\n
For auto-withdrawals (gas fee excluded) the exchange will trigger the blockchain transaction for the funds to get claimed to the withdraw_address provided in the original request.
\n

You must sign a payload comprising the following fields and pass that in the signature field

assetId
\n
quantity
\n
maxFees
\n
withdrawalAddress
\n

Transfer

To transfer funds, you can use the /capital/transfer endpoint.

Tranfers funds between accounts within the system (no withdrawals).
\n
Transfers are instant and can be used right away by the receiving account.
\n

You must sign a payload comprising the following fields and pass that in the signature field

nonce
\n
assetId
\n
quantity
\n
dstPublicKey
\n
maxFees
\n

\n","_postman_id":"17049f78-cfc7-4057-9019-3926a54f8540","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}}},{"name":"Authentication","item":[],"id":"f1e55d83-5587-4c31-bff2-e972590a16ad","description":"

You will need to use API keys for accessing Hibachi APIs

Generate API key from settings dropdown, create one with all restrictions enabled with read-write access.

\n $\"API%20key%20generation\"$ \n\n

After generation, you can view the details of the API key

\n $\"API%20key%20details\"$ \n\n

Click Copy on API Key. It will be used in authorization header for API access.

If you provisioned an exchange-managed account, you need to use Private Key for HMAC signing of your request on signature required endpoints.

\n","_postman_id":"f1e55d83-5587-4c31-bff2-e972590a16ad","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}}},{"name":"Trade","item":[{"name":"/trade/account/info","id":"69aafedb-8274-4e21-bbaf-91dace8b8f31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://api-staging.hibachi.xyz/trade/account/info?accountId=","description":"

Usage

Get account information/details

Required Query Parameter

accountId

Key Response Fields

balance (net equity) and maximalWithdraw
\n
(collateral) assets
\n
positions
\n
risk related summary: totalOrderNotional, totalPositionNotional, totalUnrealizedPnl, initialMargin, maintenanceMargin
\n
The entryNotional in positions is: entry price multiply by quantity.
\n
totalOrderNotional does not count orders that will reduce your position.
\n
leverages: the custom leverage settings set by /trade/account/leverage endpoint.
\n

\n","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}},"urlObject":{"path":["trade","account","info"],"host":["https://api-staging.hibachi.xyz"],"query":[{"key":"accountId","value":""}],"variable":[]}},"response":[{"id":"686fd9d3-0a22-410e-aaad-b01360506e7b","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"API KEY Generated from UI"}],"url":{"raw":"https://api.hibachi.xyz/trade/account/info?accountId=128","protocol":"https","host":["api","hibachi","xyz"],"path":["trade","account","info"],"query":[{"key":"accountId","value":"128"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:38:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=GFfRXt0F8Q4UulrTjhYVAj0kVcNOFfkFOUuFfmkCXPZnQLbK5G1IIO2mQW5dfI1S4892TzJXfZlLcblzE+X08gHTm7iw5nvXkyFDwrDgr5M92Bx5aBD4Vgg7+5PQ; Expires=Tue, 16 Apr 2024 19:38:36 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=GFfRXt0F8Q4UulrTjhYVAj0kVcNOFfkFOUuFfmkCXPZnQLbK5G1IIO2mQW5dfI1S4892TzJXfZlLcblzE+X08gHTm7iw5nvXkyFDwrDgr5M92Bx5aBD4Vgg7+5PQ; Expires=Tue, 16 Apr 2024 19:38:36 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-credentials","value":"true","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871cf558984f53ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"assets\": [\n {\n \"quantity\": \"14.130626\",\n \"symbol\": \"USDT\"\n }\n ],\n \"balance\": \"14.186087\",\n \"initialMargin\": \"0.000000\",\n \"maintenanceMargin\": \"0.000000\",\n \"leverages\": [\n {\n \"initialMarginRate\": \"0.600000\",\n \"symbol\": \"BTC/USDT-P\"\n },\n {\n \"initialMarginRate\": \"0.750000\",\n \"symbol\": \"ETH/USDT-P\"\n }\n ],\n \"maximalWithdraw\": \"4.152340\",\n \"numFreeTransfersRemaining\": 96,\n \"positions\": [\n {\n \"direction\": \"Short\",\n \"entryNotional\": \"10.302213\",\n \"notionalValue\": \"10.225008\",\n \"quantity\": \"0.004310550\",\n \"symbol\": \"ETH/USDT-P\",\n \"unrealizedFundingPnl\": \"0.000000\",\n \"unrealizedTradingPnl\": \"0.077204\"\n },\n {\n \"direction\": \"Short\",\n \"entryNotional\": \"2.000016\",\n \"notionalValue\": \"1.999390\",\n \"quantity\": \"0.0000328410\",\n \"symbol\": \"BTC/USDT-P\",\n \"unrealizedFundingPnl\": \"0.000000\",\n \"unrealizedTradingPnl\": \"0.000625\"\n },\n {\n \"direction\": \"Short\",\n \"entryNotional\": \"2.000015\",\n \"notionalValue\": \"2.022384\",\n \"quantity\": \"0.01470600\",\n \"symbol\": \"SOL/USDT-P\",\n \"unrealizedFundingPnl\": \"0.000000\",\n \"unrealizedTradingPnl\": \"-0.022369\"\n }\n ],\n \"totalOrderNotional\": \"8.670066\",\n \"totalPositionNotional\": \"14.246782\",\n \"totalUnrealizedFundingPnl\": \"0.000000\",\n \"totalUnrealizedPnl\": \"0.055460\",\n \"totalUnrealizedTradingPnl\": \"0.055460\",\n \"tradeMakerFeeRate\": null,\n \"tradeTakerFeeRate\": null\n}"}],"_postman_id":"69aafedb-8274-4e21-bbaf-91dace8b8f31"},{"name":"/trade/account/trades","id":"0adbf143-189f-40e0-afdc-88af4cba3c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api-staging.hibachi.xyz/trade/account/trades?accountId=","description":"

Usage

Get the trade history of your account. The id returned from one response should be used for pagination.

Required Query Parameter

accountId

Optional Query Parameters

maxJournalId : This is used for pagination. This is not needed to be set on the first request. All trades with id less than or equal to this value will be returned in descending order.
\n
limit : The number of trades to return (Default: 100)
\n
contractId: The market to filter by. (Default: returns all trades across all markets)
\n
side: Filter trades by buy or sell
\n
startTime : Filter trades after startTime in Unix timestamp seconds
\n
endTime: Filter trades before endTime in Unix timestamp seconds
\n

Key Response Fields

trades: an array of trades, with each element containing (at least) the following fields

askAccountId
\n
askOrderId
\n
bidAccountId
\n
bidOrderId
\n
fee - fee paid (in USDT) on this trade
\n
id - unique identifier for the trade
\n
orderType - LIMIT or MARKET
\n
price
\n
quantity
\n
realizedPnl
\n
side
\n
symbol
\n
timestamp - the timestamp in unix epoch seconds when the trade occured
\n
timestamp_ns_partial - the subsecond component of the timestamp in nanoseconds
\n
isTaker - whether or not the trade took liquidity
\n

\n","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}},"urlObject":{"path":["trade","account","trades"],"host":["https://api-staging.hibachi.xyz"],"query":[{"key":"accountId","value":""}],"variable":[]}},"response":[{"id":"6fd8f7a7-8de5-4ed9-8a08-5fe18f674db5","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"API KEY Generated from UI"}],"url":{"raw":"https://api.hibachi.xyz/trade/account/trades?accountId=126","protocol":"https","host":["api","hibachi","xyz"],"path":["trade","account","trades"],"query":[{"key":"accountId","value":"126"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:39:14 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=flZCijHsbsU6DXyohb4/JkfxoopC3pZ6zqaPcShsW3kCk/PmvSt+V+KlP2NU42kRM8fujac8JSmcqQ3oXsq55yuIZuPnN/I4kPUK28AlDX9JRJCJhKoAw2qI01IU; Expires=Tue, 16 Apr 2024 19:39:14 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=flZCijHsbsU6DXyohb4/JkfxoopC3pZ6zqaPcShsW3kCk/PmvSt+V+KlP2NU42kRM8fujac8JSmcqQ3oXsq55yuIZuPnN/I4kPUK28AlDX9JRJCJhKoAw2qI01IU; Expires=Tue, 16 Apr 2024 19:39:14 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-credentials","value":"true","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871cf64759e853ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"trades\": [\n {\n \"askAccountId\": 126,\n \"askOrderId\": 582869893016453100,\n \"bidAccountId\": 131,\n \"bidOrderId\": 582869893208343600,\n \"fee\": \"0.141460\",\n \"id\": 1818286,\n \"orderType\": \"LIMIT\",\n \"price\": \"2369.078949\",\n \"quantity\": \"0.398074810\",\n \"realizedPnl\": \"0.000000\",\n \"side\": \"Sell\",\n \"symbol\": \"ETH/USDT-P\",\n \"timestamp\": 1728516134\n },\n {\n \"askAccountId\": 126,\n \"askOrderId\": 582869868833669100,\n \"bidAccountId\": 131,\n \"bidOrderId\": 582869893208343600,\n \"fee\": \"0.111748\",\n \"id\": 1818285,\n \"orderType\": \"LIMIT\",\n \"price\": \"2370.254596\",\n \"quantity\": \"0.314306980\",\n \"realizedPnl\": \"-0.000001\",\n \"side\": \"Sell\",\n \"symbol\": \"ETH/USDT-P\",\n \"timestamp\": 1728516134\n }\n ]\n}"}],"_postman_id":"0adbf143-189f-40e0-afdc-88af4cba3c79"},{"name":"/trade/account/settlements_history","id":"28185336-04b7-4480-bcc8-a33516ad458b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-staging.hibachi.xyz/trade/account/settlements_history?accountId=","description":"

Usage

You can obtain the history of funding events using the /trade/account/settlements_history endpoint.

Required Query Parameter

accountId

Optional Query Parameters

page - number used for pagination
\n
limit - number of results to return for a single call
\n
contractId - the market to filter by
\n
startTime - filter events by start time
\n
endTime - filter events by end time
\n

Usage

Get the pending orders of your account.

Required Query Parameter

accountId

Response Key Fields

total_quantity is the quantity you specify when you submit the order.
\n
available_quantity is the quanaity that is remaining for match. It is total_quantity minus matched quantity.
\n

\n","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}},"urlObject":{"path":["trade","orders"],"host":["https://api-staging.hibachi.xyz"],"query":[{"key":"accountId","value":""}],"variable":[]}},"response":[{"id":"18dadfc7-01f2-4874-96f8-72421cf0e128","name":"Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"API KEY Generated from UI"}],"url":{"raw":"https://api-staging.hibachi.xyz/trade/orders?accountId=128","host":["https://api-staging.hibachi.xyz"],"path":["trade","orders"],"query":[{"key":"accountId","value":"128"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:39:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=IBBP3R6ksWT+4ohRG+A2ztC7ZmSUSR9ud0xMca2cu/llpee2HRAY04wdhH2jz7ZSnBtnftAUeR2gkAL8elSXUhnZcTyNkKQRwfm+hJnLn89IcTGiv9TTNiFumQoU; Expires=Tue, 16 Apr 2024 19:39:36 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=IBBP3R6ksWT+4ohRG+A2ztC7ZmSUSR9ud0xMca2cu/llpee2HRAY04wdhH2jz7ZSnBtnftAUeR2gkAL8elSXUhnZcTyNkKQRwfm+hJnLn89IcTGiv9TTNiFumQoU; Expires=Tue, 16 Apr 2024 19:39:36 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-credentials","value":"true","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871cf6d228d753ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"accountId\": 126,\n \"availableQuantity\": \"0.389560448\",\n \"contractId\": 1,\n \"creationTime\": 1731609679,\n \"orderId\": \"582870002718998528\",\n \"clientId\": \"my-order-1\",\n \"orderType\": \"LIMIT\",\n \"price\": \"2344.032723\",\n \"side\": \"BID\",\n \"status\": \"PLACED\",\n \"symbol\": \"ETH/USDT-P\",\n \"totalQuantity\": \"0.389560448\"\n },\n {\n \"accountId\": 126,\n \"availableQuantity\": \"0.161019613\",\n \"contractId\": 1,\n \"creationTime\": 1731609680,\n \"orderId\": \"582869893300355075\",\n \"clientId\": null,\n \"orderType\": \"LIMIT\",\n \"price\": \"2384.689923\",\n \"side\": \"ASK\",\n \"status\": \"PLACED\",\n \"symbol\": \"ETH/USDT-P\",\n \"totalQuantity\": \"0.161019613\"\n }\n]"}],"_postman_id":"3243f8a0-086c-44c5-ab8a-71bbb7bab403"},{"name":"/trade/order","id":"096a8854-b918-4de8-8731-b2a28d26b96d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api-staging.hibachi.xyz/trade/order?orderId=580604712937324546&accountId=","description":"

Usage

Get the details about one particular order.

Required Query Parameter

accountId
\n
Order identifier - exactly one of:
\n
- orderId: should be the orderId returned by /trade/order or /trade/orders
  \n
- clientId: please see the documentation in POST /trade/order for more details
  \n
- nonce used when submitting the order
  \n
\n

Usage

Submit a new order.

In the response, it will return the order_id for this new order.

Signing

Use below field to sign the message and pass it in to signature field (65 bytes) Refer to the Signing section for more context

nonce
\n
contractId
\n
quantity
\n
side
\n
price
\n
maxFeesPercent, should be at least the returned value of /market/exchange-info endpoint. Otherwise, it will be rejected.
\n
creationDeadline (Optional)
\n
triggerPrice (Optional)
\n

Required Request Body Fields:

accountId : your account ID, you can get this on \"API Keys\" panel
\n
symbol:should be one of the symbol from one of the futureContracts returned by /market/exchange-info API
\n
nonce: should be a unix timestamp in miliseconds or microseconds, and it must be unique to this order
\n
side: should be one of: ASK, BID
\n
orderType
\n
quantity
\n
price
\n
signature
\n
maxFeesPercent
\n

Optional Request Body Fields

creationDeadline
\n
triggerPrice
\n
twapConfig
\n
orderFlags
\n
clientId
\n

About order client ID

A user may provide a clientId when creating an order. This ID can then be used to query, modify, or cancel that order.

A valid clientId must meet the following requirements:

Length is between 1 and 32 characters (inclusive).
\n
Contains only:
\n
- ASCII letters (A–Z, a–z)
  \n
- ASCII digits (0–9)
  \n
- The dash character (-)
  \n
\n
Must be unique among your orders.
\n

Notes:

The clientId is case-sensitive.
\n
Uniqueness is checked against active and recently inactive orders. While it may be technically possible to reuse a clientId from an older order, reuse is strongly discouraged.
\n

Usage

Submit multiple new order requests for an account. Supports place, and modify .

The format is identical to POST /trade/order, the only differences are:

accountId is specified in the top-level only once rather than for each order
\n
each order element needs to have an action field which can be either place, or modify
\n

It will return a list of responses – one for each order in the input.

Signing

Use below field to sign the message and pass it in to signature field (65 bytes). Refer to the Signing section for more context.

nonce
\n
contractId
\n
quantity
\n
side
\n
price
\n
maxFeesPercent, should be at least the value returned from /market/exchange-info endpoint, otherwise, it will be rejected.
\n
creationDeadline (Optional)
\n
triggerPrice (Optional)
\n

Request Body Required Fields:

accountId :should be one of: LIMIT, MARKET
\n
symbol:should be one of the symbol from one of the futureContracts returned by /market/exchange-info API
\n
nonce: should be a unix timestamp either ms or us unique to this order
\n
side: should be one of: ASK, BID
\n
orderType
\n
quantity
\n
price
\n
signature
\n
action: should be place,or modify
\n
maxFeesPercent
\n

Optional Request Body Fields:

creationDeadline
\n
triggerPrice
\n
orderFlags
\n
clientId (See the documentation in POST /trade/order for more details)
\n

Usage

Modify an existing order.

Signing

Refer to the Signing section for more context

Request Body Required Fields:

Order identifier - exactly one of:
\n
- orderId: should be the orderId returned by /trade/order or /trade/orders
  \n
- clientId: please see the documentation in POST /trade/order for more details
  \n
- nonce : nonce used to create the order initially
  \n
\n
nonce : A new unique nonce timestamp (same as if you were placing a new order).
\n
You can only update quantity and price. The symbol must remain the same.
\n
signature
\n
maxFeesPercent: should be at least the value returned by the /market/exchange-info endpoint, otherwise, it will be rejected.
\n

For clientId , please see the documentation in POST /trade/order for more details.

Notes

You cannot modify an order that has been partially matched.

Usage

Remove an existing order.

Signing

Use below field to sign the message and pass it in to signature field (65 bytes). Refer to the Signing section for more context

Order identifier - exactly one of:
\n
- orderId: should be the orderId returned by /trade/order or /trade/orders
  \n
- clientId: please see the documentation in POST /trade/order
  \n
\n

Request Body Required Fields:

accountId
\n
Order identifier - exactly one of:
\n
- orderId: should be the orderId returned by /trade/order or /trade/orders
  \n
- clientId: please see the documentation in POST /trade/order for more details
  \n
\n

Usage

Allows you to batch cancel all open orders for an account.

Signing:

Refer to the Signing section for more context

nonce needs to be a unique valid timestamp nonce and needs to be used as the payload for signature

Request Body Required Fields

accountId
\n
nonce
\n
signature
\n

Optional Request Body Fields:

contractId

Usage

Set the custom leverage for one contract

Required Query Parameter

accountId
\n
symbol
\n
initialMarginRate: the inverse of leverage. (\"0.5\" means 2x leverage)
\n

Notes

The initialMarginRate must be between the default value and 1.

When you increase initialMarginRate, after that your initial margin should still be no more than your net equity.

\n","urlObject":{"protocol":"https","path":["trade","account","leverage"],"host":["api-test","hibachi","xyz"],"query":[],"variable":[]}},"response":[{"id":"c779af69-1f01-4ebc-9975-6423385c8673","name":"/trade/account/leverage","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"accountId\": 156,\n \"symbol\": \"BTC/USDT-P\",\n \"initialMarginRate\": \"0.6\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api-test.hibachi.xyz/trade/account/leverage"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Fri, 29 Aug 2025 18:06:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-RAY","value":"976dfb109ac9c985-IAD"},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers"},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers"},{"key":"vary","value":"accept-encoding"},{"key":"access-control-allow-credentials","value":"true"},{"key":"Content-Encoding","value":"gzip"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains; preload"},{"key":"expect-ct","value":"max-age=86400, enforce"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Server","value":"cloudflare"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"a28d8b6d-cc12-4b39-a540-57ebc707585b"}],"id":"d34f9797-9ca0-43d2-9c7f-0e45530a11e4","description":"

Signatures

All write operations (place orders, edit orders, cancel orders, withdraw requests) require signatures.

For self-managed accounts, these signatures use ECDSA with private keys derived from the user's seed phrase.
\n
For exchange-managed accounts, these signatures use HMAC with the secret created for a specific API key.
\n

Each operation has a specific method for generating the signature digest that needs to be signed. Each operation is detailed below. All numbers are formatted in big endian.

Place / Edit Order

Structure

The payload for placing or editing orders consists of the following. For editing and querying an order, you can use either the orderId ,nonce , or clientId field to refer to the order.

Nonce: 8 bytes
\n
- Current timestamp serving as a unique identifier for your order
  \n
- Nonce needs to be a milli-second or micro-second unix timestamp within +- 15 seconds of the current time
  \n
- Nonce needs to be unique per account (if you send two orders with the same nonce from the same account, they will be rejected by our API)
  \n
\n
Contract ID: 4 bytes
\n
Quantity: 8 bytes
\n
- See section on asset quantities for how these are computed
\n
Side: 4 bytes
\n
- Ask: 0
  \n
- Bid: 1
  \n
\n
Price (Optional): 8 bytes
\n
- Only applicable for limit orders
  \n
- See section on asset prices for how these are computed
  \n
\n
Price Limit (__Optional): 8 bytes
\n
- Only applicable for market orders
  \n
- Trades below/above it (depending on side of the order) would not be executed. If it is not provided for a order, a default priceLimit would be applied in exchange.)
  \n
\n
Max Fees: 8 bytes
\n
- Maximum fees allowed for order operation
  \n
- Denoted in basis points (e.g. 20 => 0.2% fee)
  \n
- For the current test phase, fees can be set to 0. Once we finalize fee models, this will change
  \n
\n
Creation Deadline (Optional):
\n
- If our system can not place the order by the deadline, the order will be rejected.
  \n
- This is useful if you are concerned about high network or system latency.
  \n
- The creationDeadline field should have the number of seconds since the Unix epoch as a floating point number.
  \n
- For trigger orders, the creation deadline is applied to the order when it is triggered.
  \n
\n
Trigger Price (Optional):
\n
- If present, indicates that this is a trigger order (also called stop order) that should be sent when the market price reaches the trigger price.
  \n
- When modifying trigger orders:
  \n
  - If order has been triggered, you should not set the updatedTriggerPrice field. You can modify the order like a regular limit order.
    \n
  - If the order has not been triggered yet, you should set the updatedTriggerPrice field with the new trigger price.
    \n
  - If the order has not been triggered yet, you can modify market orders to limit orders and vice-versa.
    \n
    - If updatedPrice is present, the order will be modified to a limit order with that price.
      \n
    - If updatedPrice is absent, the order will be modified to a market order.
      \n
    \n
  \n
- When triggered, the order ends up at the back of the queue for the price level.
  \n
\n
Trigger Direction (Optional):
\n
- This field is only handled for trigger orders.
  \n
- either \"HIGH\" or \"LOW\"
  \n
- If present, indicates which direction of price move a trigger order should be triggered. If the price is already above or below the specified triggerPrice / triggerDirection combo at the time of order entry or modification, the trigger order will be automatically triggered.
  \n
\n

// Triggered when price is below 99,900.\n{\n  \"symbol\": \"BTC/USDT-P\",\n  \"side\": \"ASK\",\n  \"nonce\": 1714701600000000,\n  \"quantity\": \"1 BTC\", \n  \"price\": \"100,000 USDT\",\n  \"maxFees\": 0,\n  \"triggerPrice\": \"99,900 USDT\",\n  \"triggerDirection\": \"LOW\",\n}\n// Triggered when price is above 99,900.\n{\n  \"symbol\": \"BTC/USDT-P\",\n  \"side\": \"BID\",\n  \"nonce\": 1714701600000000,\n  \"quantity\": \"1 BTC\", \n  \"price\": \"100,000 USDT\",\n  \"maxFees\": 0,\n  \"triggerPrice\": \"99,900 USDT\",\n  \"triggerDirection\": \"HIGH\",\n}\n// triggerDirection unspecified - determined automatically by the current mark price.\n// If current mark price < 99,900 USDT triggerDirection is HIGH and vice versa\n{\n  \"symbol\": \"BTC/USDT-P\",\n  \"side\": \"BID\",\n  \"nonce\": 1714701600000000,\n  \"quantity\": \"1 BTC\", \n  \"price\": \"100,000 USDT\",\n  \"maxFees\": 0,\n  \"triggerPrice\": \"99,900 USDT\",\n}\n\n

Parent Order (Optional):
\n
- This field is only handled for trigger orders.
  \n
- If present, indicates that this is a child trigger order that should be activated only after the parent order is at least partially filled.
  \n
- When the parent order receives a fill (even a partial fill), the child trigger order activates, converting into a normal trigger order.
  \n
- If the parent order is cancelled prior to being filled, all child trigger orders with that parent are also cancelled.
  \n
- Order creation / modification will fail if the parent order does not at the time of the request. For this reason, it is recommended that the batch order entry api be used.
  \n
- A nonce, orderId , or clientId can be used for the parent order
  \n
\n

{\n  \"symbol\": \"BTC/USDT-P\",\n  \"side\": \"ASK\",\n  \"nonce\": 1714701600000000,\n  \"quantity\": \"1 BTC\", \n  \"price\": \"100,000 USDT\",\n  \"maxFees\": 0,\n  \"triggerPrice\": \"99,900 USDT\",\n  \"parentOrder\": { \"nonce\": 113801600002000 }\n  // OR \"parentOrder\": { \"orderId\": 12344212441 }\n}\n\n

TWAP Duration (Optional)
\n
- If present, twapDurationMinutes is the duration of the TWAP (trade-weighted average price) order in minutes.
  \n
- This must be an integer between 1 and 60, inclusive.
  \n
- A child order is sent every 30 seconds during the duration.
  \n
\n
TWAP Quantity Mode (Optional)
\n
- If present, twapQuantityMode configures the quantities of the child orders:
  \n
  - If set to \"RANDOM\", the quantity is randomized.
    \n
  - If set to \"FIXED\", the total quantity of the TWAP order is evenly divided across child orders.
    \n
  \n
- If a child order is not fully filled, the unfilled quantity is rolled over into subsequent child orders.
  \n
\n
Order Flags (Optional)
\n
- Order flags are only supported for limit orders.
  \n
- If orderFlags has the value POST_ONLY, then this order is a post-only order, and will only add liquidity to the order book.
  \n
  - The max fee for post-only orders must be at least the maker fee.
    \n
  - If the order would match with the order book, the order will be rejected with rejectionReason \"PostOnlyOrderDoesNotAddLiquidity\". In the REST API, this can be seen by querying the order's status. In the WebSocket API, you will receive the \"order_request_rejected\" message.
    \n
  \n
- If orderFlags is \"IOC\", then this order is an immediate-or-cancel order, and will only take liquidity from the order book.
  \n
- If orderFlags is \"REDUCE_ONLY\", then this order is (for the time being) an IOC order that will only reduce your position.
  \n
\n

TWAP orders

Querying TWAP orders yields the \"SCHEDULED_TWAP\" order status, which has the following additional fields:

numOrdersRemaining is the number of child orders that will be sent in the future.
\n
numOrdersTotal is the total number of child orders (including past and future orders).
\n
quantityMode is the TWAP quantity mode.
\n

You can cancel TWAP orders, but you can not edit them. For TWAP orders, child orders will execute within 5% of the price at the time when the original TWAP order was sent.

TP/SL orders

A take profit (TP) or stop loss (SL) order is defined as a reduce only stop-market (trigger) order. The following fields are relevant for TP/SL orders

(required) triggerPrice TP/SL orders are trigger orders
\n
(required) \"orderFlags\": \"REDUCE_ONLY\" TP/SL orders are reduce only
\n
(suggested) parentOrder TP/SL orders can be entered alongside parent orders to trigger only after a fill. See parentOrder documentation for more details
\n
(suggested) triggerDirection It is safest to specify direction, especially when mark price is very close to the current trigger price. See triggerDirection documentation for more details.
\n

When a position is completely closed, all TP/SL orders in that position are automatically cancelled.

Example

Let's assume we want to place the following order

{\n  \"symbol\": \"BTC/USDT-P\",\n  \"side\": \"ASK\",\n  \"nonce\": 1714701600000000,\n  \"quantity\": \"1 BTC\", \n  \"price\": \"100,000 USDT\",\n  \"maxFees\": 0,\n}\n\n

and that /exchange-info has returned this contract information

{\n  \"symbol\": \"BTC/USDT-P\",\n  \"id\": 2,\n  \"underlyingDecimals\": 10,\n  \"underlyingSymbol\": \"BTC\",\n  \"settlementDecimals\": 6,\n  \"settlementSymbol\": \"USDT\",\n}\n\n

Given the above, we can compute quantity and price:

Quantity: 1 BTC x 10^10 = 10,000,000,000 since underlyingDecimals: 10
\n
Price: 100,000 USDT x 2^32 x 10^(6 - 10 = -4) = 42,949,672,960 since priceMultiplier: 2^32 and settlementDecimals - underlyingDecimals = 6 - 10 = -4
\n

Using these numbers, we can compute the elements of the buffer as:

Nonce 1714701600000000 => 0x0006178313c38800
\n
ContractId: 2 => 0x00000002
\n
Quantity: 10000000000 => 0x00000002540be400
\n
Side: ASK => 0x00000000
\n
Price: 42949672960 => 0x0000000a00000000
\n
Fees: 0 bps => 0x0000000000000000
\n

Concatenating these elements gives us a buffer of: 0x0006178313c388000000000200000002540be400000000000000000a000000000000000000000000

If exchange managed, we would sign this order using HMAC

const hmacSignature = crypto\n        .createHmac('sha256', 'YOUR-SECRET-KEY')\n        .update(buffer)\n        .digest('hex');\n\n

If self-managed, we would sign using ECDSA

const msgHash = ethers.sha256(buffer).slice(2);\nconst ecdsaSignature = ec.sign(msgHash, 'hex', { canonical: true });\n\n

This results in the final order payload:

{\n  \"accountId\": \"<AccountId>\",\n  \"symbol\":\"BTC/USDT-P\",\n  \"side\":\"ASK\",\n  \"orderType\":\"LIMIT\",\n  \"quantity\":\"1\",\n  \"price\":\"100000\"\n  \"signature\": \"<HMAC/ECDSA signature of 0x00061..200000002540be40..0000>\"\n}\n\n

Cancel Order

For order cancellations, you simply need to sign the 64-bit orderId or nonce for the original order. You can use the nonce, clientId, or orderId to refer to the order.

For example, the place order operation above could result in a response payload like

{\n  \"order_id\":\"579183763093760000\"\n}\n\n

If we wanted to cancel this order, we'd need to sign 579183763093760000 as 8 bytes, which would map to 0x0809ac905ae0a800

Cancelling all orders

You can also cancel all orders by sending an HTTP delete to the /trade/orders endpoint with the account ID, a nonce, and signature signed on the nonce.

\n","_postman_id":"d34f9797-9ca0-43d2-9c7f-0e45530a11e4","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":true,"source":{"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","name":"Account API","type":"folder"}}}],"id":"fd6291b1-bd66-43a7-a3d5-833e4661954b","description":"

You can use Account API to:

Query and move information related to funds: /capital
\n
Trade and view orders: /trade
\n

\n","auth":{"type":"apikey","apikey":{"value":"{{vault:authorization-secret}}","key":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"510ba33f-10c3-4a21-b517-882705ed29bc","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"dd66eaee-62a5-4440-8186-c49f63e6ae6d","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"fd6291b1-bd66-43a7-a3d5-833e4661954b"},{"name":"Market API","item":[{"name":"Exchange Listings","item":[{"name":"/market/exchange-info","id":"183981da-8df5-40a0-a155-da15015dd536","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/exchange-info","description":"

Usage

Return exchange metadata, currently it will return all futureContracts.

Also returns a list of exchange maintenance windows in the \"maintenanceWindow\" field. For each window, the fields \"begin\" and \"end\" denote the beginning and end of the window, in seconds since the UNIX epoch. The field \"note\" contains a note.

The field \"maintenanceStatus\" can have the values \"NORMAL\", \"UNSCHEDULED_MAINTENANCE\", \"SCHEDULED_MAINTENANCE\". If the exchange is currently under scheduled maintenance, the field \"currentMaintenanceWindow\" displays information on the current maintenance window.

\n","urlObject":{"path":["market","exchange-info"],"host":["https://data-api-staging.hibachi.xyz"],"query":[],"variable":[]}},"response":[{"id":"c7d1da06-6a96-4151-8128-77f804cc43f5","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/exchange-info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:47:31 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=37ZawZfqGxaM1oCjv/afHBoKPVCeW+ILUOQ+dZdaVNgudOq4Z5JpzdehuA1TwVHHNDCB7CPf+gvA9zzNAB+akTWTGunMuJ5q0A7+bQ5jipaa/vJ/ykrwu/MMlMx7; Expires=Tue, 16 Apr 2024 19:47:31 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=37ZawZfqGxaM1oCjv/afHBoKPVCeW+ILUOQ+dZdaVNgudOq4Z5JpzdehuA1TwVHHNDCB7CPf+gvA9zzNAB+akTWTGunMuJ5q0A7+bQ5jipaa/vJ/ykrwu/MMlMx7; Expires=Tue, 16 Apr 2024 19:47:31 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d026c6fb753ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"feeConfig\": {\n \"depositFees\": \"0.000237\",\n \"instantWithdrawDstPublicKey\": \"cdea137cc5a43defb707ba87ede6adfa0b1f560bf673bb804fcd5743f41353a5492a17aa3dc05b9941bf4c59a63999a1d266943a5115fd1c60cd28e5df45abf9\",\n \"instantWithdrawalFees\": [\n [\n 1000,\n 0.005\n ],\n [\n 500,\n 0.01\n ],\n [\n 0,\n 0.02\n ]\n ],\n \"tradeMakerFeeRate\": \"0.00015000\",\n \"tradeTakerFeeRate\": \"0.00045000\",\n \"transferFeeRate\": \"0.00010000\",\n \"withdrawalFees\": \"0.000237\"\n },\n \"futureContracts\": [\n {\n \"displayName\": \"BTC/USDT Perps\",\n \"id\": 2,\n \"live\": true,\n \"minNotional\": \"1\",\n \"minOrderSize\": \"0.0000000001\",\n \"orderbookGranularities\": [\n \"0.1\",\n \"1\",\n \"10\",\n \"100\"\n ],\n \"initialMarginRate\": \"0.500000\",\n \"maintenanceMarginRate\": \"0.400000\",\n \"settlementDecimals\": 6,\n \"settlementSymbol\": \"USDT\",\n \"stepSize\": \"0.0000000001\",\n \"symbol\": \"BTC/USDT-P\",\n \"tickSize\": \"0.00001\",\n \"underlyingDecimals\": 10,\n \"underlyingSymbol\": \"BTC\",\n \"marketCreationTimestamp\": \"1727701319.73488\"\n },\n {\n \"displayName\": \"ETH/USDT Perps\",\n \"id\": 1,\n \"live\": true,\n \"minNotional\": \"1\",\n \"minOrderSize\": \"0.000000001\",\n \"orderbookGranularities\": [\n \"0.01\",\n \"0.1\",\n \"1\",\n \"10\"\n ],\n \"initialMarginRate\": \"0.500000\",\n \"maintenanceMarginRate\": \"0.400000\",\n \"settlementDecimals\": 6,\n \"settlementSymbol\": \"USDT\",\n \"stepSize\": \"0.000000001\",\n \"symbol\": \"ETH/USDT-P\",\n \"tickSize\": \"0.000001\",\n \"underlyingDecimals\": 9,\n \"underlyingSymbol\": \"ETH\",\n \"marketCreationTimestamp\": \"1727701319.73488\"\n },\n {\n \"displayName\": \"SOL/USDT Perps\",\n \"id\": 3,\n \"live\": true,\n \"minNotional\": \"1\",\n \"minOrderSize\": \"0.00000001\",\n \"orderbookGranularities\": [\n \"0.001\",\n \"0.01\",\n \"0.1\",\n \"1\"\n ],\n \"initialMarginRate\": \"0.500000\",\n \"maintenanceMarginRate\": \"0.400000\",\n \"settlementDecimals\": 6,\n \"settlementSymbol\": \"USDT\",\n \"stepSize\": \"0.00000001\",\n \"symbol\": \"SOL/USDT-P\",\n \"tickSize\": \"0.0000001\",\n \"underlyingDecimals\": 8,\n \"underlyingSymbol\": \"SOL\",\n \"marketCreationTimestamp\": \"1727701319.73488\"\n }\n ],\n \"maintenanceWindow\": [],\n \"status\": \"NORMAL\"\n}"}],"_postman_id":"183981da-8df5-40a0-a155-da15015dd536"},{"name":"/market/inventory","id":"85b3dfe2-0cdc-42c9-8d71-aa38e4b3edda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/inventory","description":"

Usage

Similar to /market/exchange-info, except in addition to the contract metadata this endpoint will return price information

\n","urlObject":{"path":["market","inventory"],"host":["https://data-api-staging.hibachi.xyz"],"query":[],"variable":[]}},"response":[{"id":"70674652-c056-404d-bb79-1a130a62d23d","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:48:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=uYnRZSw6ZXJlmG7TrlSxARR9SF2HuCpw2tLegFsdtL3+AnQhLQPxEQkUBIfDePqm16EFjYxRZ7rs5w1pKj3jfGem2S9f98+qkTJbWu7WY59ScULWnXicCQVvmHGN; Expires=Tue, 16 Apr 2024 19:48:20 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=uYnRZSw6ZXJlmG7TrlSxARR9SF2HuCpw2tLegFsdtL3+AnQhLQPxEQkUBIfDePqm16EFjYxRZ7rs5w1pKj3jfGem2S9f98+qkTJbWu7WY59ScULWnXicCQVvmHGN; Expires=Tue, 16 Apr 2024 19:48:20 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d039ba82553ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"feeConfig\": {\n \"depositFees\": \"0.000237\",\n \"instantWithdrawDstPublicKey\": \"cdea137cc5a43defb707ba87ede6adfa0b1f560bf673bb804fcd5743f41353a5492a17aa3dc05b9941bf4c59a63999a1d266943a5115fd1c60cd28e5df45abf9\",\n \"instantWithdrawalFees\": [\n [\n 1000,\n 0.005\n ],\n [\n 500,\n 0.01\n ],\n [\n 0,\n 0.02\n ]\n ],\n \"tradeMakerFeeRate\": \"0.00015000\",\n \"tradeTakerFeeRate\": \"0.00045000\",\n \"transferFeeRate\": \"0.00010000\",\n \"withdrawalFees\": \"0.000237\"\n },\n \"markets\": [\n {\n \"contract\": {\n \"displayName\": \"BTC/USDT Perps\",\n \"id\": 2,\n \"live\": true,\n \"minNotional\": \"1\",\n \"minOrderSize\": \"0.0000000001\",\n \"orderbookGranularities\": [\n \"0.1\",\n \"1\",\n \"10\",\n \"100\"\n ],\n \"initialMarginRate\": \"0.500000\",\n \"maintenanceMarginRate\": \"0.400000\",\n \"settlementDecimals\": 6,\n \"settlementSymbol\": \"USDT\",\n \"stepSize\": \"0.0000000001\",\n \"symbol\": \"BTC/USDT-P\",\n \"tickSize\": \"0.00001\",\n \"underlyingDecimals\": 10,\n \"underlyingSymbol\": \"BTC\"\n },\n \"info\": {\n \"category\": null,\n \"markPrice\": \"60688.14161\",\n \"price24hAgo\": \"62220.01831\",\n \"priceLatest\": \"60638.78740\",\n \"tags\": []\n }\n },\n {\n \"contract\": {\n \"displayName\": \"ETH/USDT Perps\",\n \"id\": 1,\n \"live\": true,\n \"minNotional\": \"1\",\n \"minOrderSize\": \"0.000000001\",\n \"orderbookGranularities\": [\n \"0.01\",\n \"0.1\",\n \"1\",\n \"10\"\n ],\n \"initialMarginRate\": \"0.500000\",\n \"maintenanceMarginRate\": \"0.400000\",\n \"settlementDecimals\": 6,\n \"settlementSymbol\": \"USDT\",\n \"stepSize\": \"0.000000001\",\n \"symbol\": \"ETH/USDT-P\",\n \"tickSize\": \"0.000001\",\n \"underlyingDecimals\": 9,\n \"underlyingSymbol\": \"ETH\"\n },\n \"info\": {\n \"category\": null,\n \"markPrice\": \"2371.199740\",\n \"price24hAgo\": \"2443.006397\",\n \"priceLatest\": \"2367.785983\",\n \"tags\": []\n }\n },\n {\n \"contract\": {\n \"displayName\": \"SOL/USDT Perps\",\n \"id\": 3,\n \"live\": true,\n \"minNotional\": \"1\",\n \"minOrderSize\": \"0.00000001\",\n \"orderbookGranularities\": [\n \"0.001\",\n \"0.01\",\n \"0.1\",\n \"1\"\n ],\n \"initialMarginRate\": \"0.500000\",\n \"maintenanceMarginRate\": \"0.400000\",\n \"settlementDecimals\": 6,\n \"settlementSymbol\": \"USDT\",\n \"stepSize\": \"0.00000001\",\n \"symbol\": \"SOL/USDT-P\",\n \"tickSize\": \"0.0000001\",\n \"underlyingDecimals\": 8,\n \"underlyingSymbol\": \"SOL\"\n },\n \"info\": {\n \"category\": null,\n \"markPrice\": \"139.6038176\",\n \"price24hAgo\": \"143.5201703\",\n \"priceLatest\": \"139.4504197\",\n \"tags\": []\n }\n }\n ]\n}"}],"_postman_id":"85b3dfe2-0cdc-42c9-8d71-aa38e4b3edda"}],"id":"b5c6a3bc-243d-4d35-b6d4-a74c92495434","description":"

The exchange listings endpoints expose all markets that are currently listed on Hibachi with their relevant market info.

The primary API endpoint is/market/exchange-info which exposes the raw markets and their trading configuration and also fees information associated with the Hibachi exchange. The status field in this endpoint can have the values \"LIVE\", \"PAUSED\", or \"CLOSED\".

There is an additional /market/inventory endpoint which is aimed primarily for client side usage and exposes some loose market stats (like 24h percentage change) in addition to the raw configs.

We recommend using /market/exchange-info for any automated trading activity, since its latency does not get affected by supplemental stats.

If you're looking to get specific stats on markets, the Market Data endpoints are much more comprehensive and better suited for such a use case.

Asset Quantities

All quantities on Hibachi are represented internally as 64-bit numbers.

In order to enable trading fractional quantities (e.g. 0.01 BTC), each asset on Hibachi as a specific fixed number of decimals.

Example:

BTC may be represented with 10 decimals
\n
This means 1 BTC is stored as 1 x 10^10 = 10,000,000 quantity on the exchange.
\n

When making trades, querying positions and similar, Hibachi will still expose and expect numbers as \"real\" float strings (e.g. \"quantity: 1.0\" for 1 BTC).

This way, users don't need to constantly convert numbers in order to be able to reason about them. However, this quantity notation is important when:

Signing any operations (trades, withdrawals, etc) since we want the traders to specify exactly what they want to trade and not leave room for misinterpretations. Please make sure to use correct fees when signinging , otherwise, the request will be rejected.
\n
Interacting with the Hibachi smart contracts
\n

The number of decimals is exposed for each contract in the /market/exchange-info endpoint response under the underlyingDecimals field.

Asset Prices

Like quantities, asset prices are also 64-bit numbers that conform to decimals. Prices are used when converting between underlying and settlement token in a market.

For example, on BTC/USDT-P a price of 100,000 may be used in a limit order to indicate that somebody is wiling to sell BTC for 100,000 USDT per BTC. Price is always denoted in units of the settlementAsset.

Since both the underlying and settlement assets have unique quantity decimals, the price is stored in the difference between both decimals (settlementDecimals - underlyingDecimals).

In order to support higher resolution of prices, an additional price multiplier of 2^32 is used to represent prices as fixed-point decimals with 32 bits after the decimal point.

Example:

Let's assume somebody wants to sell BTC/USDT-P for 100,000 USDT per BTC
\n
In this case, /exchange-info endpoint for this market has returned
\n

{\n  \"symbol\": \"BTC/USDT-P\",\n  \"id\": 2,\n  \"underlyingDecimals\": 10,\n  \"underlyingSymbol\": \"BTC\",\n  \"settlementDecimals\": 6,\n  \"settlementSymbol\": \"USDT\",\n}\n\n

This means that settlementDecimals - underlyingDecimals = 6 - 10 = -4
\n
Converting our price of 100,000 USDT can be done using
\n

price_hibachi = price_raw x 10^(settlement_decimals - underlying_decimals) x price_multiplier\npirce_hibachi = 100,000 x 10^(6 - 10 = -4) x 2^32 = 42949672960\n\n

Fees

Hibachi charges fees for the following actions:

Trade: Fees are based on the notional value of an execution. Makers and takers pay different rates; tradeMakerFeeRate in the returned JSON indicates the rate for makers and tradeTakerFeeRate indicates the rate for takers. Hibachi determines the maker/taker status based on which side is the sitting order in the match, the sitting order side would be maker. Rates from /exchange-info are in units of 1, so 0.0002 means 0.02%. When signing orders, clients should use the maximum of tradeTakerFeeRate and tradeMakerFeeRate. Hibachi will charge a corresponding rate based on the taker/maker side of the trade.
\n
Transfer: Fees are based on the notional value of a transfer, with the rate specified by transferFeeRate from /exchange-info. The unit is 1 , so 0.0001 means 1 basis point (0.01%).
\n
Deposit : Hibachi charges fees to cover the gas costs for relaying deposits. The value (depositFees) from /exchange-info is in units of 1 USDT. Self-managed accounts are exempt from this fee. These fees vary dynamically with current gas fees and ether prices. Client should use some value like 1.2 x depositFees as the gast cost could change, Hibachi will charge the actual cost.
\n
Withdrawal: Hibachi charges fees to cover the gas costs for relaying withdrawals. The value (withdrawal fees) from /exchange-info is in units of 1 USDT, so 1.369258 means 1.369258 USDT. These fees also vary dynamically with current gas fees and ether prices. Client should use some value like 1.2 x depositFees as the gast cost could change, Hibachi will charge the actual cost.
\n
Instant withdrawal Fees:
1. We provide the instantWithdrawDstPublicKey in feeConfig, you need to use this for the instant withdrawal request.
2. instantWithdrawalFees provides fee information. The instantWithdrawalFees has a list of [threshold, rates]. Clients should use the maxium one that withdrawed quantity >= threshold, for example, in the example below, if the withdraw quanity is 2000, we should use 0.005 as the fee; if the withdraw quantity is 500, we should use 0.01.
\n

    \"feeConfig\": {\n        \"depositFees\": \"0.293585\",\n        \"instantWithdrawDstPublicKey\": \"88888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888888\",\n        \"instantWithdrawalFees\": [\n            [\n                1000,\n                0.005\n            ],\n            [\n                500,\n                0.01\n            ],\n            [\n                0,\n                0.02\n            ]\n        ],\n        \"tradeMakerFeeRate\": \"0.00020000\",\n        \"tradeTakerFeeRate\": \"0.00050000\",\n        \"transferFeeRate\": \"0.00010000\",\n        \"withdrawalFees\": \"0.293585\"\n    },\n\n

\n","_postman_id":"b5c6a3bc-243d-4d35-b6d4-a74c92495434"},{"name":"Market Data","item":[{"name":"/market/data/prices","id":"bca696ca-b9b2-4072-8864-5d6b8c09807e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/prices?symbol=ETH/USDT-P","description":"

Usage

Get the price and funding information for a future contract.

Required Query Parameter

symbol: the symbol of the contract you get in the response from /market/exchange-info endpoint

\n","urlObject":{"path":["market","data","prices"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"ETH/USDT-P"}],"variable":[]}},"response":[{"id":"700dd81f-dbed-472a-b18b-2e44fb7aab99","name":"Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/prices?symbol=ETH/USDT-P","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","prices"],"query":[{"key":"symbol","value":"ETH/USDT-P"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:48:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=s+rdTBFxH6pL8Trl30nsqzI2HjTH883MYI4t3cAIC9gyPYQv/sQo/I4qfeHjigtGHA3flwHNUpU75PFfF/wy10ymqmeNObxUilV8dhfjH9aTkgUnDoh+WyYgGZUQ; Expires=Tue, 16 Apr 2024 19:48:47 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=s+rdTBFxH6pL8Trl30nsqzI2HjTH883MYI4t3cAIC9gyPYQv/sQo/I4qfeHjigtGHA3flwHNUpU75PFfF/wy10ymqmeNObxUilV8dhfjH9aTkgUnDoh+WyYgGZUQ; Expires=Tue, 16 Apr 2024 19:48:47 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d04478d0853ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"askPrice\": \"3514.650296\",\n \"bidPrice\": \"3513.596112\",\n \"fundingRateEstimation\": {\n \"estimatedFundingRate\": \"0.000001\",\n \"nextFundingTimestamp\": 1712707200\n },\n \"markPrice\": \"3514.288858\",\n \"spotPrice\": \"3514.715000\",\n \"symbol\": \"ETH/USDT-P\",\n \"tradePrice\": \"2372.746570\"\n}"}],"_postman_id":"bca696ca-b9b2-4072-8864-5d6b8c09807e"},{"name":"/market/data/stats","id":"0064ca53-a2d0-41b9-8ade-6b2abf4ccb12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/stats?symbol=ETH/USDT-P","description":"

Usage

Get general trading stats like 24h high/low/volume for a future contract.

Required Query Parameter

symbol: the symbol of the contrat you get in the response from /market/exchange-info endpoint

\n","urlObject":{"path":["market","data","stats"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"ETH/USDT-P"}],"variable":[]}},"response":[{"id":"6368b722-2447-4734-a9ab-114883eb7863","name":"Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/stats?symbol=ETH/USDT-P","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","stats"],"query":[{"key":"symbol","value":"ETH/USDT-P"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:48:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=s+rdTBFxH6pL8Trl30nsqzI2HjTH883MYI4t3cAIC9gyPYQv/sQo/I4qfeHjigtGHA3flwHNUpU75PFfF/wy10ymqmeNObxUilV8dhfjH9aTkgUnDoh+WyYgGZUQ; Expires=Tue, 16 Apr 2024 19:48:47 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=s+rdTBFxH6pL8Trl30nsqzI2HjTH883MYI4t3cAIC9gyPYQv/sQo/I4qfeHjigtGHA3flwHNUpU75PFfF/wy10ymqmeNObxUilV8dhfjH9aTkgUnDoh+WyYgGZUQ; Expires=Tue, 16 Apr 2024 19:48:47 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d04478d0853ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"high24h\": \"3819.507827\",\n \"low24h\": \"3754.474162\",\n \"symbol\": \"ETH/USDT-P\",\n \"volume24h\": \"23554.858590416\"\n}"}],"_postman_id":"0064ca53-a2d0-41b9-8ade-6b2abf4ccb12"},{"name":"/market/data/trades","id":"86a53bc1-d3bb-4b93-8a11-7034d4698caa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/trades?symbol=ETH/USDT-P","description":"

Usage

Get the most recent trades from all users for one future contract.

It will return most recent up to 100 records.

Required Query Parameter

symbol: the symbol of the contrat you get in the response from /market/exchange-info endpoint

\n","urlObject":{"path":["market","data","trades"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"ETH/USDT-P"}],"variable":[]}},"response":[{"id":"c2ef3c8e-5a9d-4174-9a9f-a7dc3f75d685","name":"Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/trades?symbol=ETH/USDT-P","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","trades"],"query":[{"key":"symbol","value":"ETH/USDT-P"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:49:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=gylVDILASAX4rnztvBIxWWIA6Cszj9Qcvcolt7zbFTEjT9RsO16qu89QyrTrqvqF2/qsEcrRj/31vEwVA41m1ghvQKD/0WucwmW/s/bLsDJUQ1Y87tjwIbTmaHsg; Expires=Tue, 16 Apr 2024 19:49:10 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=gylVDILASAX4rnztvBIxWWIA6Cszj9Qcvcolt7zbFTEjT9RsO16qu89QyrTrqvqF2/qsEcrRj/31vEwVA41m1ghvQKD/0WucwmW/s/bLsDJUQ1Y87tjwIbTmaHsg; Expires=Tue, 16 Apr 2024 19:49:10 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d04d288ab53ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"trades\": [\n {\n \"price\": \"3512.431902\",\n \"quantity\": \"1.414780098\",\n \"takerSide\": \"Buy\",\n \"timestamp\": 1712692147\n },\n {\n \"price\": \"3512.783321\",\n \"quantity\": \"1.138242707\",\n \"takerSide\": \"Sell\",\n \"timestamp\": 1712692147\n }\n ]\n}"}],"_postman_id":"86a53bc1-d3bb-4b93-8a11-7034d4698caa"},{"name":"/market/data/klines","id":"4f0eacec-c61e-4d51-afb3-23c51c2c6bac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/klines?symbol=ETH/USDT-P&interval=1h&fromMs=&toMs=","description":"

Usage

Get the candlesticks for a futures contract.

Required Query Parameters

symbol: the symbol of the contrat you get in the response from /market/exchange-info endpoint
\n
interval: Supported intervals: 1min, 5min, 15min, 1h, 4h, 1d, 1w.
\n

Optional Query Parameters

fromMs: the start time in Unix millisecond timestamp of the period you want to retrieve candlesticks
\n
toMs: the end time in Unix milisecond timestamp of the period you want to retrieve candlesticks
\n

\n","urlObject":{"path":["market","data","klines"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"ETH/USDT-P"},{"key":"interval","value":"1h"},{"description":{"content":"

Optional

\n","type":"text/plain"},"key":"fromMs","value":""},{"description":{"content":"

Optional

\n","type":"text/plain"},"key":"toMs","value":""}],"variable":[]}},"response":[{"id":"972c1551-e8a3-4707-b4b1-4a9fdcf5a49e","name":"Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/klines?symbol=ETH/USDT-P&interval=1h","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","klines"],"query":[{"key":"symbol","value":"ETH/USDT-P"},{"key":"interval","value":"1h"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:49:35 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=AnCuowFNO0ftGG6a5dgISanB/Q7MRYDwPmSfXN/wW7pk3j/+17q09hJ5z7l3DKiyo7IaXeo1i6pJvvgk9Rp8EAzg9kupjO5D9e316QOdC9BB+XeY7Nd/I2fqd4QT; Expires=Tue, 16 Apr 2024 19:49:35 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=AnCuowFNO0ftGG6a5dgISanB/Q7MRYDwPmSfXN/wW7pk3j/+17q09hJ5z7l3DKiyo7IaXeo1i6pJvvgk9Rp8EAzg9kupjO5D9e316QOdC9BB+XeY7Nd/I2fqd4QT; Expires=Tue, 16 Apr 2024 19:49:35 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d056f3ffb53ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"klines\": [\n {\n \"close\": \"3704.751036\",\n \"high\": \"3716.530378\",\n \"interval\": \"1h\",\n \"low\": \"3699.627883\",\n \"open\": \"3716.406894\",\n \"timestamp\": 1712628000,\n \"volumeNotional\": \"1637355.846362\"\n },\n {\n \"close\": \"3693.029781\",\n \"high\": \"3717.863717\",\n \"interval\": \"1h\",\n \"low\": \"3682.131347\",\n \"open\": \"3706.001256\",\n \"timestamp\": 1712631600,\n \"volumeNotional\": \"3590375.750775\"\n }\n ]\n}"}],"_postman_id":"4f0eacec-c61e-4d51-afb3-23c51c2c6bac"},{"name":"/market/data/open-interest","id":"bc34e8ae-e094-4802-8d56-3efe3a7bad49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/open-interest?symbol=ETH/USDT-P","description":"

Usage

Get the open interest for one futures contract.

It will return the total open interest from each side.

Required Query Parameter

symbol: the symbol of the contrat you get in the response from /market/exchange-info endpoint

\n","urlObject":{"path":["market","data","open-interest"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"ETH/USDT-P"}],"variable":[]}},"response":[{"id":"0246a44e-1f0d-4cd1-93b0-ffa9f51a49a8","name":"Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/open-interest?symbol=ETH/USDT-P","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","open-interest"],"query":[{"key":"symbol","value":"ETH/USDT-P"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:49:56 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=vx+edEHAA45zQK4M4Z4ofSvMT04khzBQx6ZaXzVe1nTyzlmneV5DddbGEWjYegmlKPNNku8z0a1ijKzYRLZpSOcizw01JN8piyCNAKcE8sGbIiQHfTYXxtE+/Wzm; Expires=Tue, 16 Apr 2024 19:49:56 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=vx+edEHAA45zQK4M4Z4ofSvMT04khzBQx6ZaXzVe1nTyzlmneV5DddbGEWjYegmlKPNNku8z0a1ijKzYRLZpSOcizw01JN8piyCNAKcE8sGbIiQHfTYXxtE+/Wzm; Expires=Tue, 16 Apr 2024 19:49:56 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d05f59e7453ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"totalQuantity\": \"6.326719254\"\n}"}],"_postman_id":"bc34e8ae-e094-4802-8d56-3efe3a7bad49"},{"name":"/market/data/orderbook","id":"c7a64b0d-9e37-4009-93e5-2aa12e8d7e9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/orderbook?symbol=ETH/USDT-P&depth=3&granularity=0.01","description":"

Usage

Get the orderbook price levels.

It will return up to depth price levels on both side. The price level will be aggreated based on granulairty.

Required Request Query Parameters

symbol: the symbol of the contrat you get in the response from /market/exchange-info endpoint

Optional Request Query Parameters

depth should be between 1 and 100, inclusive.
\n
granularity should be one of the values in orderbookGranularities returned by market/exchange-info. Different contracts may have different orderbookGranularities.
\n

\n","urlObject":{"path":["market","data","orderbook"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"ETH/USDT-P"},{"key":"depth","value":"3"},{"key":"granularity","value":"0.01"}],"variable":[]}},"response":[{"id":"516787d4-e784-4219-b9f9-23967d210afe","name":"Example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/orderbook?symbol=ETH/USDT-P&depth=3&granularity=0.01","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","orderbook"],"query":[{"key":"symbol","value":"ETH/USDT-P"},{"key":"depth","value":"3"},{"key":"granularity","value":"0.01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Apr 2024 19:50:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"set-cookie","value":"AWSALB=uJUdt/dupAikg5HjVq3+wKgeQmwZ1EDMCnKFC1H8Qq5aMFxH1borNxrRwryiCv+4KkEd0BWkwaZVekAr17fRjwq9tpKN8HJZruGUCOhtDRQiHtvPBZen35qA9KBK; Expires=Tue, 16 Apr 2024 19:50:44 GMT; Path=/","enabled":true},{"key":"set-cookie","value":"AWSALBCORS=uJUdt/dupAikg5HjVq3+wKgeQmwZ1EDMCnKFC1H8Qq5aMFxH1borNxrRwryiCv+4KkEd0BWkwaZVekAr17fRjwq9tpKN8HJZruGUCOhtDRQiHtvPBZen35qA9KBK; Expires=Tue, 16 Apr 2024 19:50:44 GMT; Path=/; SameSite=None; Secure","enabled":true},{"key":"access-control-allow-origin","value":"*","enabled":true},{"key":"vary","value":"origin, access-control-request-method, access-control-request-headers","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true},{"key":"CF-Cache-Status","value":"DYNAMIC","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Server","value":"cloudflare","enabled":true},{"key":"CF-RAY","value":"871d071e1a2d53ea-ATL","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"ask\": {\n \"endPrice\": \"3512.63\",\n \"levels\": [\n {\n \"price\": \"3511.93\",\n \"quantity\": \"0.284772482\"\n },\n {\n \"price\": \"3512.28\",\n \"quantity\": \"0.569544964\"\n },\n {\n \"price\": \"3512.63\",\n \"quantity\": \"0.854317446\"\n }\n ],\n \"startPrice\": \"3511.93\"\n },\n \"bid\": {\n \"endPrice\": \"3510.87\",\n \"levels\": [\n {\n \"price\": \"3515.39\",\n \"quantity\": \"2.345153070\"\n },\n {\n \"price\": \"3511.22\",\n \"quantity\": \"0.284772482\"\n },\n {\n \"price\": \"3510.87\",\n \"quantity\": \"0.569544964\"\n }\n ],\n \"startPrice\": \"3515.39\"\n }\n}"}],"_postman_id":"c7a64b0d-9e37-4009-93e5-2aa12e8d7e9b"},{"name":"/market/data/funding-rates","id":"079586af-0d94-41ea-99bb-7afcd93bf438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/market/data/funding-rates?symbol=BTC/USDT-P&startTime=1756512000&endTime=1757088000&limit=20","description":"

Get the funding rate.

It will return historical funding rates and index prices for a given futures contract.

Notes:

symbol (string, required) – The trading pair symbol (e.g., \"BTC/USDT-P\").
\n
startTime (integer, optional) – Unix timestamp in seconds (with optional fractional part) specifying the start of the query window.
\n
- Default: 7 days ago
\n
endTime (integer, optional) – Unix timestamp in seconds (with optional fractional part) specifying the end of the query window.
\n
- Default: current server time
\n
limit (integer, optional) – Maximum number of results to return.
\n
- Range: 1–100
  \n
- Default: 50
  \n
\n
offset (integer, optional) – Number of results to skip before starting to return data.
\n
- Default: 0
\n

\n","urlObject":{"path":["market","data","funding-rates"],"host":["https://data-api-staging.hibachi.xyz"],"query":[{"key":"symbol","value":"BTC/USDT-P"},{"key":"startTime","value":"1756512000"},{"key":"endTime","value":"1757088000"},{"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"736ec4de-d4c8-47af-840c-9c668e9ed1b5","name":"example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data-api-staging.hibachi.xyz/market/data/funding-rates?symbol=BTC/USDT-P&startTime=1756512000&endTime=1757088000&limit=20","host":["https://data-api-staging.hibachi.xyz"],"path":["market","data","funding-rates"],"query":[{"key":"symbol","value":"BTC/USDT-P"},{"key":"startTime","value":"1756512000"},{"key":"endTime","value":"1757088000"},{"key":"limit","value":"20"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"079586af-0d94-41ea-99bb-7afcd93bf438"},{"name":"/exchange/utc-timestamp","id":"3277e546-4cb0-4d30-a832-717af0de9b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/exchange/utc-timestamp","description":"

Get Current UTC Timestamp

Fetch the current UTC timestamp in milliseconds.

This can be used for client-side time synchronization, request signing, or latency checks.

\n","urlObject":{"path":["exchange","utc-timestamp"],"host":["https://data-api-staging.hibachi.xyz"],"query":[],"variable":[]}},"response":[{"id":"8eadc75e-221c-4383-b8a8-4b19cde39ab4","name":"example","originalRequest":{"method":"GET","header":[],"url":"https://data-api-staging.hibachi.xyz/exchange/utc-timestamp"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"timestampMs\": 1757118802487\n}"}],"_postman_id":"3277e546-4cb0-4d30-a832-717af0de9b20"}],"id":"4abb30c4-e5c7-4b0f-9ade-790111dbfa47","description":"

Order book

You can obtain order book data using the /market/data/orderbook endpoint.

The parameters are:

symbol (string)
\n
depth (optional 32-bit unsigned integer representing the number of levels to query)
\n
granularity (optional string representing the precision of the levels returned)
\n
- For example, you can use a granularity of 0.01 to obtains levels separated by 0.01 in price.
\n

For example, you can query /market/data/orderbook?symbol=ETH/USDT-P&depth=3&granularity=0.01 and you will receive a response such as the following:

{\n    \"ask\": {\n        \"endPrice\": \"3060.85\",\n        \"levels\": [\n            {\n                \"price\": \"3060.23\",\n                \"quantity\": \"0.073006381\"\n            },\n            {\n                \"price\": \"3060.53\",\n                \"quantity\": \"0.179959398\"\n            },\n            {\n                \"price\": \"3060.85\",\n                \"quantity\": \"0.110626584\"\n            }\n        ],\n        \"startPrice\": \"3060.23\"\n    },\n    \"bid\": {\n        \"endPrice\": \"3058.39\",\n        \"levels\": [\n            {\n                \"price\": \"3058.99\",\n                \"quantity\": \"0.012214857\"\n            },\n            {\n                \"price\": \"3058.68\",\n                \"quantity\": \"0.153802116\"\n            },\n            {\n                \"price\": \"3058.39\",\n                \"quantity\": \"0.171222708\"\n            }\n        ],\n        \"startPrice\": \"3058.99\"\n    }\n}\n\n

Open interest

You can obtain open interest data using the /market/data/open-interest endpoint.

Parameters:

symbol (string)

For example, you can send an HTTP GET request to /market/data/open-interest?symbol=ETH/USDT-P and you will receive a response like

{\n    \"total_quantity\": \"0.113622416\"\n}\n\n

\n","_postman_id":"4abb30c4-e5c7-4b0f-9ade-790111dbfa47"}],"id":"98d073b3-de4d-4e86-81cf-7cb4670da751","description":"

You can use Market API to query:

Exchange Listings: /market/exchange-info (and optionally /market/inventory)
\n
Market Data: /market/data
\n

\n","_postman_id":"98d073b3-de4d-4e86-81cf-7cb4670da751"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"e30e1394-d082-4918-961f-a92b75347dbb"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"91e52da8-d75d-436e-9845-217867020e9b"}}],"variable":[{"id":"54525ba0-9670-48fc-a526-7ed5e9cdf924","key":"api-url","value":"https://api-staging.hibachi.xyz"},{"id":"75efae4e-1922-4511-96cd-66f821737f57","key":"data-api-url","value":"https://data-api-staging.hibachi.xyz"},{"id":"2a4595e9-8bb5-4405-b054-7ca5a476b9f1","key":"api-url-ws","value":"wss://api-staging.hibachi.xyz"},{"id":"6803e2bf-d520-4b8c-8c1f-8220e616f572","key":"data-api-url-ws","value":"wss://data-api-staging.hibachi.xyz"}]}