@liq/api-client

Typed REST + SSE client for the Liq order-gateway API.

Overview

@liq/api-client provides a typed HTTP client for interacting with the order-gateway service. It wraps up-fetch with automatic JWT bearer token management, response envelope unwrapping ({ data: T } → T), and structured error handling via LiqApiError. Responses are typed but not validated at runtime (one client build reads several gateway versions), so a payload that drifted from the declared type reaches the caller as is. The top-level LiqClient exposes namespaced service objects for auth, orders, markets, positions, accounts, and SSE streaming.

Key Exports

LiqClient

Main entry point. Constructed with { baseUrl, chainId? }.

const client = new LiqClient({ baseUrl: 'http://localhost:4000/v1' });
client.setToken(jwt); // set or clear auth token

Other exports

• AuthService, AuthTokens — standalone auth service + token type
• OrdersService — order CRUD
• MarketsService — market list
• PositionsService, GatewayPosition (what list / getOne return: signed size, side derived from it, realizedPnl, and episodeRealizedPnl / episodeFeesUsd — the current position's price PnL and fees, null when unknown), PositionResponse (the raw wire row) — positions
• AccountsRestService, RegisterAccountParams, RegisterAccountResponse — account management
• SSEService, SSEEventHandler — SSE subscription helpers
• LiqApiError — typed API error (status code + error code + body)

Install

pnpm add @liq/api-client

Dependencies

• @liq/core — shared types and enums
• up-fetch — lightweight fetch wrapper with base URL + interceptors

Build

moon run liq-api-client:build    # tsup → dist/