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

# forex-engine-sdk-typescript

Developer-friendly, idiomatic Typescript SDK for the *forex-engine-sdk-typescript* API.

<div align="left">
    <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

Fx Oracle Service API: HTTP API for prices, enriched market data, positions, orders, collateral, stats, and websocket streaming used by FxOracleClient.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [@paxeer-network/forex-engine-sdk-typescript](#paxeer-networkforex-engine-sdk-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/forex-engine-sdk-typescript
```

### PNPM

```bash
pnpm add @paxeer-network/forex-engine-sdk-typescript
```

### Bun

```bash
bun add @paxeer-network/forex-engine-sdk-typescript
```

### Yarn

```bash
yarn add @paxeer-network/forex-engine-sdk-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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

const fxOracleServiceApi = new FxOracleServiceApi();

async function run() {
  const result = await fxOracleServiceApi.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>

### [FxOracleServiceApi SDK](docs/sdks/fxoracleserviceapi/README.md)

* [getHealth](docs/sdks/fxoracleserviceapi/README.md#gethealth) - Service health
* [getPrices](docs/sdks/fxoracleserviceapi/README.md#getprices) - All current prices
* [getPricesSymbol](docs/sdks/fxoracleserviceapi/README.md#getpricessymbol) - Price for a symbol
* [getEnriched](docs/sdks/fxoracleserviceapi/README.md#getenriched) - Prices with enriched market data
* [getEnrichedSymbol](docs/sdks/fxoracleserviceapi/README.md#getenrichedsymbol) - Enriched data for a symbol
* [getMarketDataSymbol](docs/sdks/fxoracleserviceapi/README.md#getmarketdatasymbol) - Real-time market data for a symbol
* [postMarketDataBatch](docs/sdks/fxoracleserviceapi/README.md#postmarketdatabatch) - Batch market data
* [getApiPositionsOpen](docs/sdks/fxoracleserviceapi/README.md#getapipositionsopen) - Open positions
* [getApiPositionsAccountAddress](docs/sdks/fxoracleserviceapi/README.md#getapipositionsaccountaddress) - Positions by account
* [getApiPositionsMarketMarketId](docs/sdks/fxoracleserviceapi/README.md#getapipositionsmarketmarketid) - Positions by market
* [getApiOrdersRecent](docs/sdks/fxoracleserviceapi/README.md#getapiordersrecent) - Recent orders
* [getApiOrdersAccountAddress](docs/sdks/fxoracleserviceapi/README.md#getapiordersaccountaddress) - Orders by account
* [getApiCollateralAccountAddress](docs/sdks/fxoracleserviceapi/README.md#getapicollateralaccountaddress) - Collateral events for account
* [getApiStatsAccountAddress](docs/sdks/fxoracleserviceapi/README.md#getapistatsaccountaddress) - Account statistics
* [getApiLeaderboard](docs/sdks/fxoracleserviceapi/README.md#getapileaderboard) - Trader leaderboard
* [getApiStatsMarkets](docs/sdks/fxoracleserviceapi/README.md#getapistatsmarkets) - Market stats
* [getApiStatsSystem](docs/sdks/fxoracleserviceapi/README.md#getapistatssystem) - System metrics
* [getApiStatsSummary](docs/sdks/fxoracleserviceapi/README.md#getapistatssummary) - Dashboard summary
* [getWs](docs/sdks/fxoracleserviceapi/README.md#getws) - WebSocket upgrade for real-time price and enriched 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>

- [`getApiCollateralAccountAddress`](docs/sdks/fxoracleserviceapi/README.md#getapicollateralaccountaddress) - Collateral events for account
- [`getApiLeaderboard`](docs/sdks/fxoracleserviceapi/README.md#getapileaderboard) - Trader leaderboard
- [`getApiOrdersAccountAddress`](docs/sdks/fxoracleserviceapi/README.md#getapiordersaccountaddress) - Orders by account
- [`getApiOrdersRecent`](docs/sdks/fxoracleserviceapi/README.md#getapiordersrecent) - Recent orders
- [`getApiPositionsAccountAddress`](docs/sdks/fxoracleserviceapi/README.md#getapipositionsaccountaddress) - Positions by account
- [`getApiPositionsMarketMarketId`](docs/sdks/fxoracleserviceapi/README.md#getapipositionsmarketmarketid) - Positions by market
- [`getApiPositionsOpen`](docs/sdks/fxoracleserviceapi/README.md#getapipositionsopen) - Open positions
- [`getApiStatsAccountAddress`](docs/sdks/fxoracleserviceapi/README.md#getapistatsaccountaddress) - Account statistics
- [`getApiStatsMarkets`](docs/sdks/fxoracleserviceapi/README.md#getapistatsmarkets) - Market stats
- [`getApiStatsSummary`](docs/sdks/fxoracleserviceapi/README.md#getapistatssummary) - Dashboard summary
- [`getApiStatsSystem`](docs/sdks/fxoracleserviceapi/README.md#getapistatssystem) - System metrics
- [`getEnriched`](docs/sdks/fxoracleserviceapi/README.md#getenriched) - Prices with enriched market data
- [`getEnrichedSymbol`](docs/sdks/fxoracleserviceapi/README.md#getenrichedsymbol) - Enriched data for a symbol
- [`getHealth`](docs/sdks/fxoracleserviceapi/README.md#gethealth) - Service health
- [`getMarketDataSymbol`](docs/sdks/fxoracleserviceapi/README.md#getmarketdatasymbol) - Real-time market data for a symbol
- [`getPrices`](docs/sdks/fxoracleserviceapi/README.md#getprices) - All current prices
- [`getPricesSymbol`](docs/sdks/fxoracleserviceapi/README.md#getpricessymbol) - Price for a symbol
- [`getWs`](docs/sdks/fxoracleserviceapi/README.md#getws) - WebSocket upgrade for real-time price and enriched data
- [`postMarketDataBatch`](docs/sdks/fxoracleserviceapi/README.md#postmarketdatabatch) - Batch market 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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

const fxOracleServiceApi = new FxOracleServiceApi();

async function run() {
  const result = await fxOracleServiceApi.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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

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

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

  console.log(result);
}

run();

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

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

[`FxOracleServiceAPIError`](./src/models/errors/fxoracleserviceapierror.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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";
import * as errors from "@paxeer-network/forex-engine-sdk-typescript/models/errors";

const fxOracleServiceApi = new FxOracleServiceApi();

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

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

run();

```

### Error Classes
**Primary error:**
* [`FxOracleServiceAPIError`](./src/models/errors/fxoracleserviceapierror.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 [`FxOracleServiceAPIError`](./src/models/errors/fxoracleserviceapierror.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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

const fxOracleServiceApi = new FxOracleServiceApi({
  serverURL: "https://api.fx-oracle.example",
});

async function run() {
  const result = await fxOracleServiceApi.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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";
import { HTTPClient } from "@paxeer-network/forex-engine-sdk-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 FxOracleServiceApi({ 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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

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