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

v2.0.0

Published

13 days ago

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

0High
0Medium
0Low

paxeer-dev

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

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

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.

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

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

NPM

npm add @paxeer-network/apex-perpetual-engine-sdk

PNPM

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

Bun

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

Yarn

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

[!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 { 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();

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:

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

Available Resources and Operations

Futures

getLatest - Get latest futures snapshots

Klines

get - Get kline/candlestick data

Markets

get - Get available markets

System

getHealth - Health check endpoint

TradingViewProxy

getTime - TradingView time proxy
getConfig - TradingView config proxy
getSymbols - TradingView symbols proxy
search - TradingView search proxy
getSymbolInfo - TradingView symbol info proxy
getHistory - TradingView history proxy

WebSocket

getConnection - WebSocket endpoint for real-time data

WebSocketData

getLatestMarkPrices - Get latest WebSocket mark prices
getLatestIndexPrices - Get latest WebSocket index prices
getLatestTickers - Get latest WebSocket tickers

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.

futuresGetLatest - Get latest futures snapshots
klinesGet - Get kline/candlestick data
marketsGet - Get available markets
systemGetHealth - Health check endpoint
tradingViewProxyGetConfig - TradingView config proxy
tradingViewProxyGetHistory - TradingView history proxy
tradingViewProxyGetSymbolInfo - TradingView symbol info proxy
tradingViewProxyGetSymbols - TradingView symbols proxy
tradingViewProxyGetTime - TradingView time proxy
tradingViewProxySearch - TradingView search proxy
webSocketDataGetLatestIndexPrices - Get latest WebSocket index prices
webSocketDataGetLatestMarkPrices - Get latest WebSocket mark prices
webSocketDataGetLatestTickers - Get latest WebSocket tickers
webSocketGetConnection - 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 { 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:

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

Error Handling

ApexPerpetualEngineSDKError 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. |

Example

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: The base class for HTTP error responses.
- ErrorT: *

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 ApexPerpetualEngineSDKError:

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.

* Check the method documentation to see if the error is applicable.

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

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:

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

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 { 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 });

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 { 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.

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.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

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

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Futures

Klines

Markets

System

TradingViewProxy

WebSocket

WebSocketData

Standalone functions

Retries

Error Handling

Example

Error Classes

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity