npm package: @paxeer-network/apex-perpetual-engine-sdk
Description: Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@paxeer-network/apex-perpetual-engine-sdk* API.
Author: Speakeasy
Latest version: 2.0.0

# @paxeer-network/apex-perpetual-engine-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@paxeer-network/apex-perpetual-engine-sdk* API.

[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)




<!-- Start Summary [summary] -->
## Summary

Apex Perpetual Engine API: API for the Apex Perpetual Engine, a perpetual futures trading data engine.
Provides market data, futures snapshots, klines, and WebSocket streaming capabilities.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [@paxeer-network/apex-perpetual-engine-sdk](#paxeer-networkapex-perpetual-engine-sdk)
  * [SDK Installation](#sdk-installation)
  * [Requirements](#requirements)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [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

> [!TIP]
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).


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

### PNPM

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

### Bun

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

### Yarn

```bash
yarn add @paxeer-network/apex-perpetual-engine-sdk
```

> [!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 { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await apexPerpetualEngineSDK.system.getHealth();

  console.log(result);
}

run();

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

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name         | Type | Scheme      | Environment Variable                 |
| ------------ | ---- | ----------- | ------------------------------------ |
| `bearerAuth` | http | HTTP Bearer | `APEXPERPETUALENGINESDK_BEARER_AUTH` |

To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await apexPerpetualEngineSDK.system.getHealth();

  console.log(result);
}

run();

```
<!-- End Authentication [security] -->

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

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

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

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

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

* [get](docs/sdks/klines/README.md#get) - Get kline/candlestick data

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

* [get](docs/sdks/markets/README.md#get) - Get available markets

### [System](docs/sdks/system/README.md)

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

### [TradingViewProxy](docs/sdks/tradingviewproxy/README.md)

* [getTime](docs/sdks/tradingviewproxy/README.md#gettime) - TradingView time proxy
* [getConfig](docs/sdks/tradingviewproxy/README.md#getconfig) - TradingView config proxy
* [getSymbols](docs/sdks/tradingviewproxy/README.md#getsymbols) - TradingView symbols proxy
* [search](docs/sdks/tradingviewproxy/README.md#search) - TradingView search proxy
* [getSymbolInfo](docs/sdks/tradingviewproxy/README.md#getsymbolinfo) - TradingView symbol info proxy
* [getHistory](docs/sdks/tradingviewproxy/README.md#gethistory) - TradingView history proxy

### [WebSocket](docs/sdks/websocket/README.md)

* [getConnection](docs/sdks/websocket/README.md#getconnection) - WebSocket endpoint for real-time data

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

* [getLatestMarkPrices](docs/sdks/websocketdata/README.md#getlatestmarkprices) - Get latest WebSocket mark prices
* [getLatestIndexPrices](docs/sdks/websocketdata/README.md#getlatestindexprices) - Get latest WebSocket index prices
* [getLatestTickers](docs/sdks/websocketdata/README.md#getlatesttickers) - Get latest WebSocket tickers

</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>

- [`futuresGetLatest`](docs/sdks/futures/README.md#getlatest) - Get latest futures snapshots
- [`klinesGet`](docs/sdks/klines/README.md#get) - Get kline/candlestick data
- [`marketsGet`](docs/sdks/markets/README.md#get) - Get available markets
- [`systemGetHealth`](docs/sdks/system/README.md#gethealth) - Health check endpoint
- [`tradingViewProxyGetConfig`](docs/sdks/tradingviewproxy/README.md#getconfig) - TradingView config proxy
- [`tradingViewProxyGetHistory`](docs/sdks/tradingviewproxy/README.md#gethistory) - TradingView history proxy
- [`tradingViewProxyGetSymbolInfo`](docs/sdks/tradingviewproxy/README.md#getsymbolinfo) - TradingView symbol info proxy
- [`tradingViewProxyGetSymbols`](docs/sdks/tradingviewproxy/README.md#getsymbols) - TradingView symbols proxy
- [`tradingViewProxyGetTime`](docs/sdks/tradingviewproxy/README.md#gettime) - TradingView time proxy
- [`tradingViewProxySearch`](docs/sdks/tradingviewproxy/README.md#search) - TradingView search proxy
- [`webSocketDataGetLatestIndexPrices`](docs/sdks/websocketdata/README.md#getlatestindexprices) - Get latest WebSocket index prices
- [`webSocketDataGetLatestMarkPrices`](docs/sdks/websocketdata/README.md#getlatestmarkprices) - Get latest WebSocket mark prices
- [`webSocketDataGetLatestTickers`](docs/sdks/websocketdata/README.md#getlatesttickers) - Get latest WebSocket tickers
- [`webSocketGetConnection`](docs/sdks/websocket/README.md#getconnection) - 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 { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await apexPerpetualEngineSDK.system.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 { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await apexPerpetualEngineSDK.system.getHealth();

  console.log(result);
}

run();

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

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

[`ApexPerpetualEngineSDKError`](./src/models/errors/apexperpetualenginesdkerror.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                                                                       |
| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |

### Example
```typescript
import { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";
import * as errors from "@paxeer-network/apex-perpetual-engine-sdk/models/errors";

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await apexPerpetualEngineSDK.system.getHealth();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ApexPerpetualEngineSDKError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // string
        console.log(error.data$.message); // string
        console.log(error.data$.timestamp); // Date
      }
    }
  }
}

run();

```

### Error Classes
**Primary errors:**
* [`ApexPerpetualEngineSDKError`](./src/models/errors/apexperpetualenginesdkerror.ts): The base class for HTTP error responses.
  * [`ErrorT`](./src/models/errors/errort.ts): *

<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 [`ApexPerpetualEngineSDKError`](./src/models/errors/apexperpetualenginesdkerror.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>

\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| #   | Server                          | Description        |
| --- | ------------------------------- | ------------------ |
| 0   | `http://localhost:8080`         | Development server |
| 1   | `https://liquid-rpc.paxeer.app` | Production server  |

#### Example

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

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  serverIdx: 0,
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await apexPerpetualEngineSDK.system.getHealth();

  console.log(result);
}

run();

```

### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript
import { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";

const apexPerpetualEngineSDK = new ApexPerpetualEngineSDK({
  serverURL: "https://liquid-rpc.paxeer.app",
  bearerAuth: process.env["APEXPERPETUALENGINESDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await apexPerpetualEngineSDK.system.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 { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";
import { HTTPClient } from "@paxeer-network/apex-perpetual-engine-sdk/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 ApexPerpetualEngineSDK({ httpClient: 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 { ApexPerpetualEngineSDK } from "@paxeer-network/apex-perpetual-engine-sdk";

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

You can also enable a default debug logger by setting an environment variable `APEXPERPETUALENGINESDK_DEBUG` to true.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# Development

## Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.