StandX API

https://docs.standx.com/standx-api/
Admin
StandX API provides REST and WebSocket APIs for perpetual futures trading, enabling programmatic...
Tokens:22,194
Snippets:167
Trust Score:7.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Required Dependencies

Source: https://docs.standx.com/standx-api/perps-auth-svm-example

Run this command to install the necessary cryptographic and Solana-related packages.

```bash
npm install @noble/curves @scure/base @solana/web3.js bs58
```

--------------------------------

### Authentication Request Example

Source: https://docs.standx.com/standx-api/perps-ws

An example of a login request using the auth:login method.

```json
{
  "session_id": "consistent-session-id",
  "request_id": "unique-request-id",
  "method": "auth:login",
  "params": "{\"token\":\"your.jwt.token\"}"
}
```

--------------------------------

### Install Required Dependencies

Source: https://docs.standx.com/standx-api/perps-auth-evm-example

Install the necessary cryptographic and ethers libraries to support the authentication flow.

```bash
npm install @noble/curves @scure/base ethers
```

--------------------------------

### Query Order Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for the GET /api/query_order endpoint.

```json
{
  "avail_locked": "3.071880000",
  "cl_ord_id": "01K2BK4ZKQE0C308SRD39P8N9Z",
  "closed_block": -1,
  "created_at": "2025-08-11T03:35:25.559151Z",
  "created_block": -1,
  "fill_avg_price": "0",
  "fill_qty": "0",
  "id": 1820682,
  "leverage": "10",
  "liq_id": 0,
  "margin": "0",
  "order_type": "limit",
  "payload": null,
  "position_id": 15,
  "price": "121900.00",
  "qty": "0.060",
  "reduce_only": false,
  "remark": "",
  "side": "sell",
  "source": "user",
  "status": "open",
  "symbol": "BTC-USD",
  "time_in_force": "gtc",
  "updated_at": "2025-08-11T03:35:25.559151Z",
  "user": "bsc_0x..."
}
```

--------------------------------

### Get Server Time Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for the GET /api/kline/time endpoint.

```text
1620000000
```

--------------------------------

### Order Response Examples

Source: https://docs.standx.com/standx-api/perps-ws

Examples of accepted, success, and rejection responses received from the WebSocket channel.

```json
{
  "code": 0,
  "status": "accepted",
  "request_id": "bccc2b23-03dc-4c2b-4315ebbbb7e0-4315ebbbb7e0"
}
```

```json
{
  "code": 0,
  "message": "success",
  "request_id": "bccc2b23-03dc-4c2b-912f-4315ebbbb7e0"
}
```

```json
{
  "code": 400,
  "message": "alo order rejected",
  "request_id": "1187e114-1914-4111-8da1-2aaaa86bb1b9"
}
```

--------------------------------

### Query User Orders Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for the GET /api/query_orders endpoint.

```json
{
  "page_size": 1,
  "result": [
    {
      "avail_locked": "3.071880000",
      "cl_ord_id": "01K2BK4ZKQE0C308SRD39P8N9Z",
      "closed_block": -1,
      "created_at": "2025-08-11T03:35:25.559151Z",
      "created_block": -1,
      "fill_avg_price": "0",
      "fill_qty": "0",
      "id": 1820682,
      "leverage": "10",
      "liq_id": 0,
      "margin": "0",
      "order_type": "limit",
      "payload": null,
      "position_id": 15,
      "price": "121900.00",
      "qty": "0.060",
      "reduce_only": false,
      "remark": "",
      "side": "sell",
      "source": "user",
      "status": "new",
      "symbol": "BTC-USD",
      "time_in_force": "gtc",
      "updated_at": "2025-08-11T03:35:25.559151Z",
      "user": "bsc_0x..."
    }
  ],
  "total": 1
}
```

--------------------------------

### Query User Balances Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_balance endpoint.

```json
{
  "isolated_balance": "11443.3682400",
  "isolated_upnl": "-21.53540",
  "cross_balance": "1088575.259316737",
  "cross_margin": "2860.30367500",
  "cross_upnl": "31.61532",
  "locked": "0.000000000",
  "cross_available": "1085746.571",
  "balance": "1100018.627556737",
  "upnl": "10.07992",
  "equity": "1100028.707476657",
  "pnl_freeze": "31.61532"
}
```

--------------------------------

### Query Funding Rates Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_funding_rates endpoint.

```json
[
  {
    "id": 1,
    "symbol": "BTC-USD",
    "funding_rate": "0.0001",
    "index_price": "121601.158461",
    "mark_price": "121602.43",
    "premium": "0.0001",
    "time": "2025-08-11T03:48:47.086505Z",
    "created_at": "2025-08-11T03:48:47.086505Z",
    "updated_at": "2025-08-11T03:48:47.086505Z"
  }
]
```

--------------------------------

### Vault Impersonation with cURL

Source: https://docs.standx.com/standx-api/perps-auth

Examples of GET and POST requests using the x-impersonate header via cURL.

```bash
# GET request
curl 'https://api.standx.com/v1/<endpoint>' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-impersonate: cv_xxxxxxxx'
 
# POST request
curl 'https://api.standx.com/v1/<endpoint>' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-request-sign-version: v1' \
  -H 'x-request-id: <uuid>' \
  -H 'x-request-timestamp: <timestamp>' \
  -H 'x-request-signature: <signature>' \
  -H 'x-impersonate: cv_xxxxxxxx' \
  --data-raw '{ ... }'
```

--------------------------------

### Query User Positions Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_positions endpoint.

```json
[
  {
    "bankruptcy_price": "109608.01",
    "created_at": "2025-08-10T09:05:50.265265Z",
    "entry_price": "121737.96",
    "entry_value": "114433.68240",
    "holding_margin": "11443.3682400",
    "id": 15,
    "initial_margin": "11443.36824",
    "leverage": "10",
    "liq_price": "112373.50",
    "maint_margin": "2860.30367500",
    "margin_asset": "DUSD",
    "margin_mode": "isolated",
    "mark_price": "121715.05",
    "mmr": "3.993223845366698695025800014",
    "position_value": "114412.14700",
    "qty": "0.940",
    "realized_pnl": "31.61532",
    "status": "open",
    "symbol": "BTC-USD",
    "time": "2025-08-11T03:41:40.922818Z",
    "updated_at": "2025-08-10T09:05:50.265265Z",
    "upnl": "-21.53540",
    "user": "bsc_0x..."
  }
]
```

--------------------------------

### Query User Funding History Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_funding_history endpoint.

```json
[
  {
    "id": 12345,
    "user": "bsc_0x...",
    "asset": "DUSD",
    "symbol": "BTC-USD",
    "qty": "-0.123456",
    "txn_type": "funding",
    "transact_time": "2025-08-11T08:00:00Z",
    "created_at": "2025-08-11T08:00:00.123456Z",
    "updated_at": "2025-08-11T08:00:00.123456Z"
  }
]
```

--------------------------------

### Query Symbol Info Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for retrieving configuration details of a specific trading pair.

```json
[
  {
    "base_asset": "BTC",
    "base_decimals": 9,
    "created_at": "2025-07-10T05:15:32.089568Z",
    "def_leverage": "10",
    "depth_ticks": "0.01,0.1,1",
    "enabled": true,
    "maker_fee": "0.0001",
    "max_leverage": "20",
    "max_open_orders": "100",
    "max_order_qty": "100",
    "max_position_size": "1000",
    "min_order_qty": "0.0001",
    "price_cap_ratio": "0.3",
    "price_floor_ratio": "0.3",
    "price_tick_decimals": 2,
    "qty_tick_decimals": 4,
    "quote_asset": "DUSD",
    "quote_decimals": 9,
    "symbol": "BTC-USD",
    "taker_fee": "0.0004",
    "updated_at": "2025-07-10T05:15:32.089568Z"
  }
]
```

--------------------------------

### Query Position Config Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_position_config endpoint.

```json
{
  "symbol": "BTC-USD",
  "leverage": 10,
  "margin_mode": "cross"
}
```

--------------------------------

### Login Success Response

Source: https://docs.standx.com/standx-api/perps-auth

Example JSON structure returned upon successful authentication.

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "address": "0x...",
  "alias": "user123",
  "chain": "bsc",
  "perpsAlpha": true
}
```

--------------------------------

### Query User Trades Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_trades endpoint.

```json
{
  "page_size": 1,
  "result": [
    {
      "created_at": "2025-08-11T03:36:19.352620Z",
      "fee_asset": "DUSD",
      "fee_qty": "0.121900",
      "id": 409870,
      "order_id": 1820682,
      "pnl": "1.62040",
      "price": "121900",
      "qty": "0.01",
      "side": "sell",
      "symbol": "BTC-USD",
      "updated_at": "2025-08-11T03:36:19.352620Z",
      "user": "bsc_0x...",
      "value": "1219.00"
    }
  ],
  "total": 1
}
```

--------------------------------

### Query Market Overview Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for the market overview endpoint, providing aggregated data for all supported trading pairs.

```json
{
  "summary": {
    "open_interest_notional": "122904802.996536",
    "symbol_count": 5,
    "volume_quote_24h": "560815382.03054878581315279005"
  },
  "symbols": [
    {
      "base": "BTC",
      "funding_rate": "-0.00000999",
      "last_price": "72681.45",
      "mark_price": "72697.39",
      "open_interest": "1154.4344",
      "open_interest_notional": "83924367.806216",
      "price_change_pct": 0.945710770122798,
      "quote": "DUSD",
      "symbol": "BTC-USD",
      "time": "2026-04-10T16:29:17.400234Z",
      "volume_24h": "6202.664199999995616963133214",
      "volume_quote_24h": "447190753.290538787841796875"
    },
    {
      "base": "ETH",
      "funding_rate": "-0.00000157",
      "last_price": "2238.30",
      "mark_price": "2238.7",
      "open_interest": "16586.2040",
      "open_interest_notional": "37131534.89480",
      "price_change_pct": 1.33991218143135,
      "quote": "DUSD",
      "symbol": "ETH-USD",
      "time": "2026-04-10T16:29:17.400234Z",
      "volume_24h": "39606.743999999984225723892442",
      "volume_quote_24h": "87325756.45479999482631683348"
    }
  ]
}
```

--------------------------------

### Query Recent Trades Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/query_recent_trades endpoint.

```json
[
  {
    "is_buyer_taker": true,
    "price": "121720.18",
    "qty": "0.01",
    "quote_qty": "1217.2018",
    "symbol": "BTC-USD",
    "time": "2025-08-11T03:48:47.086505Z"
  },
  {
    "is_buyer_taker": true,
    "price": "121720.18",
    "qty": "0.01",
    "quote_qty": "1217.2018",
    "symbol": "BTC-USD",
    "time": "2025-08-11T03:48:46.850415Z"
  }
]
```

--------------------------------

### Get Kline History Response

Source: https://docs.standx.com/standx-api/perps-http

Example JSON response for the GET /api/kline/history endpoint.

```json
{
  "s": "ok",
  "t": [1754897028, 1754897031],
  "c": [121897.95, 121903.04],
  "o": [121896.02, 121898.05],
  "h": [121897.95, 121903.15],
  "l": [121895.92, 121898.05],
  "v": [0.09, 10.542]
}
```

--------------------------------

### GET /api/query_market_overview

Source: https://docs.standx.com/standx-api/perps-http

Returns a summary of all supported markets, including 24h volume, open interest, funding rates, and latest prices.

```APIDOC
## GET /api/query_market_overview

### Description
Returns a summary of all supported markets, including 24h volume, open interest, funding rates, and latest prices.

### Method
GET

### Endpoint
/api/query_market_overview

### Response
#### Success Response (200)
- **summary** (object) - Total market statistics
- **symbols** (array) - List of individual market data
```

--------------------------------

### GET https://geo.standx.com/v1/region

Source: https://docs.standx.com/standx-api/perps-http

Retrieves the current system time and regional configuration.

```APIDOC
## GET https://geo.standx.com/v1/region

### Description
Returns the current system time and the assigned region for the request.

### Method
GET

### Endpoint
https://geo.standx.com/v1/region

### Response
#### Success Response (200)
- **systemTime** (number) - The current system timestamp.
- **region** (string) - The region code.

#### Response Example
{
  "systemTime": 1761970177865,
  "region": "jp"
}
```

--------------------------------

### GET /api/query_open_orders

Source: https://docs.standx.com/standx-api/perps-http

Queries all currently open orders for the user.

```APIDOC
## GET /api/query_open_orders

### Description
Retrieves all open orders for the authenticated user.

### Method
GET

### Endpoint
/api/query_open_orders

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Trading pair
- **limit** (number) - Optional - Results limit

### Response
#### Response Example
{
  "page_size": 1,
  "result": [],
  "total": 1
}
```

--------------------------------

### StandX Authentication Implementation

Source: https://docs.standx.com/standx-api/perps-auth-svm-example

A complete TypeScript class for managing authentication, JWT parsing, and request signing, followed by a usage example for Solana wallets.

```typescript
import { ed25519 } from "@noble/curves/ed25519";
import { base58 } from "@scure/base";
import bs58 from "bs58";
import { Keypair } from "@solana/web3.js";
 
// Types
export type Chain = "bsc" | "solana";
 
export interface SignedData {
  domain: string;
  uri: string;
  statement: string;
  version: string;
  chainId: number;
  nonce: string;
  address: string;
  requestId: string;
  issuedAt: string;
  message: string;
  exp: number;
  iat: number;
}
 
export interface LoginResponse {
  token: string;
  address: string;
  alias: string;
  chain: string;
  perpsAlpha: boolean;
}
 
export interface RequestSignatureHeaders {
  "x-request-sign-version": string;
  "x-request-id": string;
  "x-request-timestamp": string;
  "x-request-signature": string;
}
 
// Authentication Class
export class StandXAuth {
  private ed25519PrivateKey: Uint8Array;
  private ed25519PublicKey: Uint8Array;
  private requestId: string;
  private baseUrl = "https://api.standx.com";
 
  constructor() {
    const privateKey = ed25519.utils.randomSecretKey();
    this.ed25519PrivateKey = privateKey;
    this.ed25519PublicKey = ed25519.getPublicKey(privateKey);
    this.requestId = base58.encode(this.ed25519PublicKey);
  }
 
  async authenticate(
    chain: Chain,
    walletAddress: string,
    signMessage: (msg: string, payload: SignedData) => Promise<string>
  ): Promise<LoginResponse> {
    const signedDataJwt = await this.prepareSignIn(chain, walletAddress);
    const payload = this.parseJwt<SignedData>(signedDataJwt);
    const signature = await signMessage(payload.message, payload);
    return this.login(chain, signature, signedDataJwt);
  }
 
  private async prepareSignIn(chain: Chain, address: string): Promise<string> {
    const res = await fetch(
      `${this.baseUrl}/v1/offchain/prepare-signin?chain=${chain}`,
      {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ address, requestId: this.requestId }),
      }
    );
    const data = await res.json();
    if (!data.success) throw new Error("Failed to prepare sign-in");
    return data.signedData;
  }
 
  private async login(
    chain: Chain,
    signature: string,
    signedData: string,
    expiresSeconds: number = 604800 // default: 7 days
  ): Promise<LoginResponse> {
    const res = await fetch(
      `${this.baseUrl}/v1/offchain/login?chain=${chain}`,
      {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ signature, signedData, expiresSeconds }),
      }
    );
    return res.json();
  }
 
  signRequest(
    payload: string,
    requestId: string,
    timestamp: number
  ): RequestSignatureHeaders {
    const version = "v1";
    const message = `${version},${requestId},${timestamp},${payload}`;
    const signature = ed25519.sign(
      Buffer.from(message, "utf-8"),
      this.ed25519PrivateKey
    );
 
    return {
      "x-request-sign-version": version,
      "x-request-id": requestId,
      "x-request-timestamp": timestamp.toString(),
      "x-request-signature": Buffer.from(signature).toString("base64"),
    };
  }
 
  private parseJwt<T>(token: string): T {
    const base64Url = token.split(".")[1];
    const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
    return JSON.parse(Buffer.from(base64, "base64").toString("utf-8"));
  }
}
 
// Usage Example
async function main() {
  // Initialize auth
  const auth = new StandXAuth();
 
  // Setup wallet from base58-encoded private key
  const privateKey = process.env.SOLANA_PRIVATE_KEY!;
  const walletKeypair = Keypair.fromSecretKey(bs58.decode(privateKey));
  const walletAddress = walletKeypair.publicKey.toBase58();
 
  // Authenticate
  const loginResponse = await auth.authenticate(
    "solana",
    walletAddress,
    async (message, payload) => {
      const messageBytes = new TextEncoder().encode(message);
      const signatureBytes = ed25519.sign(
        messageBytes,
        walletKeypair.secretKey.slice(0, 32) // First 32 bytes are the private key
      );
 
      // Solana requires a specific signature format
      return Buffer.from(
        JSON.stringify({
          input: payload,
          output: {
            signedMessage: Array.from(messageBytes),
            signature: Array.from(signatureBytes),
            account: {
              publicKey: Array.from(walletKeypair.publicKey.toBytes()),
            },
          },
        })
      ).toString("base64");
    }
  );
 
  console.log("Access Token:", loginResponse.token);
 
  // Sign a request
```

--------------------------------

### GET /api/query_balance

Source: https://docs.standx.com/standx-api/perps-http

Retrieves a unified balance snapshot for the user.

```APIDOC
## GET /api/query_balance

### Description
Provides a unified balance snapshot including isolated and cross wallet details. Authentication is required.

### Method
GET

### Endpoint
/api/query_balance

### Response
#### Success Response (200)
- **isolated_balance** (decimal) - Isolated wallet total
- **cross_balance** (decimal) - Cross wallet free balance
- **balance** (decimal) - Total account assets
- **equity** (decimal) - Account equity

### Response Example
{
  "isolated_balance": "11443.3682400",
  "isolated_upnl": "-21.53540",
  "cross_balance": "1088575.259316737",
  "cross_margin": "2860.30367500",
  "cross_upnl": "31.61532",
  "locked": "0.000000000",
  "cross_available": "1085746.571",
  "balance": "1100018.627556737",
  "upnl": "10.07992",
  "equity": "1100028.707476657",
  "pnl_freeze": "31.61532"
}
```

--------------------------------

### Manual Ping Implementation with ws

Source: https://docs.standx.com/standx-api/perps-ws

Example of manually sending a ping frame to the server using the npm ws library for environments without automatic heartbeat support.

```typescript
import WebSocket from "ws";
// ...
private ws: WebSocket;
//...
ping(): void {
  this.lastPingTime = Date.now();
  this.ws.ping();
  console.log(`[${new Date().toISOString()}] Ping server`);
}
```

--------------------------------

### Implement StandX Authentication Class

Source: https://docs.standx.com/standx-api/perps-auth-evm-example

A complete TypeScript implementation including the StandXAuth class for handling sign-in, login, and request signing, along with a usage example for BSC.

```typescript
import { ed25519 } from "@noble/curves/ed25519";
import { base58 } from "@scure/base";
import { ethers } from "ethers";
 
// Types
export type Chain = "bsc" | "solana";
 
export interface SignedData {
  domain: string;
  uri: string;
  statement: string;
  version: string;
  chainId: number;
  nonce: string;
  address: string;
  requestId: string;
  issuedAt: string;
  message: string;
  exp: number;
  iat: number;
}
 
export interface LoginResponse {
  token: string;
  address: string;
  alias: string;
  chain: string;
  perpsAlpha: boolean;
}
 
export interface RequestSignatureHeaders {
  "x-request-sign-version": string;
  "x-request-id": string;
  "x-request-timestamp": string;
  "x-request-signature": string;
}
 
// Authentication Class
export class StandXAuth {
  private ed25519PrivateKey: Uint8Array;
  private ed25519PublicKey: Uint8Array;
  private requestId: string;
  private baseUrl = "https://api.standx.com";
 
  constructor() {
    const privateKey = ed25519.utils.randomSecretKey();
    this.ed25519PrivateKey = privateKey;
    this.ed25519PublicKey = ed25519.getPublicKey(privateKey);
    this.requestId = base58.encode(this.ed25519PublicKey);
  }
 
  async authenticate(
    chain: Chain,
    walletAddress: string,
    signMessage: (msg: string) => Promise<string>
  ): Promise<LoginResponse> {
    const signedDataJwt = await this.prepareSignIn(chain, walletAddress);
    const payload = this.parseJwt<SignedData>(signedDataJwt);
    const signature = await signMessage(payload.message);
    return this.login(chain, signature, signedDataJwt);
  }
 
  private async prepareSignIn(chain: Chain, address: string): Promise<string> {
    const res = await fetch(
      `${this.baseUrl}/v1/offchain/prepare-signin?chain=${chain}`,
      {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ address, requestId: this.requestId }),
      }
    );
    const data = await res.json();
    if (!data.success) throw new Error("Failed to prepare sign-in");
    return data.signedData;
  }
 
  private async login(
    chain: Chain,
    signature: string,
    signedData: string,
    expiresSeconds: number = 604800 // default: 7 days
  ): Promise<LoginResponse> {
    const res = await fetch(
      `${this.baseUrl}/v1/offchain/login?chain=${chain}`,
      {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify({ signature, signedData, expiresSeconds }),
      }
    );
    return res.json();
  }
 
  signRequest(
    payload: string,
    requestId: string,
    timestamp: number
  ): RequestSignatureHeaders {
    const version = "v1";
    const message = `${version},${requestId},${timestamp},${payload}`;
    const signature = ed25519.sign(
      Buffer.from(message, "utf-8"),
      this.ed25519PrivateKey
    );
 
    return {
      "x-request-sign-version": version,
      "x-request-id": requestId,
      "x-request-timestamp": timestamp.toString(),
      "x-request-signature": Buffer.from(signature).toString("base64"),
    };
  }
 
  private parseJwt<T>(token: string): T {
    const base64Url = token.split(".")[1];
    const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
    return JSON.parse(Buffer.from(base64, "base64").toString("utf-8"));
  }
}
 
// Usage Example
async function main() {
  // Initialize auth
  const auth = new StandXAuth();
 
  // Setup wallet
  const provider = new ethers.JsonRpcProvider(
    "https://bsc-dataseed.binance.org/"
  );
  const privateKey = process.env.WALLET_PRIVATE_KEY!;
  const wallet = new ethers.Wallet(privateKey, provider);
 
  // Authenticate
  const loginResponse = await auth.authenticate(
    "bsc",
    wallet.address,
    async (message) => wallet.signMessage(message)
  );
 
  console.log("Access Token:", loginResponse.token);
 
  // Sign a request
  const payload = JSON.stringify({
    symbol: "BTC-USD",
    side: "buy",
    order_type: "limit",
    qty: "0.1",
    price: "50000",
    time_in_force: "gtc",
    reduce_only: false,
  });
 
  const headers = auth.signRequest(payload, crypto.randomUUID(), Date.now());
 
  // Make authenticated request
  await fetch("https://perps.standx.com/api/new_order", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${loginResponse.token}`,
      ...headers,
    },
    body: payload,
  });
}
 
main().catch(console.error);
```

--------------------------------

### Query Symbol Price Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for retrieving current price metrics for a specific trading pair.

```json
{
  "base": "BTC",
  "index_price": "121601.158461",
  "last_price": "121599.94",
  "mark_price": "121602.43",
  "mid_price": "121599.99",
  "quote": "DUSD",
  "spread_ask": "121600.04",
  "spread_bid": "121599.94",
  "symbol": "BTC-USD",
  "time": "2025-08-11T03:44:40.922233Z"
}
```

--------------------------------

### EVM Withdraw Implementation

Source: https://docs.standx.com/standx-api/wallet-operation

Example using viem to interact with the Highway contract for processing a withdrawal request.

```typescript
import {
  createPublicClient,
  createWalletClient,
  custom,
  http,
  parseUnits,
} from "viem";
import { bsc } from "viem/chains";
import highwayAbi from "./highway.json";
 
const publicClient = createPublicClient({
  chain: bsc,
  transport: http(),
});
 
const walletClient = createWalletClient({
  chain: bsc,
  transport: custom(window.ethereum),
});
 
const [account] = await walletClient.getAddresses();
 
const withdrawRequest = await signedBridgeRequest("/api/withdraw", {
  amount: "2",
  chain: "bsc",
  token: "DUSD",
});
 
const onchainAmount =
  parseUnits(withdrawRequest.tx.token_amount, 18) -
  parseUnits(withdrawRequest.withdraw_fee, 18);
 
const message = {
  token: withdrawRequest.tx.token_addr as `0x${string}`,
  amount: onchainAmount,
  nonce: BigInt(withdrawRequest.tx.nonce),
};
 
const signature = {
  expiredAt: BigInt(withdrawRequest.signature.expired_at),
  chainId: BigInt(withdrawRequest.signature.chain_id),
  caller: withdrawRequest.signature.caller as `0x${string}`,
  contractAddress: withdrawRequest.signature.contract_address as `0x${string}`,
  signature: withdrawRequest.signature.signature as `0x${string}`,
};
 
const { request } = await publicClient.simulateContract({
  address: signature.contractAddress,
  abi: highwayAbi,
  functionName: "reqRemoteCall",
  args: [message, signature],
  account,
});
 
const txHash = await walletClient.writeContract(request);
```

--------------------------------

### GET /api/query_symbol_info

Source: https://docs.standx.com/standx-api/perps-http

Retrieves configuration and metadata for a specific trading pair.

```APIDOC
## GET /api/query_symbol_info

### Description
Retrieves configuration and metadata for a specific trading pair.

### Method
GET

### Endpoint
/api/query_symbol_info

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Trading pair identifier
```

--------------------------------

### GET /api/query_position_config

Source: https://docs.standx.com/standx-api/perps-http

Retrieves the configuration for a specific position.

```APIDOC
## GET /api/query_position_config

### Description
Retrieves the position configuration for a given symbol. Authentication is required.

### Method
GET

### Endpoint
/api/query_position_config

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Trading pair

### Response Example
{
  "symbol": "BTC-USD",
  "leverage": 10,
  "margin_mode": "cross"
}
```

--------------------------------

### Query Depth Book Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for the order book depth. Note that price levels are not guaranteed to be sorted.

```json
{
  "asks": [
    ["121895.81", "0.843"],
    ["121896.11", "0.96"]
  ],
  "bids": [
    ["121884.01", "0.001"],
    ["121884.31", "0.001"]
  ],
  "symbol": "BTC-USD"
}
```

--------------------------------

### GET /api/kline/time

Source: https://docs.standx.com/standx-api/perps-http

Retrieves the current server time.

```APIDOC
## GET /api/kline/time

### Description
Returns the current server time.

### Method
GET

### Endpoint
/api/kline/time
```

--------------------------------

### GET /api/query_positions

Source: https://docs.standx.com/standx-api/perps-http

Retrieves the user's current open positions.

```APIDOC
## GET /api/query_positions

### Description
Retrieves the user's current open positions. Authentication is required.

### Method
GET

### Endpoint
/api/query_positions

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Trading pair

### Response Example
[
  {
    "bankruptcy_price": "109608.01",
    "entry_price": "121737.96",
    "id": 15,
    "leverage": "10",
    "liq_price": "112373.50",
    "margin_mode": "isolated",
    "qty": "0.940",
    "status": "open",
    "symbol": "BTC-USD",
    "user": "bsc_0x..."
  }
]
```

--------------------------------

### Query Symbol Market Response

Source: https://docs.standx.com/standx-api/perps-http

Example response for retrieving comprehensive market statistics for a specific trading pair.

```json
{
  "base": "BTC",
  "funding_rate": "0.00010000",
  "high_price_24h": "122164.08",
  "index_price": "121601.158461",
  "last_price": "121599.94",
  "low_price_24h": "114098.44",
  "mark_price": "121602.43",
  "mid_price": "121599.99",
  "next_funding_time": "2025-08-11T08:00:00Z",
  "open_interest": "15.948",
  "quote": "DUSD",
  "spread": ["121599.94", "121600.04"],
  "symbol": "BTC-USD",
  "time": "2025-08-11T03:44:40.922233Z",
  "volume_24h": "9030.51800000000002509"
}
```

--------------------------------

### Example signedData Payload

Source: https://docs.standx.com/standx-api/perps-auth

A sample structure of the payload returned within the signedData JWT.

```json
{
  "domain": "standx.com",
  "uri": "https://standx.com",
  "statement": "Sign in with Ethereum to access more StandX features...",
  "version": "1",
  "chainId": 56,
  "nonce": "74Gd7Plf3a1TMVElc",
  "address": "0x...",
  "requestId": "<requestId>",
  "issuedAt": "2025-10-12T17:46:44.731Z",
  "message": "standx.com wants you to sign in with your Ethereum account:\n...",
  "exp": 1760291384,
  "iat": 1760291204
}
```

--------------------------------

### Transfer Margin Request and Response

Source: https://docs.standx.com/standx-api/perps-http

Example request body and successful response for the POST /api/transfer_margin endpoint.

```json
{
  "symbol": "BTC-USD",
  "amount_in": "1000.0"
}
```

```json
{
  "code": 0,
  "message": "success",
  "request_id": "xxx-xxx-xxx"
}
```

--------------------------------

### Authenticated Order Request

Source: https://docs.standx.com/standx-api/perps-auth-svm-example

Example of signing a payload and sending an authenticated POST request to the new_order endpoint.

```javascript
  const payload = JSON.stringify({
    symbol: "BTC-USD",
    side: "buy",
    order_type: "limit",
    qty: "0.1",
    price: "50000",
    time_in_force: "gtc",
    reduce_only: false,
  });
 
  const headers = auth.signRequest(payload, crypto.randomUUID(), Date.now());
 
  // Make authenticated request
  await fetch("https://perps.standx.com/api/new_order", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${loginResponse.token}`,
      ...headers,
    },
    body: payload,
  });
}
 
main().catch(console.error);
```

--------------------------------

### GET /v1/offchain/certs

Source: https://docs.standx.com/standx-api/perps-auth

Retrieve the public key required to verify the signedData JWT.

```APIDOC
## GET /v1/offchain/certs

### Description
Retrieve the public key required to verify the signedData JWT.

### Method
GET

### Endpoint
https://api.standx.com/v1/offchain/certs
```

--------------------------------

### GET /api/query_orders

Source: https://docs.standx.com/standx-api/perps-http

Queries a list of user orders based on filters.

```APIDOC
## GET /api/query_orders

### Description
Retrieves a list of user orders with optional filtering.

### Method
GET

### Endpoint
/api/query_orders

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Trading pair
- **status** (enum) - Optional - Order status
- **order_type** (enum) - Optional - Order type
- **start** (string) - Optional - Start time in ISO 8601
- **end** (string) - Optional - End time in ISO 8601
- **last_id** (number) - Optional - Last order ID for pagination
- **limit** (number) - Optional - Results limit

### Response
#### Response Example
{
  "page_size": 1,
  "result": [],
  "total": 1
}
```

--------------------------------

### GET /api/query_funding_history

Source: https://docs.standx.com/standx-api/perps-http

Returns the user’s funding payment and receipt history.

```APIDOC
## GET /api/query_funding_history

### Description
Returns the user’s funding payment/receipt history. Authentication is required.

### Method
GET

### Endpoint
/api/query_funding_history

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Trading pair
- **start** (string) - Optional - Start time in ISO 8601 format
- **end** (string) - Optional - End time in ISO 8601 format
- **last_id** (number) - Optional - Last funding transaction ID for pagination
- **limit** (number) - Optional - Results limit

### Response
#### Success Response (200)
- **id** (int) - Funding transaction ID
- **user** (string) - User identifier
- **asset** (string) - Settlement asset
- **symbol** (string) - Trading pair
- **qty** (decimal) - Funding amount
- **txn_type** (string) - Transaction type
- **transact_time** (string) - Funding settlement time (ISO 8601)

### Response Example
[
  {
    "id": 12345,
    "user": "bsc_0x...",
    "asset": "DUSD",
    "symbol": "BTC-USD",
    "qty": "-0.123456",
    "txn_type": "funding",
    "transact_time": "2025-08-11T08:00:00Z",
    "created_at": "2025-08-11T08:00:00.123456Z",
    "updated_at": "2025-08-11T08:00:00.123456Z"
  }
]
```

--------------------------------

### GET /api/query_funding_rates

Source: https://docs.standx.com/standx-api/perps-http

Retrieves historical funding rates for a specified trading pair within a given time range.

```APIDOC
## GET /api/query_funding_rates

### Description
Retrieves historical funding rates for a specific symbol between a start and end time.

### Method
GET

### Endpoint
/api/query_funding_rates

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Trading pair (see Reference)
- **start_time** (int) - Required - Start time in milliseconds
- **end_time** (int) - Required - End time in milliseconds
```

--------------------------------

### Configure Environment Variables

Source: https://docs.standx.com/standx-api/perps-auth-evm-example

Define the private key in a .env file to avoid hardcoding credentials.

```text
WALLET_PRIVATE_KEY=your_private_key_here
```

--------------------------------

### POST /v1/offchain/prepare-signin

Source: https://docs.standx.com/standx-api/perps-auth

Request signature data from the server to initiate the authentication process.

```APIDOC
## POST /v1/offchain/prepare-signin

### Description
Request signature data from the server to initiate the authentication process.

### Method
POST

### Endpoint
https://api.standx.com/v1/offchain/prepare-signin?chain={chain}

### Parameters
#### Query Parameters
- **chain** (string) - Required - Blockchain network: bsc or solana

#### Request Body
- **address** (string) - Required - Wallet address
- **requestId** (string) - Required - Base58-encoded ed25519 public key

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **signedData** (string) - JWT string containing the payload to be signed
```

--------------------------------

### order:new

Source: https://docs.standx.com/standx-api/perps-ws

Creates a new order via the WebSocket connection.

```APIDOC
## order:new

### Description
Creates a new order. Parameters are the same as the HTTP API new_order payload.

### Request Structure
- **session_id** (uuid) - Required
- **request_id** (uuid) - Required
- **method** (string) - Required - "order:new"
- **header** (object) - Required - Authentication headers (x-request-id, x-request-timestamp, x-request-signature)
- **params** (string) - Required - JSON-stringified parameters specific to the new_order payload
```

--------------------------------

### GET /api/health

Source: https://docs.standx.com/standx-api/perps-http

Performs a health check on the API service.

```APIDOC
## GET /api/health

### Description
Checks the operational status of the API.

### Method
GET

### Endpoint
/api/health

### Response
#### Success Response (200)
- **body** (string) - Returns "OK" if the service is healthy.
```

--------------------------------

### Using Access Token

Source: https://docs.standx.com/standx-api/perps-auth

Instructions for using the obtained JWT token in subsequent API requests.

```APIDOC
## Authorization

### Description
Use the obtained token for subsequent API requests by adding the Authorization header.

### Header
- **Authorization**: Bearer <token>
```

--------------------------------

### Request Signature Data via curl

Source: https://docs.standx.com/standx-api/perps-auth

Use this command to fetch the required signature data from the StandX API.

```bash
curl 'https://api.standx.com/v1/offchain/prepare-signin?chain=<chain>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "address": "<your_wallet_address>",
    "requestId": "<base58_encoded_public_key>"
  }'
```

--------------------------------

### Configure Solana Private Key Environment Variable

Source: https://docs.standx.com/standx-api/perps-auth-svm-example

Define the SOLANA_PRIVATE_KEY variable in a .env file to authenticate requests. Ensure the key is base58 encoded and kept secure from version control.

```text
SOLANA_PRIVATE_KEY=your_base58_encoded_private_key_here
```

--------------------------------

### GET /api/kline/history

Source: https://docs.standx.com/standx-api/perps-http

Retrieves historical kline data for a specified trading pair.

```APIDOC
## GET /api/kline/history

### Description
Retrieves historical kline data for a specific symbol within a time range.

### Method
GET

### Endpoint
/api/kline/history

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Trading pair (see Reference)
- **from** (u64) - Required - Unix timestamp in seconds
- **to** (u64) - Required - Unix timestamp in seconds
- **resolution** (enum) - Required - Resolution (see Reference)
- **countback** (u64) - Optional - The required amount of bars to load
```

--------------------------------

### GET /api/query_recent_trades

Source: https://docs.standx.com/standx-api/perps-http

Retrieves a list of recent trades for a specified trading pair.

```APIDOC
## GET /api/query_recent_trades

### Description
Retrieves the most recent trades for a given trading pair.

### Method
GET

### Endpoint
/api/query_recent_trades

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Trading pair (see Reference)
```

--------------------------------

### GET /api/query_depth_book

Source: https://docs.standx.com/standx-api/perps-http

Retrieves the order book depth for a specific trading pair.

```APIDOC
## GET /api/query_depth_book

### Description
Retrieves the order book depth for a specific trading pair. Note: The sequence of price levels in the asks and bids arrays is not guaranteed.

### Method
GET

### Endpoint
/api/query_depth_book

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Trading pair identifier
```
Tokens:
Raw