X10 API Documentation

By using the X10 API, you agree to the X10 Terms & Privacy Policy. If you do not agree to the foregoing terms, do not use the X10 API.

Introduction

Welcome to the X10 API Documentation! This guide is designed to assist traders and developers in integrating with our hybrid perpetuals exchange.

X10 operates as a hybrid Central Limit Order Book (CLOB) exchange. While order processing, matching, position risk assessment, and transaction sequencing are handled off-chain, trade settlement occurs on-chain through the StarkEx Layer 2 engine.

StarkEx, built by Starkware, is a battle-tested scalability solution that brings lightning-fast transaction processing to the forefront, guaranteeing an unparalleled trading experience. This is achieved while preserving complete trustlessness and transparency through three key mechanisms embedded into StarkEx:

1. On-chain validations of the trading logic ensure that fraudulent or incorrect transactions, including liquidations, contrary to the on-chain trading logic are never permitted.

2. The mark prices, which determine the liquidability of positions, are obtained from multiple independent oracle providers to prevent potential price manipulation and ensure fair and accurate asset valuation within our ecosystem. X10 utilizes 5 Stork nodes to define the median mark price.

3. Publication of zero-knowledge (ZK) proofs on the Ethereum Layer 1 blockchain validates Layer 2 transactions, ensuring both their integrity and security.

For deeper insights on X10 Exchange, please refer to the blogs X10 Vision and Architecture.

To optimize high-frequency trading performance, the X10 API operates asynchronously. This means that when you place an order, it immediately returns an order ID, even before the order is officially recorded in the book. To track your order status in real time, it's essential to subscribe to the Order WebSocket stream. This stream delivers instant updates about any changes to your orders, including confirmations, cancellations, and rejections, enabling you to manage your trading strategies effectively.

Python SDK

SDK configuration

from dataclasses import dataclass


@dataclass
class EndpointConfig:
    chain_rpc_url: str
    api_base_url: str
    stream_url: str
    onboarding_url: str
    signing_domain: str
    collateral_asset_contract: str
    asset_operations_contract: str
    collateral_asset_on_chain_id: str
    collateral_decimals: int


TESTNET_CONFIG = EndpointConfig(
    chain_rpc_url="https://rpc.sepolia.org",
    api_base_url="https://api.testnet.x10.exchange/api/v1",
    stream_url="wss://api.testnet.x10.exchange/stream.x10.exchange/v1",
    onboarding_url="https://api.testnet.x10.exchange",
    signing_domain="testnet.x10.exchange",
    collateral_asset_contract="0x0c9165046063b7bcd05c6924bbe05ed535c140a1",
    asset_operations_contract="0x7f0C670079147C5c5C45eef548E55D2cAc53B391",
    collateral_asset_on_chain_id="0x31857064564ed0ff978e687456963cba09c2c6985d8f9300a1de4962fafa054",
    collateral_decimals=6,
)

TESTNET_CONFIG_LEGACY_SIGNING_DOMAIN = EndpointConfig(
    chain_rpc_url="https://rpc.sepolia.org",
    api_base_url="https://api.testnet.x10.exchange/api/v1",
    stream_url="wss://api.testnet.x10.exchange/stream.x10.exchange/v1",
    onboarding_url="https://api.testnet.x10.exchange",
    signing_domain="x10.exchange",
    collateral_asset_contract="0x0c9165046063b7bcd05c6924bbe05ed535c140a1",
    asset_operations_contract="0x7f0C670079147C5c5C45eef548E55D2cAc53B391",
    collateral_asset_on_chain_id="0x31857064564ed0ff978e687456963cba09c2c6985d8f9300a1de4962fafa054",
    collateral_decimals=6,
)

MAINNET_CONFIG = EndpointConfig(
    chain_rpc_url="https://cloudflare-eth.com",
    api_base_url="https://api.prod.x10.exchange/api/v1",
    stream_url="wss://api.prod.x10.exchange/stream.x10.exchange/v1",
    onboarding_url="https://api.prod.x10.exchange",
    signing_domain="x10.exchange",
    collateral_asset_contract="0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    asset_operations_contract="0x1cE5D7f52A8aBd23551e91248151CA5A13353C65",
    collateral_asset_on_chain_id="0x2893294412a4c8f915f75892b395ebbf6859ec246ec365c3b1f56f47c3a0a5d",
    collateral_decimals=6,
)

To enhance your algorithmic trading experience, X10 has released the 0.3.0-alpha version of our Python SDK.

Getting Started:

• For installation instructions, please refer to the description provided.

• For reference implementations, explore the examples folder.

• For SDK configuration, please refer to the config description.

Supported Features:

• Account creation and authorisation.

• Order Management.

• Account Management.

• Deposits, Transfers and Withdrawals.

• Market Information.

We are committed to enhancing the SDK with more functionalities based on user feedback and evolving market needs.

Mainnet

Our Mainnet is running on Ethereum.

Base URL for the Mainnet API endpoints: https://api.prod.x10.exchange/.

Testnet

Our Testnet is running on Sepolia.

Base URL for the Testnet API endpoints: https://api.testnet.x10.exchange/.

On the testnet, users can claim $100,000 worth of test USDC per day for each L1 wallet. This can be done by clicking the 'Claim' button in the 'Account' section, located at the bottom right of the X10 Testnet Trade screen.

Allowed HTTP Verbs

GET: Retrieves a resource or list of resources.

POST: Creates a resource.

PATCH: Updates a resource.

DELETE: Deletes a resource.

Authentication

Due to the trustless and self-custody nature of the X10 exchange, transactions involving user funds require not only an API Key but also a valid Stark signature.

For order management, both an API Key and Stark signatures are necessary. For other endpoints, only the API Key signature is required. Stark signatures are generated using a private Stark key.

Account Creation, API and Stark Key Management

Currently, accounts can be created through the SDK or through the User Interface.

To create an account through the SDK, please refer to the onboarding example.

To create an account through the User Interface, connect your wallet on X10.exchange, and your first X10 account will be created.

You can create up to ten X10 sub-accounts per one L1 wallet address. You can add and manage all sub-accounts associated with your connected L1 wallet in the 'Account' section, located at the bottom right of the X10 Trade screen.

On the API management page, you can obtain API keys, Stark keys, and Vault numbers for each of your sub-accounts. Note that each sub-account is a separate StarkEx vault and therefore has unique API and Stark keys.

Authenticate Using API Key

X10 employs a simplified authentication scheme for API access. Authenticate by using your API key, which should be included in an HTTP header as follows: X-Api-Key: <API_KEY_FROM_API_MANAGEMENT_PAGE_OF_UI>.

Rate Limits

REST API endpoints are subject to rate limits. For real-time data, consider using the WebSockets API instead.

All REST API endpoints are throttled by IP address. Currently, the rate limit is set at 1,000 requests per minute, shared across all endpoints. We plan to increase these limits as our system expands. If you require an increase in the rate limit now, please reach out to our team on Discord.

Higher rate limit of 6,000 requests per minute apply for the market makers. Please refer to the Market Makers program for the details.

When a REST API rate limit is exceeded, a 429 status code will be returned.

Pagination

Paginated response schema:

type PaginatedResponse = {
  "status": "ok" | "error"
  "data": object | object[] | string | number,
  "error": {
    "code": number,
    "message": string
  },
  "pagination": {
    "cursor": number // Current cursor
    "count": number  // Count of the items in the response
  }
}

General not paginated response schema:

type GeneralResponse = {
  "status": "ok" | "error",
  "data": object | object[] | string | number,
  "error": {
    "code": number,
    "message": string
  }
}

The X10 API uses a cursor-based pagination model across all endpoints that may return large volumes of items.

Items are automatically sorted in descending order by ID unless otherwise specified in the endpoint description. As IDs increase over time, the most recent items are always returned first.

Pagination parameters are passed via the query string. These parameters include:

Public REST-API

The following Public REST API endpoints enable users to access comprehensive information about available markets, their configurations, and trading statistics.

Get markets

HTTP Request

GET /api/v1/info/markets?market={market}

Get a list of available markets, their configurations, and trading statistics.

To request data for several markets, use the following format: GET /api/v1/info/markets?market=market1&market2.

Please note that the margin schedule by market is not covered by this endpoint. For more details on the margin schedule, please refer to the documentation.

Query Parameters

Response example:

{
  "status": "ok",
  "data": [
    {
      "name": "BTC-USD",
      "assetName": "BTC",
      "assetPrecision": 6,
      "collateralAssetName": "USD",
      "collateralAssetPrecision": 6,
      "active": true,
      "marketStats": {
        "dailyVolume": "39659164065",
        "dailyVolumeBase": "39659164065",
        "dailyPriceChangePercentage": "5.57",
        "dailyLow": "39512",
        "dailyHigh": "42122",
        "lastPrice": "42000",
        "askPrice": "42005",
        "bidPrice": "39998",
        "markPrice": "39950",
        "indexPrice": "39940",
        "fundingRate": "0.001",
        "nextFundingRate": 1701563440,
        "openInterest": "1245.2",
        "openInterestBase": "1245.2"
      },
      "tradingConfig": {
        "minOrderSize": "0.001",
        "minOrderSizeChange": "0.001",
        "minPriceChange": "0.001",
        "maxMarketOrderValue": "1000000",
        "maxLimitOrderValue": "5000000",
        "maxPositionValue": "10000000",
        "maxLeverage": "50",
        "maxNumOrders": "200",
        "limitPriceCap": "0.05",
        "limitPriceFloor": "0.05"
      },
      "l2Config": {
        "type": "STARKX",
        "collateralId": "0x35596841893e0d17079c27b2d72db1694f26a1932a7429144b439ba0807d29c",
        "collateralResolution": 1000000,
        "syntheticId": "0x4254432d3130000000000000000000",
        "syntheticResolution": 10000000000
      }
    }
  ]
}

Response

Get market statistics

HTTP Request

GET /api/v1/info/markets/{market}/stats

Get the latest trading statistics for an individual market.

Please note that the returned funding rate represents the most recent funding rate, which is calculated every minute.

URL Parameters

Successful response example:

{
  "status": "OK",
  "data": {
    "dailyVolume": "10283410.122959",
    "dailyVolumeBase": "3343.1217",
    "dailyPriceChange": "-26.00",
    "dailyPriceChangePercentage": "-0.0084",
    "dailyLow": "3057.98",
    "dailyHigh": "3133.53",
    "lastPrice": "3085.70",
    "askPrice": "3089.05",
    "bidPrice": "3087.50",
    "markPrice": "3088.439710293828",
    "indexPrice": "3089.556987078441",
    "fundingRate": "-0.000059",
    "nextFundingRate": 1716192000000,
    "openInterest": "35827242.257619",
    "openInterestBase": "11600.4344",
    "deleverageLevels": {
      "shortPositions": [
        {
          "level": 1,
          "rankingLowerBound": "-1354535.1454"
        },
        {
          "level": 2,
          "rankingLowerBound": "-6.3450"
        },
        {
          "level": 3,
          "rankingLowerBound": "-0.3419"
        },
        {
          "level": 4,
          "rankingLowerBound": "0.0000"
        }
      ],
      "longPositions": [
        {
          "level": 1,
          "rankingLowerBound": "-2978.4427"
        },
        {
          "level": 2,
          "rankingLowerBound": "0.0000"
        },
        {
          "level": 3,
          "rankingLowerBound": "0.0000"
        },
        {
          "level": 4,
          "rankingLowerBound": "0.0001"
        }
      ]
    }
  }
}

Error response example:

{
  "status": "status: error",
  "error": {
    "code": "NOT_FOUND",
    "message": "Market not found"
  }
}

Response

Get candles history

HTTP Request

GET /api/v1/info/candles/{market}/{candleType}

Get the candles history for an individual market for the timeframe specified in the request. Candles are sorted by timestamp in descending order.

Available price types include:

1. Trades (last) price: GET /api/v1/info/candles/{market}/trades.

2. Mark price: GET /api/v1/info/candles/{market}/mark-prices.

3. Index price: GET /api/v1/info/candles/{market}/index-prices.

The endpoint returns a maximum of 10,000 records.

URL Parameters

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "o": "65206.2",
      "l": "65206.2",
      "h": "65206.2",
      "c": "65206.2",
      "v": "0.0",
      "T": 1715797320000
    }
  ]
}

Response

Get funding rates history

HTTP Request

GET /api/v1/info/{market}/funding?&startTime={startTime}&endTime={endTime}

Get the funding rates history for an individual market for the timeframe specified in the request. The funding rates are sorted by timestamp in descending order.

The endpoint returns a maximum of 10,000 records; pagination should be used to access records beyond this limit.

While the funding rate is calculated every minute, it is only applied once per hour. The records represent the 1-hour rates that were applied for the payment of funding fees.

For details on how the funding rate is calculated on X10, please refer to the documentation.

URL Parameters

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "m": "BTC-USD",
      "T": 1701563440,
      "f": "0.001"
    }
  ],
  "pagination": {
    "cursor": 1784963886257016832,
    "count": 1
  }
}

Response

Private REST-API

Account

You can create up to ten X10 sub-accounts for each L1 wallet address. For more details, please refer to the Authentication section of the API Documentation.

The Private API endpoints listed below grant access to details specific to each sub-account, such as balances, transactions, positions, orders, trades, and the fee rates applied. Additionally, there are endpoints for retrieving the current leverage and adjusting it.

Please note that all endpoints in this section will only return records for the authenticated sub-account.

Get balance

HTTP Request

GET /api/v1/user/balance

Get key balance details for the authenticated sub-account:

1. Account Balance = Deposits - Withdrawals + Realised PnL.

2. Equity = Account Balance + Unrealised PnL.

3. Available Balance for Trading = Equity - Initial Margin Requirement.

4. Available Balance for Withdrawals = max(0, Wallet Balance + min(0,Unrealised PnL) - Initial Margin Requirement).

5. Unrealised PnL = The sum of unrealised PnL across open positions, calculated as Position Size * (Mark Price - Entry Price).

6. Initial Margin Requirement for a given market = Max(Abs(Position Value + Value of Buy Orders), Abs(Position Value + Value of Sell Orders))*1/Leverage.

7. Account Margin Ratio = Maintenance Margin requirement of all open positions / Equity. Liquidation is triggered when Account Margin Ratio > 100%.

8. Account Exposure = Sum(All positions value)

9. Account Leverage = Exposure / Equity.

Response example:

{
  "status": "OK",
  "data": {
    "collateralName": "USDC",
    "balance": "13500",
    "equity": "12000",
    "availableForTrade": "1200",
    "availableForWithdrawal": "100",
    "unrealisedPnl": "-10.1",
    "initialMargin": "160",
    "marginRatio": "1.5",
    "exposure": "12751.859629",
    "leverage": "1275.1860",
    "updatedTime": 1701563440
  }
}

Response

Get deposits, withdrawals, transfers history

HTTP Request

GET /api/v1/user/assetOperations?&type={type}&status={status}

Get the history of deposits, withdrawals, and transfers between sub-accounts for the authenticated sub-account. Optionally, the request can be filtered by a specific transaction type or status.

The endpoint returns 50 records per page; pagination should be used to access records beyond this limit. Transactions are sorted by timestamp in descending order.

Transactions types

Transactions statuses

Response example:

{
    "status": "OK",
    "data": [
        {
            "id": "1236",
            "type": "TRANSFER",
            "status": "COMPLETED",
            "amount": "-5.0000000000000000",
            "fee": "0",
            "asset": 1,
            "time": 1722627477268,
            "accountId": 3001,
            "counterpartyAccountId": 3025
        },
        {
            "id": "0x3e8adae72bd576efa0410f3b18f3fe77b638d6fdd8fb49c0b38309ccc01839ac:0x029398cecc60f4e68c3ebeb28fa98df003ac4e0328b086aad5496a4d56815ccc:0xe7",
            "type": "DEPOSIT",
            "status": "COMPLETED",
            "amount": "10.0000000000000000",
            "fee": "0",
            "asset": 1,
            "time": 1722607553870,
            "accountId": 3001,
            "transactionHash": "0x3e8adae72bd576efa0410f3b18f3fe77b638d6fdd8fb49c0b38309ccc01839ac"
        },
        {
            "id": "1235",
            "type": "SLOW_WITHDRAWAL",
            "status": "COMPLETED",
            "amount": "-5.0000000000000000",
            "fee": "0",
            "asset": 1,
            "time": 1722607138130,
            "accountId": 3001,
            "transactionHash": "0xfd8d1bc06ee36b1a4b0bd98377818ac9a22b2346920aa2eb20015d4356a66319"
        },
        {
            "id": "1234",
            "type": "FAST_WITHDRAWAL",
            "status": "COMPLETED",
            "amount": "-5.0000000000000000",
            "fee": "4.2057230000000000",
            "asset": 1,
            "time": 1722607127646,
            "accountId": 3011,
            "transactionHash": "0x3babb6d6b0eecc62e47f71ff7873381312f25c91d576072f1d0b332a25d035b5"
        }
    ],
    "pagination": {
        "cursor": 23,
        "count": 23
    }
}

Query Parameters

Response

Get positions

HTTP Request

GET /api/v1/user/positions?market={market}&side={side}

Get all open positions for the authenticated sub-account. Optionally, the request can be filtered by a specific market or position side (long or short).

To request data for multiple markets, use the following format: GET /api/v1/user/positions?market=market1&market2.

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "id": 1,
      "accountId": 1,
      "market": "BTC-USD",
      "side": "LONG",
      "leverage": "10",
      "size": "0.1",
      "value": "4000",
      "openPrice": "39000",
      "markPrice": "40000",
      "liquidationPrice": "38200",
      "margin": "20",
      "unrealisedPnl": "1000",
      "realisedPnl": "1.2",
      "tpTriggerPrice": "41000",
      "tpLimitPrice": "41500",
      "slTriggerPrice": "39500",
      "slLimitPrice": "39000",
      "adl": "2.5",
      "maxPositionSize": "0.2",
      "createdTime": 1701563440000,
      "updatedTime": 1701563440
    }
  ]
}

Response

Get positions history

HTTP Request

GET /api/v1/user/positions/history?market={market}&side={side}

Get all open and closed positions for the authenticated sub-account. Optionally, the request can be filtered by a specific market or position side (long or short).

To request data for several markets, use the following format: GET /api/v1/user/positions/history?market=market1&market2.

The endpoint returns a maximum of 10,000 records; pagination should be used to access records beyond this limit.

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "id": 1784963886257016832,
      "accountId": 1,
      "market": "BTC-USD",
      "side": "LONG",
      "exitType": "TRADE",
      "leverage": "10",
      "size": "0.1",
      "maxPositionSize": "0.2",
      "openPrice": "39000",
      "exitPrice": "40000",
      "realisedPnl": "1.2",
      "createdTime": 1701563440000,
      "closedTime": 1701563440
    }
  ],
  "pagination": {
    "cursor": 1784963886257016832,
    "count": 1
  }
}

Response

Get open orders

HTTP Request

GET /api/v1/user/orders?market={market}&type={type}&side={side}

Get all open orders for the authenticated sub-account. Optionally, the request can be filtered by a specific market or order type (limit, conditional, or tpsl).

Open orders correspond to the following order statuses from the list below: new, partially filled, untriggered.

To request data for several markets, use the following format: GET /api/v1/user/orders?market=market1&market2.

Order statuses

Order status reasons (when cancelled or rejected)

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "id": 1775511783722512384,
      "accountId": 3017,
      "externalId": "2554612759479898620327573136214120486511160383028978112799136270841501275076",
      "market": "ETH-USD",
      "type": "LIMIT",
      "side": "BUY",
      "status": "PARTIALLY_FILLED",
      "price": "3300",
      "averagePrice": "3297.00",
      "qty": "0.2",
      "filledQty": "0.1",
      "payedFee": "0.0120000000000000",
      "trigger": {
        "triggerPrice": "3300",
        "triggerPriceType": "LAST",
        "triggerPriceDirection": "UP",
        "executionPriceType": "MARKET"
      },
      "takeProfit": {
        "triggerPrice": "3500",
        "triggerPriceType": "LAST",
        "price": "3340",
        "priceType": "MARKET"
      },
      "stopLoss": {
        "triggerPrice": "2800",
        "triggerPriceType": "LAST",
        "price": "2660",
        "priceType": "MARKET"
      },
      "reduceOnly": false,
      "postOnly": false,
      "createdTime": 1701563440000,
      "timeInForce": "FOK",
      "expireTime": 1712754771819
    }
  ]
}

Response

Get orders history

HTTP Request

GET /api/v1/user/orders/history?market={market}&type={type}&side={side}&id={id}&externalId={externalId}

Get orders history for the authenticated sub-account. Optionally, the request can be filtered by a specific market or order type (limit, market, conditional, or tpsl).

Orders history corresponds to the following order statuses from the list below: filled, cancelled, rejected, expired.

To request data for several markets, use the following format: GET /api/v1/user/orders/history?market=market1&market2.

The endpoint returns a maximum of 10,000 records; pagination should be used to access records beyond this limit. The records for non-filled orders are available only for the past 3 days.

Order statuses

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "id": 1784963886257016832,
      "externalId": "ExtId-1",
      "accountId": 1,
      "market": "BTC-USD",
      "status": "FILLED",
      "type": "LIMIT",
      "side": "BUY",
      "price": "39000",
      "averagePrice": "39000",
      "qty": "0.2",
      "filledQty": "0.1",
      "payedFee": "0.0120000000000000",
      "reduceOnly": false,
      "postOnly": false,
      "trigger": {
        "triggerPrice": "34000",
        "triggerPriceType": "LAST",
        "triggerPriceDirection": "UP",
        "executionPriceType": "MARKET"
      },
      "tpslType": "ORDER",
      "takeProfit": {
        "triggerPrice": "34000",
        "triggerPriceType": "LAST",
        "price": "35000",
        "priceType": "MARKET",
        "starkExSignature": ""
      },
      "stopLoss": {
        "triggerPrice": "34000",
        "triggerPriceType": "LAST",
        "price": "35000",
        "priceType": "MARKET",
        "starkExSignature": ""
      },
      "createdTime": 1701563440000,
      "timeInForce": "FOK",
      "expireTime": 1706563440
    }
  ],
  "pagination": {
    "cursor": 1784963886257016832,
    "count": 1
  }
}

Response

Get trades

HTTP Request

GET /api/v1/user/trades?market={market}&type={type}&side={side}

Get trades history for the authenticated sub-account. Optionally, the request can be filtered by a specific market, by trade type (trade, liquidation or deleverage) and side (buy or sell).

To request data for several markets, use the following format: GET /api/v1/user/trades?market=market1&market2.

The endpoint returns a maximum of 10,000 records; pagination should be used to access records beyond this limit.

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "id": 1784963886257016832,
      "accountId": 3017,
      "market": "BTC-USD",
      "orderId": 9223372036854775808,
      "side": "BUY",
      "price": "58853.4000000000000000",
      "qty": "0.0900000000000000",
      "value": "5296.8060000000000000",
      "fee": "0.0000000000000000",
      "tradeType": "DELEVERAGE",
      "createdTime": 1701563440000,
      "isTaker": true
    }
  ],
  "pagination": {
    "cursor": 1784963886257016832,
    "count": 1
  }
}

Response

Get funding payments

HTTP Request

GET /api/v1/user/funding/history?market={market}&side={side}&fromTime={fromTime}

Get funding payments history for the authenticated sub-account. Optionally, the request can be filtered by a specific market, by side (long or short) and from time as a start point.

To request data for several markets, use the following format: GET /api/v1/user/funding/history?market=market1&market2.

The endpoint returns a maximum of 10,000 records; pagination should be used to access records beyond this limit.

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "id": 8341,
      "accountId": 3137,
      "market": "BNB-USD",
      "positionId": 1821237954501148672,
      "side": "LONG",
      "size": "1.116",
      "value": "560.77401888",
      "markPrice": "502.48568",
      "fundingFee": "0",
      "fundingRate": "0",
      "paidTime": 1723147241346
    }
  ],
  "pagination": {
    "cursor": 8341,
    "count": 1
  }
}

Response

Get current leverage

HTTP Request

GET /api/v1/user/leverage?market={market}

Get current leverage for the authenticated sub-account. You can get current leverage for all markets, a single market, or multiple specific markets.

To request data for several markets, use the format GET/api/v1/user/leverage?market=market1&market=market2.

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "market": "SOL-USD",
      "leverage": "10"
    }
  ]
}

Response

Update leverage

HTTP Request

PATCH /api/v1/user/leverage

Update leverage for an individual market.

Modifying your leverage will impact your Available balance and Initial Margin requirements of your open position and orders in the market.

To adjust your leverage, you must meet two requirements: - The total value of your open position and triggered orders must remain below the maximum position value allowed for the selected leverage. - Your Available balance must be sufficient to cover the additional Margin requirements (if any) associated with the new leverage.

Failure to meet either of these criteria will result in an error.

For details on Margin requirements, please refer to the documentation.

Request example:

{
  "market": "BTC-USD",
  "leverage": "10"
}

Body Parameters

Response example:

{
  "status": "OK",
  "data": {
    "market": "BTC-USD",
    "leverage": "10"
  }
}

Response

Get fees

HTTP Request

GET /api/v1/user/fees?market={market}

Get current fees for the sub-account.

Fees on X10 are determined by:

1. The type of order: Maker vs. Taker,

2. The cumulative trading volume over the past 30 days.

For details on the Fee Schedule, please refer to the documentation.

Query Parameters

Response example:

{
  "status": "OK",
  "data": [
    {
      "market": "BTC-USD",
      "makerFeeRate": "0.0002",
      "takerFeeRate": "0.0005"
    }
  ]
}

Response

Order management

The Private API endpoints listed below allow you to create, cancel, and manage orders from the authenticated sub-account.

StarkEx-Specific Logic

X10's use of the StarkEx Layer 2 engine introduces unique elements to order creation that differ from centralized exchanges:

1. StarkKey Signature: Required for all order management endpoints. For details, please refer to the reference implementation in the Python SDK.

2. Price Parameter: All orders, including market orders, require a price as a mandatory parameter.

3. Fee Parameter: All orders require a fee as a mandatory parameter. The Fee parameter represents the maximum fee a user is willing to pay for an order. Use the maker fee for Post-only orders and the taker fee for all other orders. Enter the fee in decimal format (e.g., 0.1 for 10%). To view current fees, utilize the Get fees endpoint, which displays applicable fee rates.

4. Expiration Timestamp: All orders, including Fill or Kill and Immediate or Cancel orders, require an expiration timestamp as a mandatory parameter. When submitting orders via the API, enter the expiration time as an epoch timestamp in milliseconds. On the Mainnet, the maximum allowable expiration time is 90 days from the order creation date. On the Testnet, 28 days from the order creation date.

5. Market Orders: StarkEx does not natively support market orders. On the UI, market orders are created as limit IOC (Immediate-or-Cancel) orders with a price parameter set to ensure immediate execution. For example, Market Buy Orders are set at the best ask price multiplied by 1.05, and Market Sell Orders at the best bid price multiplied by 0.95 (subtracting 5%).

6. TPSL Orders: Orders with Take Profit and/or Stop Loss require multiple signatures. Please refer to the (documentation)[https://docs.x10.exchange/x10-resources/trading/order-types] to see supported types of TPSL orders.

Create or edit order

HTTP Request

POST /api/v1/user/order

Create a new order or edit (replace) an open order. When you create an order via our REST API, the initial response will confirm whether the order has been successfully accepted. Please be aware that, although rare, orders can be canceled or rejected by the Matching Engine even after acceptance at the REST API level. To receive real-time updates on your order status, it is crucial to subscribe to the Account updates WebSocket stream. This stream provides immediate notifications of any changes to your orders, including confirmations, cancellations, and rejections, allowing you to manage your trading strategies effectively.

Currently, we support limit, market, conditional and tpsl order types, along with reduce-only and post-only settings. For API trading, we offer the following Time-in-force settings: GTT (Good till time - default), FOK (Fill or kill) and IOC (Immediate or cancel). On the Mainnet, the maximum allowable expiration time for GTT orders is 90 days from the order creation date. On the Testnet, 28 days from the order creation date. For details on supported order types and settings, please refer to the documentation

To successfully place an order, it must meet the following requirements:

1. Trading Rules. For detailed information, please refer to the trading rules documentation.

2. Order Cost Requirements. For detailed information, please refer to the order cost documentation.

3. Margin Schedule Requirements. For detailed information, please refer to the margin schedule documentation.

4. Price requirements, which are described below.

Price requirements

1. Limit Orders

• Long Limit Orders: Order Price ≤ Mark Price * (1+Limit Order Price Cap)
• Short Limit Orders: Order Price ≥ Mark Price * (1-Limit Order Floor Ratio)

1. Market Orders

• Long Market Order: Order Price ≤ Mark Price * (1 + 15%)
• Short Market Order: Order Price ≥ Mark Price * (1 - 15%)

1. Conditional Orders

• Short Conditional Orders: Order Price ≥ Trigger price * (1-Limit Order Floor Ratio)
• Long Conditional Orders: Order Price ≤ Trigger Price * (1+Limit Order Price Cap)
• If a conditional order is triggered at placement, we apply the same validations as those for limit and market orders.

1. TPSL Orders

Entry order: Buy; TPSL order: Sell.

Entry order: Sell; TPSL order: Buy.

Orders Edit

To edit (replace) an open order, add its ID as the cancelId parameter. You can edit multiple parameters at once. Editing is available for all orders except for triggered TPSL orders.

Order editing and validations:

• If any updated parameter fails the validations described above, all updates will be rejected.
• If validations fail at the REST API level, the initial open order remains unchanged.
• In the rare event that validations pass at the REST API level but fail at the Matching Engine, both the updated order and the initial open order will be cancelled.

Editable Order Parameters:

• For All Order Types (except triggered TPSL orders): Order price and Execution Order Price Type (market or limit)
• For All Order Types (except untriggered entire position TPSL orders and triggered TPSL orders): Order size
• For Conditional and Untriggered TPSL Orders: Trigger price
• For Conditional Orders: Trigger price direction (up or down)
• For Non-TPSL Orders: All TPSL parameters

Request

Request example:

{
  "id": "e581a9ca-c3a2-4318-9706-3f36a2b858d3",
  "market": "BTC-USDT",
  "type": "CONDITIONAL",
  "side": "BUY",
  "qty": "1",
  "price": "1000",
  "timeInForce": "GTT",
  "expiryEpochMillis": 1715884049245,
  "fee": "0.0002",
  "nonce": "876542",
  "settlement": {
    "signature": {
      "r": "0x17a89cb97c64f546d2dc9189e1ef73547487b228945dcda406cd0e4b8301bd3",
      "s": "0x385b65811a0fc92f109d5ebc30731efd158ee4e502945cd2fcb35a4947b045e"
    },
    "starkKey": "0x23830b00378d17755775b5a73a5967019222997eb2660c2dbfbc74877c2730f",
    "collateralPosition": "4272448241247734333"
  },
  "reduceOnly": true,
  "postOnly": false,
  "trigger": {
    "triggerPrice": "12000",
    "triggerPriceType": "LAST",
    "direction": "UP",
    "executionPriceType": "LIMIT"
  },
  "tpSlType": "ORDER",
  "takeProfit": {
    "triggerPrice": "1050",
    "triggerPriceType": "LAST",
    "price": "1300",
    "priceType": "LIMIT",
    "settlement": {
      "signature": {
        "r": "0x5b45f0fb2b8e075f6a5f9b4c039ccf1c01c56aa212c63f943337b920103c3a1",
        "s": "0x46133ab89d90a3ae2a3a7680d2a27e30fa015c0c4979931164c51b52b27758a"
      },
      "starkKey": "0x23830b00378d17755775b5a73a5967019222997eb2660c2dbfbc74877c2730f",
      "collateralPosition": "4272448241247734333"
    }
  },
  "stopLoss": {
    "triggerPrice": "950",
    "triggerPriceType": "LAST",
    "price": "900",
    "priceType": "LIMIT",
    "settlement": {
      "signature": {
        "r": "0x5033ad23fe851d16ceec5dd99f2f0c9585c5abec3f09ec89a32a961536ba55",
        "s": "0x1234ee151a8b5c68efb4adaa2eaf1dcc4a5107d4446274a69389ef8abd2dcf"
      },
      "starkKey": "0x23830b00378d17755775b5a73a5967019222997eb2660c2dbfbc74877c2730f",
      "collateralPosition": "4272448241247734333"
    }
  }
}

Body Parameters

Response example:

{
  "status": "OK",
  "data": {
    "id": 1791389621914243072,
    "externalId": "31097979600959341921260192820644698907062844065707793749567497227004358262"
  }
}

Response

Cancel order

HTTP Request

DELETE /api/v1/user/order/{id}

Cancel an individual order by X10 ID.

The cancellation process is asynchronous; the endpoint returns only the status of the cancellation.

URL Parameters

DELETE /api/v1/user/order?externalId={externalId}

Cancel an individual order by user ID.

The cancellation process is asynchronous; the endpoint returns only the status of the cancellation.

URL Parameters

Response

Mass Cancel

HTTP Request

POST /api/v1/user/order/massCancel

Mass Cancel enables the cancellation of multiple orders by ID, by specific market, or for all orders within an account.

The cancellation process is asynchronous; the endpoint returns only the status of the cancellation request.

Although all parameters are optional, at least one must be specified.

Request example:

{
  "orderIds": [
    1,
    2
  ],
  "externalOrderIds": [
    "ExtId-1",
    "ExtId-2"
  ],
  "markets": [
    "BTC-USD",
    "ETH-USD"
  ],
  "cancelAll": true
}

Body Parameters

Response

Mass Auto-Cancel (Dead Man's Switch)

HTTP Request

POST /api/v1/user/deadmanswitch?countdownTime={countdownTime}

The dead man's switch automatically cancels all open orders for the account at the end of the specified countdown if no Mass Auto-Cancel request is received within this timeframe. Setting the time to zero will remove any outstanding scheduled cancellations.

Positions and account status are not affected by the dead man's switch.

Request Parameters

Response

Deposits

To deposit, please invoke the StarkEx contract. The contract address is 0x1cE5D7f52A8aBd23551e91248151CA5A13353C65.

Currently, we only support USDC deposits via the Ethereum network.

Create transfer

HTTP Request

POST /api/v1/user/transfer

Create a transfer between sub-accounts associated with the same L1 wallet.

Request

Request example:

{
  "fromAccount": 3004,
  "toAccount": 7349,
  "amount": "1000",
  "transferredAsset": "USD",
  "settlement": {
    "amount": 1000000000,
    "assetId": "0x31857064564ed0ff978e687456963cba09c2c6985d8f9300a1de4962fafa054",
    "expirationTimestamp": 478932,
    "nonce": 758978120,
    "receiverPositionId": 104350,
    "receiverPublicKey": "0x3895139a98a6168dc8b0db251bcd0e6dcf97fd1e96f7a87d9bd3f341753a844",
    "senderPositionId": 100005,
    "senderPublicKey": "0x3895139a98a6168dc8b0db251bcd0e6dcf97fd1e96f7a87d9bd3f341753a844",
    "signature": {
      "r": "6be1839e2ca76484a1a0fcaca9cbbe3792a23656d42ecee306c31e65aadb877",
      "s": "7b8f81258e16f0f90cd12f02e81427e54b4ebf7646e9b14b57f74c2cb44bff6"
    }
  }
}

Body Parameters

Response example:

{
  "status": "OK",
  "data": {
    "validSignature": true,
    "id": 1820778187672010752
  }
}

Response

Withdrawals

We support two types of withdrawals: fast and slow. Slow withdrawals can be made through both the API and UI, while fast withdrawals are available only via the UI. Withdrawals are permitted only to L1 wallets associated with the authorised account.

X10 doesn't charge fees on both types of withdrawals, but there are differences in processing.

Slow withdrawals:

Slow withdrawals involve a two-step process. The first step initiates your withdrawal request, which is processed on Layer 2. Once your funds are ready (this can take up to 12 hours), you can claim them to your wallet.

To initiate a slow withdrawal, send a "Create Slow Withdrawal" request as described below or use the corresponding SDK method slow_withdrawal, signed with a private L2 key.

To check if your funds are available for claim, use SDK method call_stark_perpetual_withdraw_balance.

To claim available funds, use SDK method call_stark_perpetual_withdraw, signed with a private L1 key.

Gas fee selection is currently not supported through the API. The gas value will be populated using the estimate_gas() function with an additional buffer of 100,000 gas up to the gasLimit of the latest block.

There is no maximum limit on the amount for slow withdrawals.

Fast withdrawals:

Processed almost instantly with a daily limit of $50,000 per calendar day.

A charge of 2x the current gas fee is applied to ensure transaction settlement in the event of gas cost volatility.

In rare instances, fast withdrawals may be unavailable due to liquidity gaps in the exchange's L1 wallet. If this occurs, please consider using slow withdrawals or try again later.

Fast withdrawals are not available for Market Makers and other institutional clients.

Create slow withdrawal

HTTP Request

POST /api/v1/user/withdrawal

Create a slow withdrawal to the L1 wallet associated with the authorised account. To avoid rejection, ensure that the withdrawal amount does not exceed your Available Balance for Withdrawals.

Available Balance for Withdrawals = max(0, Wallet Balance + min(0,Unrealised PnL) - Initial Margin Requirement).

Request

Request example: json { "type": "SLOW_SELF", "accountId": 3004, "amount": "1000", "asset": "USD", "settlement": { "amount": 1000000000, "collateralAssetId": "0x31857064564ed0ff978e687456963cba09c2c6985d8f9300a1de4962fafa054", "ethAddress": "0x1CE5161147db031d838F4BCDf86412C176d5a0D3", "expirationTimestamp": 479125, "nonce": 1696065254, "positionId": 100005, "publicKey": "0x3895139a98a6168dc8b0db251bcd0e6dcf97fd1e96f7a87d9bd3f341753a844", "signature": { "r": "34947b8a82c268d484dc5b879014a70acd6f071db2d80c356f47c5c56e8041d", "s": "37d5b153c786ba6b8b75a594e2e86f710404f0f045ac243a8db0002ff3aed27" } } }

Body Parameters

Response example: json { "status": "OK", "data": 1820796462590083072 }

Response

Public WebSocket streams

X10 offers a WebSocket API for streaming updates.

Connect to the WebSocket streams using wss://api.prod.x10.exchange as the host.

The server sends pings every 15 seconds and expects a pong response within 10 seconds. Although the server does not require pings from the client, it will respond with a pong if one is received.

Orderbooks stream

HTTP Request

GET /stream.x10.exchange/v1/orderbooks/{market}

Subscribe to the orderbooks stream for a specific market or for all available markets. If the market parameter is not submitted, the stream will include data for all available markets.

The initial response from the stream will be a snapshot of the order book. Subsequent updates occur every minute. All updates after the initial snapshot are delivered in delta format, reflecting only changes since the last update.

In the current version we support the following depth specifications:

• Full orderbook. Push frequency: 100ms.

• Best bid & ask. Push frequency: real-time. To subscribe for Best bid & ask use GET /stream.x10.exchange/v1/orderbooks/{market}?depth=1

URL Parameters

Query Parameters

Response example:

{
  "ts": 1701563440,
  "type": "SNAPSHOT",
  "data": {
    "m": "BTC-USD",
    "b": [
      {
        "p": "25670",
        "q": "0.1"
      }
    ],
    "a": [
      {
        "p": "25770",
        "q": "0.1"
      }
    ]
  },
  "seq": 1
}

Response

Trades stream

HTTP Request

GET /stream.x10.exchange/v1/publicTrades/{market}

Subscribe to the trades stream for a specific market or for all available markets. If the market parameter is not submitted, the stream will include data for all available markets.

Historical trades data is currently available only for an authorised account through the Private REST-API.

URL Parameters

Response example:

{
  "ts": 1701563440,
  "data": [
    {
      "m": "BTC-USD",
      "S": "BUY",
      "tT": "TRADE",
      "T": 1701563440,
      "p": "25670",
      "q": "0.1",
      "i": 25124
    }
  ],
  "seq": 2
}

Response

Funding rates stream

HTTP Request

GET /stream.x10.exchange/v1/funding/{market}

Subscribe to the funding rates stream for a specific market or for all available markets. If the market parameter is not submitted, the stream will include data for all available markets.

For historical funding rates data, use the Get funding rates history endpoint.

While the funding rate is calculated every minute, it is applied only once per hour. The records include only those funding rates that were used for funding fee payments.

URL Parameters

Response example:

{
  "ts": 1701563440,
  "data": [
    {
      "m": "BTC-USD",
      "T": 1701563440,
      "f": "0.001"
    }
  ],
  "seq": 2
}

Response

Candles stream

HTTP Request

GET /stream.x10.exchange/v1/candles/{market}/{candleType}?interval={interval}

Subscribe to the candles stream for a specific market or for all available markets. If the market parameter is not submitted, the stream will include data for all available markets.

The interval parameter should be specified in the ISO 8601 duration format. Available intervals include:

• PT24H

• PT4H

• PT2H

• PT1H

• PT30M

• PT15M

• PT5M

• PT1M

Trades price response example:

{
  "ts": 1695738675123,
  "data": [ 
    {
      "T": 1695738674000,
      "o": "1000.0000",
      "l": "800.0000",
      "h": "2400.0000",
      "c": "2100.0000",
      "v": "10.0000"
    }
  ],
  "seq": 1
}

Mark and Index price response example:

{
  "ts": 1695738675123,
  "data": [
    {
      "T": 1695738674000,
      "o": "1000.0000",
      "l": "800.0000",
      "h": "2400.0000",
      "c": "2100.0000"
    }
  ],
  "seq": 1
}

Available price types include:

1. Trades price: GET /stream.x10.exchange/v1/candles/{market}/trades?interval=PT1M

2. Mark price: GET /stream.x10.exchange/v1/candles/{market}/mark-prices?interval=PT1M

3. Index price: GET /stream.x10.exchange/v1/candles/{market}/index-prices?interval=PT1M

Push frequency: 1-10s.

URL Parameters

Query Parameters

Response

Private WebSocket streams

Connect to the WebSocket streams using ws://api.prod.x10.exchange as the host.

The server sends pings every 15 seconds and expects a pong response within 10 seconds. Although the server does not require pings from clients, it will respond with a pong if it receives one.

Account updates stream

HTTP Request

GET /stream.x10.exchange/v1/account

Orders updates response example:

{
  "type": "ORDER",
  "data": {
    "orders": [
      {
        "id": 1791181340771614723,
        "accountId": 1791181340771614721,
        "externalId": "-1771812132822291885",
        "market": "BTC-USD",
        "type": "LIMIT",
        "side": "BUY",
        "status": "NEW",
        "price": "12400.000000",
        "averagePrice": "13140.000000",
        "qty": "10.000000",
        "filledQty": "3.513000",
        "payedFee": "0.513000",
        "trigger": {
          "triggerPrice": "1220.00000",
          "triggerPriceType": "LAST",
          "direction": "UP",
          "executionPriceType": "LIMIT"
        },
        "tpSlType": "ORDER",
        "takeProfit": {
          "triggerPrice": "1.00000",
          "triggerPriceType": "LAST",
          "price": "1.00000",
          "priceType": "LIMIT"
        },
        "stopLoss": {
          "triggerPrice": "1.00000",
          "triggerPriceType": "LAST",
          "price": "1.00000",
          "priceType": "LIMIT"
        },
        "reduceOnly": true,
        "postOnly": false,
        "createdTime": 1715885888571,
        "expireTime": 1715885888571
      }
    ]
  },
  "ts": 1715885884837,
  "seq": 1
}

Trades updates response example:

{
  "type": "TRADE",
  "data": {
    "trades": [
      {
        "id": 1784963886257016832,
        "accountId": 3017,
        "market": "BTC-USD",
        "orderId": 9223372036854775808,
        "side": "BUY",
        "price": "58853.4000000000000000",
        "qty": "0.0900000000000000",
        "value": "5296.8060000000000000",
        "fee": "0.0000000000000000",
        "tradeType": "DELEVERAGE",
        "createdTime": 1701563440000,
        "isTaker": true
      }
    ]
  },
  "ts": 1715885884837,
  "seq": 1
}

Account balance updates response example:

{
  "type": "BALANCE",
  "data": {
    "balance": {
      "collateralName": "BTC",
      "balance": "100.000000",
      "equity": "20.000000",
      "availableForTrade": "3.000000",
      "availableForWithdrawal": "4.000000",
      "unrealisedPnl": "1.000000",
      "initialMargin": "0.140000",
      "marginRatio": "1.500000",
      "updatedTime": 1699976104901,
      "exposure": "12751.859629",
      "leverage": "1275.1860"
    }
  },
  "ts": 1715885952304,
  "seq": 1
}

Positions updates response example:

{
  "type": "POSITION",
  "data": {
    "positions": [
      {
        "id": 1791183357858545669,
        "accountId": 1791183357858545665,
        "market": "BTC-USD",
        "side": "SHORT",
        "leverage": "5.0",
        "size": "0.3",
        "value": "12751.8596295830",
        "openPrice": "42508.00",
        "markPrice": "42506.1987652769",
        "liquidationPrice": "75816.37",
        "margin": "637.59",
        "unrealisedPnl": "100.000000",
        "realisedPnl": "200.000000",
        "tpTriggerPrice": "1600.0000",
        "tpLimitPrice": "1500.0000",
        "slTriggerPrice": "1300.0000",
        "slLimitPrice": "1250.0000",
        "adl": 1,
        "createdAt": 1715886365748,
        "updatedAt": 1715886365748
      }
    ]
  },
  "ts": 1715886365748,
  "seq": 1
}

Subscribe to the account updates stream.

The initial responses will include comprehensive information about the account, including balance, open positions, and open orders, i.e. everything from GET /v1/user/balance, GET /v1/user/positions, GET /v1/user/orders.

Subsequent responses will contain all updates related to open orders, trades, account balance or open positions in a single message.

The response attributes will align with the responses from the corresponding REST API endpoints: Get trades, Get positions, Get open orders and Get balance. Refer to the Account section for details.

Market Makers Program

We provide a level playing field for all traders on X10, and we are introducing a maker's rewards program available to all traders without specific requirements. Details of the program and the application process are described here.

Market Makers are also eligible for higher Rate Limits. Currently, the Rate Limit for Market Makers is set at 6,000 requests per minute, shared across all endpoints. As our system grows, we plan to increase these limits.

Error responses

Unless specified otherwise for a particular endpoint and HTTP status code, the error response model follows the general response format and includes an error code along with a descriptive message for most errors.