npm package: @paxeer-network/apex-perpetual-engine-api-typescript
Description: Developer-friendly, idiomatic Typescript SDK for the *apex-perpetual-engine-api-typescript* API.
Author: PaxeerNetwork
Latest version: 1.0.0

# apex-perpetual-engine-api-typescript

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

<div align="left">
    <a href="https://www.scalar.com/?utm_source=apex-perpetual-engine-api-typescript&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20scalar+speakeasy-212015?style=for-the-badge&logo=scalar&labelColor=252525" /></a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
    </a>
</div>

<br />

## 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.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [@paxeer-network/apex-perpetual-engine-api-typescript](#paxeer-networkapex-perpetual-engine-api-typescript)
  * [SDK Installation](#sdk-installation)
  * [Requirements](#requirements)
  * [SDK Example Usage](#sdk-example-usage)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Standalone functions](#standalone-functions)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Debugging](#debugging)
* [Development](#development)
  * [Maturity](#maturity)
  * [Contributions](#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.

### NPM

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

### PNPM

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

### Bun

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

### Yarn

```bash
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.
<!-- End SDK Installation [installation] -->

<!-- Start Requirements [requirements] -->
## Requirements

For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
<!-- End Requirements [requirements] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```typescript
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();

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>


### [futures](docs/sdks/futures/README.md)

* [getLatestFutures](docs/sdks/futures/README.md#getlatestfutures) - Get latest futures snapshots

### [health](docs/sdks/health/README.md)

* [getHealth](docs/sdks/health/README.md#gethealth) - Health check

### [klines](docs/sdks/klines/README.md)

* [getKlines1m](docs/sdks/klines/README.md#getklines1m) - Get 1-minute kline/candlestick data

### [leaderboard](docs/sdks/leaderboard/README.md)

* [getLeaderboard](docs/sdks/leaderboard/README.md#getleaderboard) - Get trading leaderboard

### [marketAnalytics](docs/sdks/marketanalytics/README.md)

* [getMarketAnalytics](docs/sdks/marketanalytics/README.md#getmarketanalytics) - Get market analytics
* [getAllMarketsAnalytics](docs/sdks/marketanalytics/README.md#getallmarketsanalytics) - Get all markets analytics
* [getTopGainers](docs/sdks/marketanalytics/README.md#gettopgainers) - Get top gaining markets
* [getTopLosers](docs/sdks/marketanalytics/README.md#gettoplosers) - Get top losing markets
* [getHottestMarkets](docs/sdks/marketanalytics/README.md#gethottestmarkets) - Get hottest markets

### [markets](docs/sdks/markets/README.md)

* [getMarkets](docs/sdks/markets/README.md#getmarkets) - Get all active perpetual markets

### [tradingView](docs/sdks/tradingview/README.md)

* [tvTime](docs/sdks/tradingview/README.md#tvtime) - TradingView time endpoint
* [tvConfig](docs/sdks/tradingview/README.md#tvconfig) - TradingView configuration
* [tvSymbols](docs/sdks/tradingview/README.md#tvsymbols) - TradingView symbol info
* [tvSymbolInfo](docs/sdks/tradingview/README.md#tvsymbolinfo) - TradingView symbol info (batch)
* [tvSearch](docs/sdks/tradingview/README.md#tvsearch) - TradingView symbol search
* [tvHistory](docs/sdks/tradingview/README.md#tvhistory) - TradingView historical data

### [userData](docs/sdks/userdata/README.md)

* [getUserPositions](docs/sdks/userdata/README.md#getuserpositions) - Get user open positions
* [getUserTradeHistory](docs/sdks/userdata/README.md#getusertradehistory) - Get user trade history
* [getUserStats](docs/sdks/userdata/README.md#getuserstats) - Get user statistics

### [webSocketData](docs/sdks/websocketdata/README.md)

* [getLatestWsMarkPrices](docs/sdks/websocketdata/README.md#getlatestwsmarkprices) - Get latest mark prices
* [getLatestWsIndexPrices](docs/sdks/websocketdata/README.md#getlatestwsindexprices) - Get latest index prices
* [getLatestWsTickers](docs/sdks/websocketdata/README.md#getlatestwstickers) - Get latest tickers
* [wsPerp](docs/sdks/websocketdata/README.md#wsperp) - WebSocket endpoint for real-time data

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start Standalone functions [standalone-funcs] -->
## 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](./FUNCTIONS.md).

<details>

<summary>Available standalone functions</summary>

- [`futuresGetLatestFutures`](docs/sdks/futures/README.md#getlatestfutures) - Get latest futures snapshots
- [`healthGetHealth`](docs/sdks/health/README.md#gethealth) - Health check
- [`klinesGetKlines1m`](docs/sdks/klines/README.md#getklines1m) - Get 1-minute kline/candlestick data
- [`leaderboardGetLeaderboard`](docs/sdks/leaderboard/README.md#getleaderboard) - Get trading leaderboard
- [`marketAnalyticsGetAllMarketsAnalytics`](docs/sdks/marketanalytics/README.md#getallmarketsanalytics) - Get all markets analytics
- [`marketAnalyticsGetHottestMarkets`](docs/sdks/marketanalytics/README.md#gethottestmarkets) - Get hottest markets
- [`marketAnalyticsGetMarketAnalytics`](docs/sdks/marketanalytics/README.md#getmarketanalytics) - Get market analytics
- [`marketAnalyticsGetTopGainers`](docs/sdks/marketanalytics/README.md#gettopgainers) - Get top gaining markets
- [`marketAnalyticsGetTopLosers`](docs/sdks/marketanalytics/README.md#gettoplosers) - Get top losing markets
- [`marketsGetMarkets`](docs/sdks/markets/README.md#getmarkets) - Get all active perpetual markets
- [`tradingViewTvConfig`](docs/sdks/tradingview/README.md#tvconfig) - TradingView configuration
- [`tradingViewTvHistory`](docs/sdks/tradingview/README.md#tvhistory) - TradingView historical data
- [`tradingViewTvSearch`](docs/sdks/tradingview/README.md#tvsearch) - TradingView symbol search
- [`tradingViewTvSymbolInfo`](docs/sdks/tradingview/README.md#tvsymbolinfo) - TradingView symbol info (batch)
- [`tradingViewTvSymbols`](docs/sdks/tradingview/README.md#tvsymbols) - TradingView symbol info
- [`tradingViewTvTime`](docs/sdks/tradingview/README.md#tvtime) - TradingView time endpoint
- [`userDataGetUserPositions`](docs/sdks/userdata/README.md#getuserpositions) - Get user open positions
- [`userDataGetUserStats`](docs/sdks/userdata/README.md#getuserstats) - Get user statistics
- [`userDataGetUserTradeHistory`](docs/sdks/userdata/README.md#getusertradehistory) - Get user trade history
- [`webSocketDataGetLatestWsIndexPrices`](docs/sdks/websocketdata/README.md#getlatestwsindexprices) - Get latest index prices
- [`webSocketDataGetLatestWsMarkPrices`](docs/sdks/websocketdata/README.md#getlatestwsmarkprices) - Get latest mark prices
- [`webSocketDataGetLatestWsTickers`](docs/sdks/websocketdata/README.md#getlatestwstickers) - Get latest tickers
- [`webSocketDataWsPerp`](docs/sdks/websocketdata/README.md#wsperp) - WebSocket endpoint for real-time data

</details>
<!-- End Standalone functions [standalone-funcs] -->

<!-- Start Retries [retries] -->
## 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:
```typescript
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:
```typescript
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();

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`ApexPerpetualEngineAPIError`](./src/models/errors/apexperpetualengineapierror.ts) 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
```typescript
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`](./src/models/errors/apexperpetualengineapierror.ts): The base class for HTTP error responses.

<details><summary>Less common errors (6)</summary>

<br />

**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.


**Inherit from [`ApexPerpetualEngineAPIError`](./src/models/errors/apexperpetualengineapierror.ts)**:
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): 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.

</details>
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## 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:
```typescript
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();

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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:

```typescript
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 });
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Debugging [debug] -->
## 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.

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

const sdk = new ApexPerpetualEngineApi({ debugLogger: console });
```
<!-- End Debugging [debug] -->

<!-- Start Contract Integration [contracts] -->
## 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

```typescript
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

```typescript
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

```typescript
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

```typescript
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"
```
<!-- End Contract Integration [contracts] -->

## 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](https://www.scalar.com/?utm_source=apex-perpetual-engine-api-typescript&utm_campaign=typescript)