Skip to main content
GET
/
v1
/
aster
/
fapi
/
v4
/
account
Account Information V4
curl --request GET \
  --url https://api.hypereth.io/v1/aster/fapi/v4/account \
  --header 'Authorization: <api-key>'
{
  "feeTier": 123,
  "canTrade": true,
  "canDeposit": true,
  "canWithdraw": true,
  "updateTime": 123,
  "totalInitialMargin": "<string>",
  "totalMaintMargin": "<string>",
  "totalWalletBalance": "<string>",
  "totalUnrealizedProfit": "<string>",
  "totalMarginBalance": "<string>",
  "totalPositionInitialMargin": "<string>",
  "totalOpenOrderInitialMargin": "<string>",
  "totalCrossWalletBalance": "<string>",
  "totalCrossUnPnl": "<string>",
  "availableBalance": "<string>",
  "maxWithdrawAmount": "<string>",
  "assets": [
    {
      "accountAlias": "<string>",
      "asset": "<string>",
      "balance": "<string>",
      "crossWalletBalance": "<string>",
      "crossUnPnl": "<string>",
      "availableBalance": "<string>",
      "maxWithdrawAmount": "<string>",
      "marginAvailable": true,
      "updateTime": 123
    }
  ],
  "positions": [
    {
      "entryPrice": "<string>",
      "marginType": "<string>",
      "isAutoAddMargin": "<string>",
      "isolatedMargin": "<string>",
      "leverage": "<string>",
      "liquidationPrice": "<string>",
      "markPrice": "<string>",
      "maxNotionalValue": "<string>",
      "positionAmt": "<string>",
      "symbol": "<string>",
      "unRealizedProfit": "<string>",
      "positionSide": "<string>",
      "updateTime": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypereth.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Web3 authentication using user, signer, nonce, and signature parameters

Query Parameters

​
recvWindow
integer<int64>
​
timestamp
integer<int64>
required
​
nonce
string
required

Microsecond timestamp

​
user
string
required

Ethereum address

Pattern: ^0x[a-fA-F0-9]{40}$
​
signer
string
required

Signer Ethereum address

Pattern: ^0x[a-fA-F0-9]{40}$
​
signature
string
required

Ethereum signature

Pattern: ^0x[a-fA-F0-9]{130}$

Response

200 - application/json

Account information (v4)

​
feeTier
integer

account commission tier

​
canTrade
boolean

if can trade

​
canDeposit
boolean

if can transfer in asset

​
canWithdraw
boolean

if can transfer out asset

​
updateTime
integer<int64>
​
totalInitialMargin
string

total initial margin required with current mark price (useless with isolated positions), only for USDT asset

​
totalMaintMargin
string

total maintenance margin required, only for USDT asset

​
totalWalletBalance
string

total wallet balance, using BidRate/AskRate for value calculation under multi-asset mode

​
totalUnrealizedProfit
string

total unrealized profit in USDT

​
totalMarginBalance
string

total margin balance, using BidRate/AskRate for value calculation under multi-asset mode

​
totalPositionInitialMargin
string

initial margin required for positions with current mark price, only for USDT asset

​
totalOpenOrderInitialMargin
string

initial margin required for open orders with current mark price, only for USDT asset

​
totalCrossWalletBalance
string

crossed wallet balance, using BidRate/AskRate for value calculation under multi-asset mode

​
totalCrossUnPnl
string

unrealized profit of crossed positions in USDT

​
availableBalance
string

available balance, only for USDT asset

​
maxWithdrawAmount
string

maximum amount for transfer out, using BidRate for value calculation under multi-asset mode

​
assets
object[]
​
positions
object[]