apex-perpetual-engine-api-typescript

Developer-friendly, idiomatic Typescript SDK for the apex-perpetual-engine-api-typescript API.

Summary

Apex Perpetual Engine API: REST API for the Apex Perpetual Engine - provides perpetual futures market data, user analytics, trading history, leaderboards, and TradingView integration.

Table of Contents

• @paxeer-network/apex-perpetual-engine-api-typescript
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @paxeer-network/apex-perpetual-engine-api-typescript

PNPM

pnpm add @paxeer-network/apex-perpetual-engine-api-typescript

Bun

bun add @paxeer-network/apex-perpetual-engine-api-typescript

Yarn

yarn add @paxeer-network/apex-perpetual-engine-api-typescript zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";

const apexPerpetualEngineApi = new ApexPerpetualEngineApi();

async function run() {
  const result = await apexPerpetualEngineApi.health.getHealth();

  console.log(result);
}

run();

Available Resources and Operations

futures

• getLatestFutures - Get latest futures snapshots

health

• getHealth - Health check

klines

• getKlines1m - Get 1-minute kline/candlestick data

leaderboard

• getLeaderboard - Get trading leaderboard

marketAnalytics

• getMarketAnalytics - Get market analytics
• getAllMarketsAnalytics - Get all markets analytics
• getTopGainers - Get top gaining markets
• getTopLosers - Get top losing markets
• getHottestMarkets - Get hottest markets

markets

• getMarkets - Get all active perpetual markets

tradingView

• tvTime - TradingView time endpoint
• tvConfig - TradingView configuration
• tvSymbols - TradingView symbol info
• tvSymbolInfo - TradingView symbol info (batch)
• tvSearch - TradingView symbol search
• tvHistory - TradingView historical data

userData

• getUserPositions - Get user open positions
• getUserTradeHistory - Get user trade history
• getUserStats - Get user statistics

webSocketData

• getLatestWsMarkPrices - Get latest mark prices
• getLatestWsIndexPrices - Get latest index prices
• getLatestWsTickers - Get latest tickers
• wsPerp - WebSocket endpoint for real-time data

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• futuresGetLatestFutures - Get latest futures snapshots
• healthGetHealth - Health check
• klinesGetKlines1m - Get 1-minute kline/candlestick data
• leaderboardGetLeaderboard - Get trading leaderboard
• marketAnalyticsGetAllMarketsAnalytics - Get all markets analytics
• marketAnalyticsGetHottestMarkets - Get hottest markets
• marketAnalyticsGetMarketAnalytics - Get market analytics
• marketAnalyticsGetTopGainers - Get top gaining markets
• marketAnalyticsGetTopLosers - Get top losing markets
• marketsGetMarkets - Get all active perpetual markets
• tradingViewTvConfig - TradingView configuration
• tradingViewTvHistory - TradingView historical data
• tradingViewTvSearch - TradingView symbol search
• tradingViewTvSymbolInfo - TradingView symbol info (batch)
• tradingViewTvSymbols - TradingView symbol info
• tradingViewTvTime - TradingView time endpoint
• userDataGetUserPositions - Get user open positions
• userDataGetUserStats - Get user statistics
• userDataGetUserTradeHistory - Get user trade history
• webSocketDataGetLatestWsIndexPrices - Get latest index prices
• webSocketDataGetLatestWsMarkPrices - Get latest mark prices
• webSocketDataGetLatestWsTickers - Get latest tickers
• webSocketDataWsPerp - WebSocket endpoint for real-time data

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";

const apexPerpetualEngineApi = new ApexPerpetualEngineApi();

async function run() {
  const result = await apexPerpetualEngineApi.health.getHealth({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";

const apexPerpetualEngineApi = new ApexPerpetualEngineApi({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await apexPerpetualEngineApi.health.getHealth();

  console.log(result);
}

run();

Error Handling

ApexPerpetualEngineAPIError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";
import * as errors from "@paxeer-network/apex-perpetual-engine-api-typescript/models/errors";

const apexPerpetualEngineApi = new ApexPerpetualEngineApi();

async function run() {
  try {
    const result = await apexPerpetualEngineApi.health.getHealth();

    console.log(result);
  } catch (error) {
    if (error instanceof errors.ApexPerpetualEngineAPIError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• ApexPerpetualEngineAPIError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from ApexPerpetualEngineAPIError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";

const apexPerpetualEngineApi = new ApexPerpetualEngineApi({
  serverURL: "https://liquid-rpc.paxeer.app",
});

async function run() {
  const result = await apexPerpetualEngineApi.health.getHealth();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";
import { HTTPClient } from "@paxeer-network/apex-perpetual-engine-api-typescript/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new ApexPerpetualEngineApi({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { ApexPerpetualEngineApi } from "@paxeer-network/apex-perpetual-engine-api-typescript";

const sdk = new ApexPerpetualEngineApi({ debugLogger: console });

Contract Integration

This SDK includes TypeScript types, ABIs, and configuration for the PerpMarketManager and PerpOracle smart contracts deployed on Paxeer Network.

Contract Addresses (Paxeer Network - Chain ID 229)

| Contract | Address | | -------- | ------- | | PerpMarketManager | 0xE391236993E36473fC8bDeCDE056f5Aec81cbdae | | PerpOracle | 0xCa00cb0cCAE065a32bDA0190F12e030678a0ab02 | | USDC | 0xA1b7b8785317B47d95fFC0Eb4713566A8858b496 | | USDT | 0xb74737f617A7a6aC0699A9c668a23FFFd96f67e4 | | CUSD | 0xA0DB7878d9Dbd0e8fC16f60CCDCCd1C001bf8638 |

Using with viem

import { createPublicClient, createWalletClient, http } from 'viem';
import {
  CONTRACTS,
  CHAIN_ID,
  RPC_ENDPOINTS,
  contracts,
} from '@paxeer-network/apex-perpetual-engine-api-typescript';

// Create a public client for reading contract state
const publicClient = createPublicClient({
  chain: {
    id: CHAIN_ID,
    name: 'Paxeer Network',
    nativeCurrency: { name: 'Paxeer', symbol: 'PAX', decimals: 18 },
    rpcUrls: { default: { http: [RPC_ENDPOINTS.public] } },
  },
  transport: http(),
});

// Read user position
const position = await publicClient.readContract({
  address: CONTRACTS.PerpMarketManager as `0x${string}`,
  abi: contracts.PerpMarketManagerABI,
  functionName: 'getPosition',
  args: [userAddress, perpAddress, CONTRACTS.USDC],
});

// Read mark price from oracle
const markPrice = await publicClient.readContract({
  address: CONTRACTS.PerpOracle as `0x${string}`,
  abi: contracts.PerpOracleABI,
  functionName: 'getMarkPrice',
  args: [perpAddress],
});

Using with ethers.js

import { ethers } from 'ethers';
import {
  CONTRACTS,
  RPC_ENDPOINTS,
  contracts,
} from '@paxeer-network/apex-perpetual-engine-api-typescript';

const provider = new ethers.JsonRpcProvider(RPC_ENDPOINTS.public);

const perpManager = new ethers.Contract(
  CONTRACTS.PerpMarketManager,
  contracts.PerpMarketManagerABI,
  provider
);

// Read user stats
const stats = await perpManager.getUserStats(userAddress);
console.log('Total trades:', stats.totalTrades.toString());
console.log('Total PnL:', ethers.formatEther(stats.totalPnl));

Available Contract Types

import type {
  Position,
  PositionState,
  MarketConfig,
  UserStats,
  GlobalMetrics,
  PerpMarketData,
  OpenPositionParams,
  ClosePositionParams,
} from '@paxeer-network/apex-perpetual-engine-api-typescript';

// Use TradeType enum
import { TradeType } from '@paxeer-network/apex-perpetual-engine-api-typescript';

console.log(TradeType.OPEN);         // 0
console.log(TradeType.ADD);          // 1
console.log(TradeType.PARTIAL_CLOSE); // 2
console.log(TradeType.FULL_CLOSE);   // 3

Utility Functions

import {
  contracts,
} from '@paxeer-network/apex-perpetual-engine-api-typescript';

// Convert BPS to percentage
const leverage = contracts.bpsToPercent(5000n); // 50%

// Convert 1e18 scaled value to decimal
const priceUsd = contracts.fromWei(markPrice); // e.g., 42150.50

// Format price for display
const formatted = contracts.formatPrice(markPrice); // "42150.50"

// Format USD amount
const usdFormatted = contracts.formatUsd(volume); // "$1,234,567.89"

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Scalar