Arkham Exchange API

Change Log #

• 2024-11-04 - Added rate limits

Introduction #

The Arkham Exchange provides a RESTful HTTP API and a Websocket API that enables access to the Arkham Exchange trading platform. It allows you to interact with the exchange programmatically, including trading, order management and market data.

The Rest API endpoint is available at the following base URL:

https://arkm.com/api

Authentication #

API Keys

The Arkham Exchange API uses API keys for authentication. You can create an API key and API Secret in the API Settings section of the Arkham Exchange website.

To authenticate with the API, include the API key in the +""+Arkham-API-Key+""+ header of your HTTP requests.

Signing Requests

To better protect your account, endpoints will require the request to be signed with your API Secret. The signature is a HMAC-SHA256 signed with your API Secret of the following data:

• Your API key
• The Expiry timestamp
• The HTTP method of the request
• The path of the request
• The body of the request

The expiry timestamp is the time at which the request will expire formatted as a Unix timestamp in microseconds i.e. The number of non-leap seconds which have passed since 00:00:00 UTC on Thursday, 1 January 1970 multiplied by 1000000 as an integer.

The request will be rejected if the request is received by the server after the expiry timestamp or if the timestamp represents a time more than 15 minutes in the future.

The expiry timestamp is passed in the +""+Arkham-Expires+""+ header of the request.

The signature is passed in the +""+Arkham-Signature+""+ header of the request as a base64 encoded string.

Bash Example:

Set the BASE_URL, API_KEY, API_SECRET, METHOD, REQUEST_PATH and BODY variables to the required values:

API_KEY=<your-api-key>
API_SECRET=<your-api-secret>
BASE_URL=https://arkm.com/api
METHOD="POST"
REQUEST_PATH="/orders/cancel/all"
BODY="{}"

Note: For GET requests, the BODY should be an empty string.

Set the expiry timestamp - in this case 5 minutes from now:

EXPIRES=$(($(/bin/date +%s) + 300))000000

Calculate the signature

HMAC_KEY=$(/bin/echo -n "$API_SECRET" | base64 -D | xxd -p -c 64)
SIGNATURE=$(/bin/echo -n "$API_KEY$EXPIRES$METHOD$REQUEST_PATH$BODY" | openssl dgst -sha256 -mac HMAC -macopt hexkey:$HMAC_KEY -binary | base64)

Make the signed request

curl -X $METHOD \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Arkham-Api-Key: $API_KEY" \
	-H "Arkham-Expires: $EXPIRES" \
	-H "Arkham-Signature: $SIGNATURE" \
	-d "$BODY" \
	$BASE_URL$REQUEST_PATH

Rate Limits #

Arkham Exchange API rate limits are based on two factors as outlined below:

• 30 Day Trading Volume
• ARKM Balance

Note:

Timing: 30 day snapshots of trading volume and ARKM holdings are taken at 5:00 PM UTC every Saturday and updated API rate limits are calculated between 8:00 PM and 10:00 PM UTC. The updated limits apply to the following week starting at 12:00 AM UTC Sunday. A user's ARKM balance is defined by their lowest ARKM balance over the last 30 days. For the first 30 days of trading, Trading Volume and ARKM Holdings discounts will be based on all previous trading days (i.e., 15 trading days on day 16 of trading being live).

Perpetuals and Margin #

Leverage and Margin Schedule in USDT Perpetuals

On Arkham Exchange, users cannot directly specify the maximum leverage they wish to use. Instead, the leverage is dynamic and determined by Margin Schedule, which adjusts margin requirements based on position size. As the position size increases, the required margin also increases, reducing the effective leverage.

The margin schedule applies progressively higher initial margin rates for larger positions to ensure that risk is managed as position sizes grow.

How Margin Schedule Works

Margin Schedule defines position bands with corresponding initial margin rates and maintenance margin rates. The maintenance margin rate is set at half of the initial margin rate, and the effective leverage is determined based on the initial margin rate.

Here is the margin schedule for USDT perpetuals:

Margin Schedule A - Initial & Maintenance Margin Rates

• The initial margin rate is the percentage of your position size that must be held as collateral to open a position.
• The maintenance margin rate is half the initial margin, representing the collateral required to maintain the position and avoid liquidation.

Example of Dynamic Leverage Based on Margin Schedule A

Let’s walk through an example using Margin Schedule A:

1. Position 1: 800,000 USDT long on BTC/USDT.

   • Initial Margin Rate: 2% (since the position size is below 1,000,000 USDT).
   • Initial Margin: 2% of 800,000 USDT = 16,000 USDT.
   • Maintenance Margin: 1% of 800,000 USDT = 8,000 USDT.
   • Effective Leverage: 50x.

2. Position 2: 3,000,000 USDT short on ETH/USDT.

   • Initial Margin Rate: 5% (for positions between 2,000,001 and 5,000,000 USDT).
   • Initial Margin: 5% of 3,000,000 USDT = 150,000 USDT.
   • Maintenance Margin: 2.5% of 3,000,000 USDT = 75,000 USDT.
   • Effective Leverage: 20x.

In this example, Position 1 uses higher leverage because it's in a smaller band with a lower margin requirement (2%). Position 2 has a larger size and thus requires more collateral (5%), leading to lower leverage.

How Margin Netting and Unrealized PnL Work Under This Model

When a subaccount holds multiple positions, margin netting combines the margin requirements of all open positions and offsets them using the net unrealized profit and loss (PnL) across positions.

Example of Multiple Positions with Margin Netting

Assume the trader holds two positions:

1. Position 1:

   • Long BTC/USDT.
   • Position size: 1,500,000 USDT.
   • Initial Margin Rate: 4%.
   • Initial Margin: 4% of 1,500,000 = 60,000 USDT.
   • Maintenance Margin: 2% of 1,500,000 = 30,000 USDT.
   • Unrealized PnL: +50,000 USDT (the position is in profit).

2. Position 2:

   • Short ETH/USDT.
   • Position size: 3,500,000 USDT.
   • Initial Margin Rate: 5%.
   • Initial Margin: 5% of 3,500,000 = 175,000 USDT.
   • Maintenance Margin: 2.5% of 3,500,000 = 87,500 USDT.
   • Unrealized PnL: -30,000 USDT (the position is in a loss).

Netting the Margin Requirements:

• Total Initial Margin: 60,000 USDT (Position 1) + 175,000 USDT (Position 2) = 235,000 USDT.
• Unrealized PnL offset: The net unrealized PnL is +20,000 USDT (50,000 USDT from Position 1 minus 30,000 USDT from Position 2).
• Effective margin requirement: After netting the unrealized PnL, the effective margin requirement becomes:
  • 235,000 USDT - 20,000 USDT = 215,000 USDT.

This means the trader only needs 215,000 USDT in margin to support both positions, as the profit from the BTC/USDT position offsets the losses from the ETH/USDT position, reducing the overall margin requirement and the risk of liquidation.

Impact of Margin Schedules on Risk Management

1. Larger positions require more margin: As your position size increases, the margin requirement also increases, reducing the effective leverage.

2. Smaller positions offer higher leverage: Traders with smaller positions can use higher leverage because the margin requirements are lower. However, higher leverage also increases the potential risk.

3. Unrealized PnL reduces risk: The unrealized profit from one position can offset the losses of another, reducing the overall margin requirement and helping to avoid liquidation.

Key Takeaways

• Dynamic leverage is applied automatically based on the size of your position, with smaller positions allowing higher leverage and larger positions requiring more margin.
• Margin netting allows unrealized PnL from one position to offset the margin requirement for another, reducing the risk of liquidation.
• Monitoring positions is important because while unrealized profit can lower margin requirements, market volatility can quickly shift your net PnL, increasing the risk of liquidation.

Funding Rates #

Overview

• Sampling Interval: Every second
• Funding Interval: Every hour
• Calculation: Funding rate is calculated based on the difference between the perpetual futures price and the index (spot) price, sampled every second
• Min/Max Values: Funding rate is capped between -0.25% and 0.25%.
• Transfer of Funding: Funding payments are transferred between traders once every hour

Funding Rate Calculation

The funding rate is derived from the price difference between the perpetual futures contract price and the index price. This difference is sampled every second over the course of an hour.

The formula for the funding rate at any given second is as follows:

$\text{Funding Rate Sample}_t = \frac{\text{perpPrice}_t - \text{indexPrice}_t}{\text{indexPrice}_t}$

Where:

• perpPrice_t: The price of the perpetual futures contract at time t.
• indexPrice_t: The index price (or spot price) of the underlying asset at time t.

The difference is divided by the index price to express it as a percentage.

Hourly Funding Rate

The hourly funding rate is computed as the average of the second-by-second funding rates over the entire hour.

$\text{Hourly Funding Rate} = \frac{1}{24*n} \sum_{t=1}^{n} \frac{\text{perpPrice}_t - \text{indexPrice}_t}{\text{indexPrice}_t}$

Where:

• ( n ) is the total number of seconds in an hour (3600 seconds).

This average captures the typical difference between the perpetual futures price and the index price over the funding interval.

Funding Payment

The funding payment is the actual amount exchanged between long and short position holders, based on the trader’s notional position size.

$\text{Funding Payment} = \text{Position Size} \times \text{Mark Price} \times \text{Hourly Funding Rate}$

• Long Position Holders: If the hourly funding rate is positive, long position holders will pay short position holders.
• Short Position Holders: If the hourly funding rate is negative, short position holders will pay long position holders.

Example

1. Suppose that the perpetual futures price for Bitcoin over an hour is consistently higher than the index price.

   • Average perpetual futures price (perpPrice) = $30,500
   • Average index price (indexPrice) = $30,000

   Using the formula for the hourly funding rate:

$\text{Hourly Funding Rate} = \frac{30,500 - 30,000}{30,000*24} = 0.00069583$

2. A trader with a long position of $100,000 notional value would then calculate their funding payment as follows:

   $\text{Funding Payment} = 100,000 \times 0.00069583 = 69.58 \, \text{USD}$

   Since the funding rate is positive, the long position holder pays $69.58 to the short position holder.

Liquidations #

Below Maintenance Margin and Liquidation Process

When trading USDT perpetuals, it’s crucial to maintain sufficient margin to avoid liquidation. If your portfolio falls below required margin thresholds, the exchange has a structured liquidation process involving Liquidity Support Providers (LSPs), the insurance fund, and automatic deleveraging (ADL) to manage risk effectively.

What Happens When a Subaccount Falls Below Maintenance Margin?

If the margin in your subaccount drops below the maintenance margin (half of the initial margin), liquidation is triggered. The exchange will attempt to close your positions through the Liquidity Support Provider (LSP) program. If there isn’t sufficient liquidity, the exchange will draw on its insurance fund to cover any shortfall. As a last resort, automatic deleveraging (ADL) is used to close out positions against opposing traders.

The Liquidation Process

1. Liquidity Support Provider (LSP) Program

When a subaccount falls below the maintenance margin, the exchange first attempts to liquidate the position by passing it to participants in the Liquidity Support Provider (LSP) program. LSPs are professional market participants (such as liquidity providers, hedge funds, or proprietary traders) who agree to absorb liquidated positions in exchange for favorable pricing and liquidity incentives.

• Role of LSPs: LSPs provide liquidity by taking over liquidated positions at a negotiated price, helping to minimize market impact.
• LSP Participation: Positions are transferred to LSPs in chunks, and they take over the risk, thus preventing a forced sale at unfavorable market prices. This step helps ensure that large liquidations do not directly impact the market price or cause significant slippage.
• Liquidation at Mark Price + 1% Spread: When a liquidation occurs, LSP participants are allowed to purchase the liquidated position at the Mark Price plus a 1% spread. This ensures that liquidity providers are fairly compensated for taking on liquidated positions, which may carry higher risk in turbulent market conditions.

2. Exchange Insurance Fund

Arkham maintains an Insurance Fund to safeguard traders and the overall ecosystem from extreme market events, particularly during liquidations. Here's how the Insurance Fund ensures the protection of both traders and LSP participants:

• Covering Losses: In the event that a liquidation results in a negative balance or insufficient funds to cover the full position, the Insurance Fund is used to make up the difference, ensuring that LSP participants receive the liquidated positions at Mark Price + 1%, even if the liquidated trader's account balance is inadequate.

• Fair Pricing for LSP: The 1% spread above the Mark Price acts as a buffer, offering an incentive to LSP participants and reducing their risk. The Insurance Fund guarantees that the exchange is able to honor this spread, maintaining fairness in the liquidation process.

By ensuring that LSP participants are compensated with a mark price plus 1% spread and using the Insurance Fund to cover potential shortfalls, Arkham promotes a healthy liquidity environment while protecting traders from excessive loss exposure.

3. Automatic Deleveraging (ADL)

If LSP program participants can't fully cover the liquidated position, the exchange resorts to automatic deleveraging (ADL). In ADL, the system automatically closes out positions by matching them with opposing open positions held by other traders on the platform.

• How ADL Works: The exchange looks for opposing positions (e.g., a long position matched against a short position) held by other participants. The positions are closed out against each other to bring the account back into compliance with the margin requirements.
• Impact on Other Traders: Traders with high leverage and profits are prioritized for ADL matching, meaning their positions might be automatically reduced or closed to balance the risk on the exchange.

Example

1. Trader’s Initial Position:

   • Trader A holds a long position of 10 BTCP in a perpetual contract with an entry price of $30,000.
   • Maintenance Margin Requirement: 5% of the total position value, that requires a collateral of $15,000.

2. Market Movement:

   • The price of BTC perpetual drops to $28,000.
   • Trader A’s equity is now: $$\text{Equity} = \text{Current Position Value} - \text{Amount Invested} + \text{Collateral}\\ \text{Current Position Value} = 10 \, \text{BTC} \times 28,000 = 280,000\\ \text{Amount Invested} = 30,000 \times {10} = 300,000\\ \text{Equity} = 280,000 - 300,000 + 15,000 = -5,000\\$$
   • Maintenance margin required: $$5\% \text{ of } 270,000 = 13,500$$
   • Since Trader A’s equity is below the required maintenance margin, their subaccount is passed on to liquidation engine.

Liquidation Process

Step 1: Attempt to Liquidate via LSPs

1. Liquidation Trigger:

   • Since Trader A’s equity is below the required maintenance margin, their subaccount gets liquidated.
   • The exchange attempts to pass Trader A’s position to LSP participants. The BTC price is $28,000, and they take it on at Mark Price - 1% Spread: $$\text{LSP Purchase Price} = 28,000 - (28,000 \times 0.01) = 27,720$$

2. LSP Involvement:

   • The exchange sells 5 BTC to LSPs at $27,720 per BTC: $$\text{Value of Liquidated Position to LSP} = 5 \, \text{BTC} \times 27,720 = 138,600$$

3. Insurance Fund Usage:

   $$\text{Shortfall} = 138,600 + 5 \text{BTC} \times 28,000 + 15,000 - 300,000 = -6,400$$
   • The Insurance Fund covers this shortfall so that LSPs receive the liquidated positions at the agreed price, ensuring no losses occur for them despite Trader A's account deficiency.

Step 2: Remaining Position and ADL

1. Remaining Position:

   • Trader A now has 5 BTC remaining which will be deleveraged

2. Automatic Deleveraging (ADL):

   • Suppose another trader, Trader B, has a short position of 10 BTC at $28,000.
   • The exchange identifies Trader B’s short position to match it against Trader A’s liquidated position.
   • Since Trader B has a profitable short position, the exchange will deleverage 5 BTC of their short position at mark price of $28,000 realising a PnL of 5 * $2000 = $10,000.

3. Closing Positions:

   • Trader B’s position is closed out for 5 BTC, while Trader A’s long position is effectively liquidated.
   • The remaining short position for Trader B becomes 5 BTC.

Summary of Outcomes

• Trader A:

  • Had their 10 BTC long position liquidated.
  • Resulting shortfall of $6,400 was covered by the Insurance Fund.

• Liquidity Support Providers:

  • Acquired 5 BTC at $27,720, absorbing some risk but benefiting from the premium.

• Trader B:

  • Partially closed their 5 BTC short position, gaining $10,000 profit from the market movement and helping to balance risk across the exchange.

Key Takeaways

1. LSPs facilitate smoother liquidations by absorbing positions and maintaining market stability, which helps prevent a rapid decline in price due to forced sales.
2. The Insurance Fund acts as a safety net, ensuring LSPs and the exchange can operate without incurring losses due to trader defaults.
3. Automatic Deleveraging (ADL) provides a mechanism to manage risk and maintain balance by matching positions across different traders.

This example illustrates how a perpetual contract liquidation works in a practical scenario, showing how different mechanisms come together to manage risk and maintain a stable trading environment.

Impact on Traders from Liquidation and ADL

1. LSP Program and Insurance Fund: These mechanisms are designed to minimize the impact of liquidation on the market and ensure traders’ positions are closed without significant losses beyond the maintenance margin.

2. Automatic Deleveraging (ADL): Traders with high leverage and high profits may see their positions automatically reduced or closed as part of the ADL process. This ensures that the exchange maintains risk management, but it can affect traders’ open positions unexpectedly.

3. Monitoring Margin Levels: To avoid liquidation, traders should closely monitor their positions and maintain sufficient collateral. If your position falls below the initial or maintenance margin, the liquidation process will start, and you may lose your position partially or entirely.

The liquidation process ensures that the exchange maintains stability and protects traders and the market from sudden, large-scale liquidations.

#Margin Schedules

Margin schedules are used to determine the margin requirements for a given position size. Each trading pair has one of the below margin schedules associated with it.

Each margin schedule defines a series of bands, where each band has a position size range, a maximum leverage, an initial margin rate and a rebate. The initial margin requirement is calculated as the position size multiplied by the initial margin rate minus the rebate. The rebate is provided so that there is no discontinuity in the margin requirement when moving between bands.

#Error Responses

There is a fixed set of errors returned by the API and Websocket when a failure occurs, each has a unique name which maps to a specific HTTP status code and (deprecated) websocket error code.

// Example Response Body
{
  "id": 10000,
  "message": "internal error",
  "name": "InternalError"
}

#API Routes

// Example Response Body
{
  "airdropKycAt": 1704067200000000,
  "becameVipAt": 1704067200000000,
  "country": "abc123",
  "dmm": true,
  "email": "[email protected]",
  "featureFlags": [
    "feature1",
    "feature2"
  ],
  "id": 1,
  "kycVerifiedAt": 1704067200000000,
  "pmm": true,
  "requireMFA": true,
  "settings": {
    "allowSequenceEmails": true,
    "autogenDepositAddresses": true,
    "confirmBeforePlaceOrder": true,
    "hideBalances": true,
    "language": "en",
    "marginUsageThreshold": 1.23,
    "notifyAnnouncements": true,
    "notifyCommissions": true,
    "notifyDeposits": true,
    "notifyMarginUsage": true,
    "notifyOrderFills": true,
    "notifyRebates": true,
    "notifySendEmail": true,
    "notifyWithdrawals": true,
    "tickerTapeScroll": true,
    "updatesFlash": true
  },
  "subaccounts": [
    {
      "createdAt": 1704067200000000,
      "futuresEnabled": true,
      "id": 1,
      "isLsp": true,
      "lspSettings": [
        {
          "maxAssignmentNotional": "200.1",
          "maxExposureNotional": "200.1",
          "symbol": "BTC_USDT"
        }
      ],
      "name": "abc123",
      "payFeesInArkm": true,
      "pinned": true
    }
  ],
  "username": "username",
  "withdrawOnly": true
}

// Example Response Body
[
  {
    "id": 1,
    "lastUpdated": 1704067200000000,
    "message": "abc123",
    "type": "abc123"
  }
]

// Example Response Body
[
  {
    "content": "abc123",
    "createdAt": 1704067200000000,
    "id": 1
  }
]

// Example Response Body
[
  {
    "chains": [
      {
        "assetSymbol": "BTC",
        "blockTime": 1,
        "confirmations": 1,
        "name": "abc123",
        "symbol": "abc123",
        "type": 1
      }
    ],
    "featuredPair": "BTC_USDT",
    "imageUrl": "https://example.com/image.png",
    "minDeposit": "10",
    "minWithdrawal": "10",
    "moonPayChain": "BTC",
    "moonPayCode": "btc",
    "name": "abc123",
    "stablecoin": true,
    "status": "staged",
    "symbol": "BTC",
    "withdrawalFee": "0.01"
  }
]

// Example Response Body
{
  "asks": [
    {
      "price": "1.23",
      "size": "20.1"
    }
  ],
  "bids": [
    {
      "price": "1.23",
      "size": "20.1"
    }
  ],
  "group": "0.01",
  "lastTime": 1731686400000000,
  "symbol": "BTC_USDT"
}

// Example Response Body
[
  {
    "close": "1.23",
    "duration": 60000000,
    "high": "1.23",
    "low": "1.23",
    "open": "1.23",
    "quoteVolume": "200.1",
    "symbol": "BTC_USDT",
    "time": 1704067200000000,
    "volume": "20.1"
  }
]

// Example Response Body
[
  {
    "assetSymbol": "BTC",
    "blockTime": 1,
    "confirmations": 1,
    "name": "abc123",
    "symbol": "abc123",
    "type": 1
  }
]

// Example Response Body
[
  {
    "baseSymbol": "BTC",
    "fundingRate": "0.000733",
    "high24h": "100000.1",
    "indexCurrency": "USDT",
    "indexPrice": "100000.1",
    "low24h": "90000.1",
    "markPrice": "100000.1",
    "nextFundingRate": "0.000733",
    "nextFundingTime": 1731686400000000,
    "openInterest": "1.1",
    "openInterestUSD": "100000.1",
    "price": "100000.1",
    "price24hAgo": "90000.1",
    "productType": "spot",
    "quoteSymbol": "USDT",
    "quoteVolume24h": "100000.1",
    "symbol": "BTC_USDT",
    "usdVolume24h": "100000.1",
    "volume24h": "1.1"
  }
]

// Example Response Body
{
  "constituents": [
    {
      "exchange": "binance",
      "price": "1.23",
      "time": 1704067200000000,
      "weight": "1.23"
    }
  ],
  "price": "1.23",
  "symbol": ".BTC_USDT",
  "time": 1704067200000000
}

// Example Response Body
[
  {
    "constituents": [
      {
        "exchange": "binance",
        "price": "1.23",
        "time": 1704067200000000,
        "weight": "1.23"
      }
    ],
    "price": "1.23",
    "symbol": ".BTC_USDT",
    "time": 1704067200000000
  }
]

// Example Response Body
{
  "askPrice": "1.23",
  "askSize": "20.1",
  "bidPrice": "1.23",
  "bidSize": "20.1",
  "revisionId": 1,
  "symbol": "BTC_USDT",
  "time": 1704067200000000
}

// Example Response Body
[
  {
    "bands": [
      {
        "leverageRate": "2",
        "marginRate": "0.5",
        "positionLimit": "5000000",
        "rebate": "211000"
      }
    ],
    "name": "E"
  }
]

// Example Response Body
{
  "market_cap_chart": {
    "market_cap": [
      [
        1.23
      ]
    ],
    "volume": [
      [
        1.23
      ]
    ]
  }
}

// Example Response Body
{
  "market_cap_change_percentage_24h_usd": 1.23,
  "market_cap_percentage_btc": 1.23,
  "total_market_cap": 1.23
}

// Example Response Body
{
  "baseImageUrl": "https://example.com/image.png",
  "baseIsStablecoin": true,
  "baseName": "Bitcoin",
  "baseSymbol": "BTC",
  "marginSchedule": "A",
  "maxLeverage": "10",
  "maxPrice": "1000000",
  "maxPriceScalarDown": "0.5",
  "maxPriceScalarUp": "1.5",
  "maxSize": "1000000",
  "minLotSize": "0.01",
  "minNotional": "5",
  "minPrice": "0.001",
  "minSize": "0.01",
  "minTickPrice": "0.001",
  "pairType": "spot",
  "quoteImageUrl": "https://example.com/image.png",
  "quoteIsStablecoin": true,
  "quoteName": "Tether",
  "quoteSymbol": "USDT",
  "status": "staged",
  "symbol": "BTC_USDT"
}

// Example Response Body
[
  {
    "baseImageUrl": "https://example.com/image.png",
    "baseIsStablecoin": true,
    "baseName": "Bitcoin",
    "baseSymbol": "BTC",
    "marginSchedule": "A",
    "maxLeverage": "10",
    "maxPrice": "1000000",
    "maxPriceScalarDown": "0.5",
    "maxPriceScalarUp": "1.5",
    "maxSize": "1000000",
    "minLotSize": "0.01",
    "minNotional": "5",
    "minPrice": "0.001",
    "minSize": "0.01",
    "minTickPrice": "0.001",
    "pairType": "spot",
    "quoteImageUrl": "https://example.com/image.png",
    "quoteIsStablecoin": true,
    "quoteName": "Tether",
    "quoteSymbol": "USDT",
    "status": "staged",
    "symbol": "BTC_USDT"
  }
]

// Example Response Body
{
  "serverTime": 1704067200000000
}

// Example Response Body
{
  "baseSymbol": "BTC",
  "fundingRate": "0.000733",
  "high24h": "100000.1",
  "indexCurrency": "USDT",
  "indexPrice": "100000.1",
  "low24h": "90000.1",
  "markPrice": "100000.1",
  "nextFundingRate": "0.000733",
  "nextFundingTime": 1731686400000000,
  "openInterest": "1.1",
  "openInterestUSD": "100000.1",
  "price": "100000.1",
  "price24hAgo": "90000.1",
  "productType": "spot",
  "quoteSymbol": "USDT",
  "quoteVolume24h": "100000.1",
  "symbol": "BTC_USDT",
  "usdVolume24h": "100000.1",
  "volume24h": "1.1"
}

// Example Response Body
[
  {
    "baseSymbol": "BTC",
    "fundingRate": "0.000733",
    "high24h": "100000.1",
    "indexCurrency": "USDT",
    "indexPrice": "100000.1",
    "low24h": "90000.1",
    "markPrice": "100000.1",
    "nextFundingRate": "0.000733",
    "nextFundingTime": 1731686400000000,
    "openInterest": "1.1",
    "openInterestUSD": "100000.1",
    "price": "100000.1",
    "price24hAgo": "90000.1",
    "productType": "spot",
    "quoteSymbol": "USDT",
    "quoteVolume24h": "100000.1",
    "symbol": "BTC_USDT",
    "usdVolume24h": "100000.1",
    "volume24h": "1.1"
  }
]

// Example Response Body
[
  {
    "price": "1.23",
    "revisionId": 1,
    "size": "20.1",
    "symbol": "BTC_USDT",
    "takerSide": "buy",
    "time": 1704067200000000
  }
]

// Example Response Body
[
  {
    "arkmFeePaid": "20.1",
    "avgPrice": "1.23",
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "creditFeePaid": "200.1",
    "executedNotional": "200.1",
    "executedSize": "20.1",
    "lastArkmFee": "0.01",
    "lastCreditFee": "0.01",
    "lastMarginBonusFee": "0.01",
    "lastPrice": "1.5",
    "lastQuoteFee": "0.01",
    "lastSize": "1000",
    "lastTime": 1704067200000000,
    "marginBonusFeePaid": "200.1",
    "orderId": 1,
    "postOnly": true,
    "price": "1.23",
    "quoteFeePaid": "200.1",
    "reduceOnly": true,
    "revisionId": 1,
    "side": "buy",
    "size": "20.1",
    "status": "new",
    "subaccountId": 1,
    "symbol": "BTC_USDT",
    "time": 1704067200000000,
    "triggerOrderId": 1,
    "type": "limitGtc",
    "userId": 1
  }
]

// Example Response Body
{
  "arkmFeePaid": "20.1",
  "avgPrice": "1.23",
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "creditFeePaid": "200.1",
  "executedNotional": "200.1",
  "executedSize": "20.1",
  "lastArkmFee": "0.01",
  "lastCreditFee": "0.01",
  "lastMarginBonusFee": "0.01",
  "lastPrice": "1.5",
  "lastQuoteFee": "0.01",
  "lastSize": "1000",
  "lastTime": 1704067200000000,
  "marginBonusFeePaid": "200.1",
  "orderId": 1,
  "postOnly": true,
  "price": "1.23",
  "quoteFeePaid": "200.1",
  "reduceOnly": true,
  "revisionId": 1,
  "side": "buy",
  "size": "20.1",
  "status": "new",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "time": 1704067200000000,
  "triggerOrderId": 1,
  "type": "limitGtc",
  "userId": 1
}

// Example Request Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "orderId": 1,
  "subaccountId": 1,
  "timeToCancel": 1704067200000000
}

// Example Response Body
{
  "orderId": 1
}

// Example Request Body
{
  "cancelClientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "cancelOrderId": 1,
  "cancelSubaccountId": 1,
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "postOnly": false,
  "price": "1.23",
  "reduceOnly": false,
  "side": "buy",
  "size": "20.1",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "type": "limitGtc"
}

// Example Response Body
{
  "cancelResponse": {
    "orderId": 1
  },
  "createResponse": {
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "orderId": 1,
    "price": "1.23",
    "side": "buy",
    "size": "20.1",
    "subaccountId": 1,
    "symbol": "BTC_USDT",
    "time": 1704067200000000,
    "type": "limitGtc"
  }
}

// Example Request Body
{
  "subaccountId": 1,
  "timeToCancel": 1704067200000000
}

// Example Response Body
[
  {
    "arkmFeePaid": "20.1",
    "avgPrice": "1.23",
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "creditFeePaid": "200.1",
    "executedNotional": "200.1",
    "executedSize": "20.1",
    "lastArkmFee": "0.01",
    "lastCreditFee": "0.01",
    "lastMarginBonusFee": "0.01",
    "lastPrice": "1.5",
    "lastQuoteFee": "0.01",
    "lastSize": "1000",
    "lastTime": 1704067200000000,
    "marginBonusFeePaid": "200.1",
    "orderId": 1,
    "postOnly": true,
    "price": "1.23",
    "quoteFeePaid": "200.1",
    "reduceOnly": true,
    "revisionId": 1,
    "side": "buy",
    "size": "20.1",
    "status": "new",
    "subaccountId": 1,
    "symbol": "BTC_USDT",
    "time": 1704067200000000,
    "triggerOrderId": 1,
    "type": "limitGtc",
    "userId": 1
  }
]

// Example Response Body
[
  {
    "arkmFeePaid": "20.1",
    "avgPrice": "1.23",
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "creditFeePaid": "200.1",
    "executedNotional": "200.1",
    "executedSize": "20.1",
    "lastArkmFee": "0.01",
    "lastCreditFee": "0.01",
    "lastMarginBonusFee": "0.01",
    "lastPrice": "1.5",
    "lastQuoteFee": "0.01",
    "lastSize": "1000",
    "lastTime": 1704067200000000,
    "marginBonusFeePaid": "200.1",
    "orderId": 1,
    "postOnly": true,
    "price": "1.23",
    "quoteFeePaid": "200.1",
    "reduceOnly": true,
    "revisionId": 1,
    "side": "buy",
    "size": "20.1",
    "status": "new",
    "subaccountId": 1,
    "symbol": "BTC_USDT",
    "time": 1704067200000000,
    "triggerOrderId": 1,
    "type": "limitGtc",
    "userId": 1
  }
]

// Example Response Body
{
  "orders": [
    {
      "arkmFeePaid": "20.1",
      "avgPrice": "1.23",
      "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
      "creditFeePaid": "200.1",
      "executedNotional": "200.1",
      "executedSize": "20.1",
      "lastArkmFee": "0.01",
      "lastCreditFee": "0.01",
      "lastMarginBonusFee": "0.01",
      "lastPrice": "1.5",
      "lastQuoteFee": "0.01",
      "lastSize": "1000",
      "lastTime": 1704067200000000,
      "marginBonusFeePaid": "200.1",
      "orderId": 1,
      "postOnly": true,
      "price": "1.23",
      "quoteFeePaid": "200.1",
      "reduceOnly": true,
      "revisionId": 1,
      "side": "buy",
      "size": "20.1",
      "status": "new",
      "subaccountId": 1,
      "symbol": "BTC_USDT",
      "time": 1704067200000000,
      "triggerOrderId": 1,
      "type": "limitGtc",
      "userId": 1
    }
  ],
  "total": 1
}

// Example Request Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "postOnly": false,
  "price": "1.23",
  "reduceOnly": false,
  "side": "buy",
  "size": "20.1",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "type": "limitGtc"
}

// Example Response Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "orderId": 1,
  "price": "1.23",
  "side": "buy",
  "size": "20.1",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "time": 1704067200000000,
  "type": "limitGtc"
}

// Example Request Body
{
  "orders": [
    {
      "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
      "postOnly": false,
      "price": "1.23",
      "reduceOnly": false,
      "side": "buy",
      "size": "20.1",
      "subaccountId": 1,
      "symbol": "BTC_USDT",
      "type": "limitGtc"
    }
  ]
}

// Example Response Body
{
  "orders": [
    {
      "orderId": 1,
      "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
      "symbol": "BTC_USDT",
      "subaccountId": 0,
      "side": "buy",
      "type": "limitGtc",
      "size": "20.1",
      "price": "1.23"
    },
    {
      "clientOrderId": "123e4567-e89b-12d3-a456-426614174001",
      "symbol": "BTC_USDT",
      "subaccountId": 0,
      "side": "buy",
      "type": "limitGtc",
      "size": "20.1",
      "price": "0",
      "error": {
        "id": 30002,
        "name": "InvalidPrice",
        "message": "price must be greater than 0"
      }
    }
  ]
}

// Example Request Body
{
  "side": "buy",
  "size": "20.1",
  "subaccountId": 1,
  "symbol": "BTC_USDT"
}

// Example Response Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "orderId": 1,
  "price": "1.23",
  "side": "buy",
  "size": "20.1",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "time": 1704067200000000,
  "type": "limitGtc"
}

// Example Response Body
{
  "arkmFeePaid": "20.1",
  "avgPrice": "1.23",
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "creditFeePaid": "200.1",
  "executedNotional": "200.1",
  "executedSize": "20.1",
  "lastArkmFee": "0.01",
  "lastCreditFee": "0.01",
  "lastMarginBonusFee": "0.01",
  "lastPrice": "1.5",
  "lastQuoteFee": "0.01",
  "lastSize": "1000",
  "lastTime": 1704067200000000,
  "marginBonusFeePaid": "200.1",
  "orderId": 1,
  "postOnly": true,
  "price": "1.23",
  "quoteFeePaid": "200.1",
  "reduceOnly": true,
  "revisionId": 1,
  "side": "buy",
  "size": "20.1",
  "status": "new",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "time": 1704067200000000,
  "triggerOrderId": 1,
  "type": "limitGtc",
  "userId": 1
}

// Example Response Body
[
  {
    "arkmFee": "20.1",
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "orderId": 1,
    "price": "1.23",
    "quoteFee": "200.1",
    "revisionId": 1,
    "size": "20.1",
    "symbol": "BTC_USDT",
    "takerSide": "buy",
    "time": 1704067200000000,
    "userSide": "buy"
  }
]

// Example Response Body
{
  "total": 1,
  "trades": [
    {
      "arkmFee": "20.1",
      "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
      "orderId": 1,
      "price": "1.23",
      "quoteFee": "200.1",
      "revisionId": 1,
      "size": "20.1",
      "symbol": "BTC_USDT",
      "takerSide": "buy",
      "time": 1704067200000000,
      "userSide": "buy"
    }
  ]
}

// Example Response Body
[
  {
    "arkmFee": "20.1",
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "orderId": 1,
    "price": "1.23",
    "quoteFee": "200.1",
    "revisionId": 1,
    "size": "20.1",
    "symbol": "BTC_USDT",
    "takerSide": "buy",
    "time": 1704067200000000,
    "userSide": "buy"
  }
]

// Example Response Body
[
  {
    "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
    "postOnly": true,
    "price": "1.23",
    "reduceOnly": true,
    "side": "buy",
    "size": "20.1",
    "status": "staged",
    "subaccountId": 1,
    "symbol": "BTC_USDT",
    "time": 1704067200000000,
    "triggerOrderId": 1,
    "triggerPrice": "1.23",
    "triggerPriceType": "last",
    "triggerType": "takeProfit",
    "type": "limitGtc"
  }
]

// Example Request Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "triggerOrderId": 1
}

// Example Response Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "triggerOrderId": 1
}

// Example Request Body
{
  "subaccountId": 1,
  "symbol": "BTC_USDT"
}

// Example Response Body
{
  "subaccountId": 1,
  "symbol": "BTC_USDT"
}

// Example Request Body
{
  "clientOrderId": "e895221c-8c3c-41db-a911-6b9f4ec4c2e0",
  "postOnly": false,
  "price": "1.23",
  "reduceOnly": false,
  "side": "buy",
  "size": "20.1",
  "subaccountId": 1,
  "symbol": "BTC_USDT",
  "triggerPrice": "1.23",
  "triggerPriceType": "last",
  "triggerType": "takeProfit",
  "type": "limitGtc"
}

// Example Response Body
{
  "price": "1.23",
  "side": "buy",
  "size": "20.1",
  "symbol": "BTC_USDT",
  "triggerOrderId": 1,
  "type": "limitGtc"
}

// Example Response Body
[
  {
    "amount": "20.1",
    "assetSymbol": "BTC",
    "id": 1,
    "subaccountId": 1,
    "time": 1704067200000000,
    "userId": 1
  }
]

// Example Response Body
[
  {
    "amount": "20.1",
    "assetSymbol": "BTC",
    "balance": "20.1",
    "id": 1,
    "reason": "orderFill",
    "subaccountId": 1,
    "time": 1704067200000000
  }
]

// Example Response Body
[
  {
    "balance": "20.1",
    "balanceUSDT": "200.1",
    "free": "20.1",
    "freeUSDT": "200.1",
    "lastUpdateAmount": "20.1",
    "lastUpdateId": 1,
    "lastUpdateReason": "orderFill",
    "lastUpdateTime": 1704067200000000,
    "priceUSDT": "1.23",
    "subaccountId": 1,
    "symbol": "BTC"
  }
]

// Example Response Body
[
  {
    "balance": "20.1",
    "balanceUSDT": "200.1",
    "free": "20.1",
    "freeUSDT": "200.1",
    "lastUpdateAmount": "20.1",
    "lastUpdateId": 1,
    "lastUpdateReason": "orderFill",
    "lastUpdateTime": 1704067200000000,
    "priceUSDT": "1.23",
    "subaccountId": 1,
    "symbol": "BTC"
  }
]

// Example Response Body
[
  {
    "amount": "20.1",
    "time": 1704067200000000
  }
]

// Example Response Body
[
  {
    "amount": "20.1",
    "assetSymbol": "BTC",
    "id": 1,
    "subaccountId": 1,
    "time": 1704067200000000,
    "userId": 1
  }
]

// Example Response Body
{
  "addresses": [
    "abc123"
  ]
}

// Example Request Body
{
  "chain": "abc123",
  "subaccountId": 1
}

// Example Response Body
{
  "address": "abc123"
}

// Example Response Body
[
  {
    "amount": "20.1",
    "chain": "abc123",
    "confirmed": true,
    "depositAddress": "abc123",
    "id": 1,
    "price": "1.23",
    "symbol": "BTC",
    "time": 1704067200000000,
    "transactionHash": "abc123"
  }
]

// Example Response Body
{
  "perpMakerFee": "1.23",
  "perpTakerFee": "1.23",
  "spotMakerFee": "1.23",
  "spotTakerFee": "1.23"
}

// Example Response Body
[
  {
    "amount": "20.1",
    "assetSymbol": "BTC",
    "id": 1,
    "indexPrice": "1.23",
    "pairSymbol": "BTC_USDT",
    "subaccountId": 1,
    "time": 1704067200000000,
    "userId": 1
  }
]