Capital
/
Balance

Account REST API (0.0.1)

Welcome to the Hibachi.xyz Account API - your gateway to building powerful crypto trading tools on top of our platform. Whether you want to automate strategies, access account data, or analyze market activity, our API gives you the access you need.

To use the Hibachi.xyz API, you'll need a few credentials:

  • API Key
    Your API key is used to authenticate requests. You can generate and manage your API keys from your Account Settings.

  • Account ID
    This unique identifier represents your trading account and is required for authenticated API operations. You can find your Account ID in the same account settings page.

⚠️ Note: All endpoints under the Account and Trade API sections require authentication using your API key and account ID.

Download OpenAPI description
index.json
index.yaml
Overview
License

Languages
Servers
Production server

https://api.hibachi.xyz/

Capital

With the Capital endpoints manage your trading account, monitor and manage your portfolio including:

  • Balances
  • Positions
  • Transaction history
  • General account settings
Operations

Balance

Request

Get the balance of your account. The returned balance is your net equity which includes unrealized PnL.

Security
api_key
Query
accountIdinteger(int64)(AccountId)>= 0required

You MUST make one Deposit to your account. Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints Account ID: you will see ID: XXX below your API Key Name For more information see Pre-requisites

Example: accountId=140
curl -i -X GET \
  'https://api.hibachi.xyz/capital/balance?accountId=140' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Account Capital Balance

Bodyapplication/json
balancestringrequired
Response
application/json
{
  "balance": "string"
}

History

Request

Get the deposit and withdraw history of your account. It will return most recent up to 100 deposit and 100 withdraw.

Security
api_key
Query
accountIdinteger(int64)(AccountId)>= 0required

You MUST make one Deposit to your account. Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints Account ID: you will see ID: XXX below your API Key Name For more information see Pre-requisites

Example: accountId=140
curl -i -X GET \
  'https://api.hibachi.xyz/capital/history?accountId=140' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Capital History

Bodyapplication/json
transactionsArray of deposit (object) or withdrawal (object) or transfer-in (object) or transfer-out (object)(CapitalTransaction)required
One of:
assetIdinteger(int32)required
blockNumberinteger(int64)required
chainstring or null
etaTsSecstring or null
idinteger(int32)required
quantitystringrequired
statusstringrequired
timestampinteger(int64)>= 0required
tokenstring or null
transactionHashstringrequired
transactionTypestringrequired
Value"deposit"
Response
application/json
{
  "transactions": [
    { … }
  ]
}

Withdrawal

Request

Submit a withdraw request.

Signing

SIGNATURE IS REQUIRED! Use signature field (65 bytes) to sign the message. Refer to the Signing section for more context.

  • assetId (4 bytes)
  • quantity (8 bytes): should be no more than maximalWithdraw returned by /trade/account/info endpoint, otherwise it will be rejected.
  • maxFees (8 bytes): should be at least returned by /market/exchange-info endpoint, otherwise it will be rejected.
  • withdrawalAddress (20 bytes)
Security
api_key
Bodyapplication/jsonrequired
accountIdinteger(int64)(AccountID)>= 0required

You MUST make one Deposit to your account. Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints Account ID: you will see ID: XXX below your API Key Name For more information see Pre-requisites

coinstringrequired
Example: "USDT"
maxFeesstring or null

should be at least returned by /market/exchange-info endpoint, otherwise it will be rejected.

Example: "0.0113592"
networkstringrequired
Example: "arbitrum"
quantitystringrequired

should be no more than maximalWithdraw returned by /trade/account/info endpoint, otherwise it will be rejected.

Example: "2.0113592"
selfWithdrawalboolean or null
signaturestring(SignatureDoc)required

SIGNATURE IS REQUIRED! Use signature field (65 bytes) to sign the message. Refer to the Signing section for more context.

withdrawAddressstringrequired
curl -i -X POST \
  https://api.hibachi.xyz/capital/withdraw \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 140,
    "coin": "USDT",
    "maxFees": "0.0113592",
    "network": "arbitrum",
    "quantity": "2.0113592",
    "selfWithdrawal": true,
    "signature": "0000000000000000000000000000000000000000000000000000000000000000",
    "withdrawAddress": "string"
  }'

Responses

Bodyapplication/json
object(WithdrawRequestBodyResponse)
Response
application/json
{}

Transfer

Request

Submit a transfer request.

Security
api_key
Bodyapplication/jsonrequired
accountIdinteger(int64)(AccountID)>= 0required

You MUST make one Deposit to your account. Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints Account ID: you will see ID: XXX below your API Key Name For more information see Pre-requisites

coinstringrequired
Example: "USDT"
dstPublicKeystringrequired

receivingAddress

Example: "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
feesstringrequired
Example: "0.02"
nonceinteger(int64)>= 0required
Example: 172851534
quantitystringrequired
Example: "1"
signaturestring(SignatureDoc)required

SIGNATURE IS REQUIRED! Use signature field (65 bytes) to sign the message. Refer to the Signing section for more context.

curl -i -X POST \
  https://api.hibachi.xyz/capital/transfer \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": 140,
    "coin": "USDT",
    "dstPublicKey": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
    "fees": "0.02",
    "nonce": 172851534,
    "quantity": "1",
    "signature": "0000000000000000000000000000000000000000000000000000000000000000"
  }'

Responses

Capital Transfer Response

Bodyapplication/json
object(CapitalTransferResult)
Response
application/json
{}

Deposit Info

Request

Get deposit address

Security
api_key
Query
accountIdinteger(int64)(AccountId)>= 0required

You MUST make one Deposit to your account. Your Account ID will not be generated until your first deposit; this ID is required for a lot of endpoints Account ID: you will see ID: XXX below your API Key Name For more information see Pre-requisites

Example: accountId=140
publicKeystringrequired

The public key of the account

Example: publicKey=0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
curl -i -X GET \
  'https://api.hibachi.xyz/capital/deposit-info?accountId=140&publicKey=0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Capital Deposit Info

Bodyapplication/json
depositAddressEvmstringrequired
Example: "0x0000000000000000000000000000000000000000"
Response
application/json
{
  "depositAddressEvm": "0x0000000000000000000000000000000000000000"
}

Trade

Use the Trade endpoint to programmatically control your trades:

  • Submit new orders
  • Cancel existing ones
  • Track open orders and execution history
Operations
Copyright © Hibachi.xyz Inc. All rights reserved.