@nadohq/nuanze-client 0.41.0

package/dist/NuanzeClient.d.cts

@@ -0,0 +1,229 @@
+import { A as GetNuanzePlatformSummaryResponse, B as GetNuanzeWalletTradesResponse, C as GetNuanzeMarketsParams, D as GetNuanzeOpenPositionsParams, E as GetNuanzeNewsResponse, F as GetNuanzeWalletPositionsParams, I as GetNuanzeWalletPositionsResponse, L as GetNuanzeWalletSummaryParams, M as GetNuanzeWalletPnlResponse, N as GetNuanzeWalletPnlSeriesParams, O as GetNuanzeOpenPositionsResponse, P as GetNuanzeWalletPnlSeriesResponse, R as GetNuanzeWalletSummaryResponse, S as GetNuanzeMarketTradesResponse, T as GetNuanzeNewsParams, _ as GetNuanzeMarketPositioningParams, a as GetNuanzeCollateralFlowsParams, b as GetNuanzeMarketPositionsResponse, c as GetNuanzeFollowedLeaderboardResponse, d as GetNuanzeLeaderboardParams, f as GetNuanzeLeaderboardResponse, g as GetNuanzeMarketCandlesResponse, h as GetNuanzeMarketCandlesParams, i as GetNuanzeCollateralFlowSummaryResponse, j as GetNuanzeWalletPnlParams, k as GetNuanzePlatformSummaryParams, l as GetNuanzeFundingRatesParams, m as GetNuanzeMarketByTickerResponse, n as GetNuanzeCollateralFlowSeriesResponse, o as GetNuanzeCollateralFlowsResponse, p as GetNuanzeMarketByTickerParams, r as GetNuanzeCollateralFlowSummaryParams, s as GetNuanzeFollowedLeaderboardParams, t as GetNuanzeCollateralFlowSeriesParams, u as GetNuanzeFundingRatesResponse, v as GetNuanzeMarketPositioningResponse, w as GetNuanzeMarketsResponse, x as GetNuanzeMarketTradesParams, y as GetNuanzeMarketPositionsParams, z as GetNuanzeWalletTradesParams } from "./clientTypes-Du2RLy4W.cjs";
+import { AxiosInstance } from "axios";
+
+//#region src/NuanzeClient.d.ts
+/**
+ * Options for constructing a {@link NuanzeClient}.
+ */
+interface NuanzeClientOpts {
+  /**
+   * Base URL of the Nuanze API, including the version segment, e.g. {@link NUANZE_CLIENT_ENDPOINTS}.
+   */
+  url: string;
+}
+/**
+ * Client for the Nuanze public analytics API: markets, wallets, trades, candles, collateral flows,
+ * and positioning.
+ *
+ * Read-only and credential-free, so unlike the other service clients it takes no wallet client or
+ * linked signer. It also sends no `x-nado-client-type` header: Nuanze is a public API that does not
+ * attribute traffic per client, and its `Access-Control-Allow-Headers` does not list the header, so
+ * sending it would fail CORS preflight in the browser. Most operations are GET;
+ * {@link NuanzeClient.getFollowedLeaderboard} is a non-mutating POST whose body carries a followed
+ * set larger than a query string can reliably hold. The API meters a weighted token bucket per
+ * client IP and reports its state in the `RateLimit-Limit`, `RateLimit-Remaining`, and
+ * `RateLimit-Reset` response headers; add an interceptor on {@link axiosInstance} to observe them.
+ */
+declare class NuanzeClient {
+  readonly opts: NuanzeClientOpts;
+  readonly axiosInstance: AxiosInstance;
+  constructor(opts: NuanzeClientOpts);
+  /**
+   * Lists published editorial stories, sorted by `publishedAt` descending then `id` descending.
+   * The opaque cursor is exclusive and bound to normalized filters. Raw article ingestion, scoring,
+   * queue, and newsdesk fields are excluded.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST`, `INVALID_CURSOR`, or
+   * `CURSOR_FILTER_MISMATCH` when filters or the cursor are invalid.
+   */
+  getNews(params?: GetNuanzeNewsParams): Promise<GetNuanzeNewsResponse>;
+  /**
+   * Gets the active market universe, ordered by `productId` ascending. Never truncated, so `count`
+   * always equals the length of `markets`. Market metadata refreshes about every five minutes and
+   * prices about every minute.
+   *
+   * @throws {NuanzeServerFailureError} With error code `BAD_REQUEST` if a filter value is not a
+   * documented venue or tradability state.
+   */
+  getMarkets(params?: GetNuanzeMarketsParams): Promise<GetNuanzeMarketsResponse>;
+  /**
+   * Resolves a market by ticker. Lookup is case-insensitive and accepts canonical tickers or
+   * legacy source symbols. An explicit unavailable venue returns `MARKET_NOT_FOUND`. With no
+   * venue, `strictVenue=true` returns `AMBIGUOUS_MARKET` for multi-venue assets; otherwise the
+   * primary venue is used.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`, or
+   * `BAD_REQUEST` on invalid selectors, and `MARKET_NOT_FOUND` when the ticker does not resolve.
+   */
+  getMarketByTicker(params: GetNuanzeMarketByTickerParams): Promise<GetNuanzeMarketByTickerResponse>;
+  /**
+   * Lists the latest funding observation per active perpetual market, refreshed about every five
+   * minutes.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if a filter value is invalid.
+   */
+  getFundingRates(params?: GetNuanzeFundingRatesParams): Promise<GetNuanzeFundingRatesResponse>;
+  /**
+   * Gets the account PnL leaderboard. Equity-basis account PnL includes realized and unrealized
+   * movement plus funding and is not realized PnL. All-time analytics cost five rate-limit units.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if a filter value is invalid.
+   */
+  getLeaderboard(params?: GetNuanzeLeaderboardParams): Promise<GetNuanzeLeaderboardResponse>;
+  /**
+   * Gets platform activity summary from five-minute aggregates.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if the window is not a documented value.
+   */
+  getPlatformSummary(params?: GetNuanzePlatformSummaryParams): Promise<GetNuanzePlatformSummaryResponse>;
+  /**
+   * Gets leaderboard stats for a set of followed subaccounts. POST rather than GET so the body can
+   * carry up to 300 `subaccountHex` values. The response preserves request order. Subaccounts with
+   * no data in the window are backfilled with `pnl: null`, `globalRank: null`, zero counts, and an
+   * empty `productIds`. Costs five rate-limit units. The response is not cached.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_SUBACCOUNT` if a hex is not 32-byte
+   * 0x-prefixed, and `BAD_REQUEST` if the set is empty, exceeds 300, or `timeframe` is not a
+   * documented value.
+   */
+  getFollowedLeaderboard(params: GetNuanzeFollowedLeaderboardParams): Promise<GetNuanzeFollowedLeaderboardResponse>;
+  /**
+   * Gets replica-backed wallet analytics. Without `subaccountName`, latest cumulative values are
+   * selected per known subaccount and then summed. The response is a snapshot and does not claim
+   * live health, withdrawable collateral, open-order, or signer state.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletSummary(params: GetNuanzeWalletSummaryParams): Promise<GetNuanzeWalletSummaryResponse>;
+  /**
+   * Lists at most 500 current replica position rows across all known subaccounts by default. Rows
+   * remain per subaccount. Spot rows are excluded unless `includeSpot=true`. This is not an
+   * execution-grade live feed.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletPositions(params: GetNuanzeWalletPositionsParams): Promise<GetNuanzeWalletPositionsResponse>;
+  /**
+   * Lists market trades: one taker-side row per match, sorted by `matchedAt` then `id` descending.
+   * The exclusive cursor is bound to operation and normalized filters. `from` is inclusive and
+   * `to` exclusive. Wallet identity is absent.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`,
+   * `INVALID_CURSOR`, `CURSOR_FILTER_MISMATCH`, `RANGE_TOO_LARGE`, or `BAD_REQUEST` on invalid
+   * input, and `MARKET_NOT_FOUND` when the ticker does not resolve.
+   */
+  getMarketTrades(params: GetNuanzeMarketTradesParams): Promise<GetNuanzeMarketTradesResponse>;
+  /**
+   * Lists market candles. Source storage is 1h; 4h and 1d are UTC-aligned rollups and missing bars
+   * are not interpolated. The newest `limit` matching bars are selected and returned
+   * oldest-to-newest, at most 750, with no pagination. A current bucket has `complete=false`.
+   *
+   * @throws {NuanzeServerFailureError} With `UNSUPPORTED_INTERVAL`, `RANGE_TOO_LARGE`,
+   * `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`, or `BAD_REQUEST` on invalid input, and
+   * `MARKET_NOT_FOUND` when the ticker does not resolve.
+   */
+  getMarketCandles(params: GetNuanzeMarketCandlesParams): Promise<GetNuanzeMarketCandlesResponse>;
+  /**
+   * Lists wallet-owned maker and taker execution rows, sorted by `matchedAt` then `id` descending.
+   * The cursor is exclusive and filter-bound. `from` is inclusive and `to` exclusive.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS`, `INVALID_CURSOR`,
+   * `CURSOR_FILTER_MISMATCH`, `RANGE_TOO_LARGE`, or `BAD_REQUEST` on invalid input, and
+   * `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletTrades(params: GetNuanzeWalletTradesParams): Promise<GetNuanzeWalletTradesResponse>;
+  /**
+   * Gets wallet account PnL. 24h is rolling and uses hourly snapshots with a daily fallback
+   * baseline. Longer windows use daily snapshots; `all` starts at earliest coverage. PnL includes
+   * realized and unrealized movement plus funding.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletPnl(params: GetNuanzeWalletPnlParams): Promise<GetNuanzeWalletPnlResponse>;
+  /**
+   * Gets a wallet account series of at most 1,000 deterministically sampled points ordered by
+   * timestamp. Series contain a boundary anchor and a carried-forward request-time tip; synthetic
+   * points are identified. Latest buckets may be provisional.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletPnlSeries(params: GetNuanzeWalletPnlSeriesParams): Promise<GetNuanzeWalletPnlSeriesResponse>;
+  /**
+   * Lists public collateral events, sorted by timestamp then `id` descending. Repeated `productId`
+   * uses OR semantics. `minUsd` excludes unvalued events; without it unvalued events remain.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST`, `INVALID_CURSOR`, or
+   * `CURSOR_FILTER_MISMATCH` when filters or the cursor are invalid.
+   */
+  getCollateralFlows(params?: GetNuanzeCollateralFlowsParams): Promise<GetNuanzeCollateralFlowsResponse>;
+  /**
+   * Gets collateral flow aggregates: deposited, withdrawn, net, and gross, with valuation coverage
+   * and a prior equal-window comparison. `all` has no prior window.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if a filter value is invalid.
+   */
+  getCollateralFlowSummary(params?: GetNuanzeCollateralFlowSummaryParams): Promise<GetNuanzeCollateralFlowSummaryResponse>;
+  /**
+   * Gets collateral flow series of at most 1,000 UTC buckets. Allowed timeframe/bucket pairs are
+   * 24h/hour, 7d/hour or day (default hour), 30d/day, and all/day.
+   *
+   * @throws {NuanzeServerFailureError} With `UNSUPPORTED_BUCKET` or `BAD_REQUEST` when the pair or
+   * filters are invalid.
+   */
+  getCollateralFlowSeries(params?: GetNuanzeCollateralFlowSeriesParams): Promise<GetNuanzeCollateralFlowSeriesResponse>;
+  /**
+   * Gets privacy-preserving aggregate positioning for an active perpetual. Cross and isolated legs
+   * are summed within owner/subaccount/product before direction classification. Every cell requires
+   * at least 20 distinct contributing owners. No identity, individual position, entry price, PnL,
+   * margin, or leverage fields are returned. This operation costs five rate-limit units.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`, or
+   * `BAD_REQUEST` on invalid input, and `MARKET_NOT_FOUND` when the ticker does not resolve to a
+   * perp.
+   */
+  getMarketPositioning(params: GetNuanzeMarketPositioningParams): Promise<GetNuanzeMarketPositioningResponse>;
+  /**
+   * Lists open perpetual position legs for the resolved market. Results default to absolute
+   * notional descending and can be ordered by signed unrealized PnL or absolute base amount in
+   * either direction. Spot markets are not supported. Legs below $10 absolute notional are excluded.
+   * Wallet addresses and signed exact base amounts are returned.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`,
+   * `INVALID_CURSOR`, `CURSOR_FILTER_MISMATCH`, or `BAD_REQUEST` on invalid input, and
+   * `MARKET_NOT_FOUND` when the ticker does not resolve to a perp.
+   */
+  getMarketPositions(params: GetNuanzeMarketPositionsParams): Promise<GetNuanzeMarketPositionsResponse>;
+  /**
+   * Lists current open perpetual position legs across every market by signed unrealized PnL.
+   * Descending returns the largest gainers and ascending returns the largest losers. This is a
+   * latest indexed snapshot with no timeframe. Legs below $10 absolute notional are excluded.
+   * Each row includes market identity and its source snapshot timestamp. Costs five rate-limit
+   * units.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_CURSOR`, `CURSOR_FILTER_MISMATCH`, or
+   * `BAD_REQUEST` when the query or cursor is invalid.
+   */
+  getOpenPositions(params?: GetNuanzeOpenPositionsParams): Promise<GetNuanzeOpenPositionsResponse>;
+  /**
+   * Performs a GET against `{baseUrl}{path}` and classifies the status before returning the body.
+   */
+  private getJson;
+  /**
+   * Performs a POST against `{baseUrl}{path}` with a JSON body and classifies the status before
+   * returning the response. Used only for the non-mutating followed-leaderboard operation.
+   */
+  private postJson;
+  private requestJson;
+  /**
+   * Validates the HTTP status before interpreting the body. Nuanze maps every domain failure onto a
+   * non-2xx status carrying a failure envelope, so anything else is a transport-level error.
+   */
+  private checkResponseStatus;
+}
+//#endregion
+export { NuanzeClient, NuanzeClientOpts };
+//# sourceMappingURL=NuanzeClient.d.cts.map

package/dist/NuanzeClient.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NuanzeClient.d.cts","names":[],"sources":["../src/src/NuanzeClient.ts"],"mappings":";;;;;;AA6FA;UAAiB,gBAAA;;;AAIZ;EAAH,GAAG;AAAA;;;;;;;;;;;;;;cAgBQ,YAAA;EAAA,SACF,IAAA,EAAM,gBAAA;EAAA,SACN,aAAA,EAAe,aAAA;cAEZ,IAAA,EAAM,gBAAA;EA2FP;;;;;;;;EAtEL,OAAA,CACJ,MAAA,GAAQ,mBAAA,GACP,OAAA,CAAQ,qBAAA;EA4HA;;;;;;;;EA9GL,UAAA,CACJ,MAAA,GAAQ,sBAAA,GACP,OAAA,CAAQ,wBAAA;EA0KA;;;;;;;;;EA3JL,iBAAA,CACJ,MAAA,EAAQ,6BAAA,GACP,OAAA,CAAQ,+BAAA;EAqNR;;;;;;EArMG,eAAA,CACJ,MAAA,GAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EAqPD;;;;;;EAtOJ,cAAA,CACJ,MAAA,GAAQ,0BAAA,GACP,OAAA,CAAQ,4BAAA;EAgRA;;;;;EAlQL,kBAAA,CACJ,MAAA,GAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAsRD;;;;;;;;;;EAnQJ,sBAAA,CACJ,MAAA,EAAQ,kCAAA,GACP,OAAA,CAAQ,oCAAA;EAzGR;;;;;;;;EA0HG,gBAAA,CACJ,MAAA,EAAQ,4BAAA,GACP,OAAA,CAAQ,8BAAA;EA5FT;;;;;;;;EA8GI,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EA7ED;;;;;;;;;EAgGJ,eAAA,CACJ,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EA7DD;;;;;;;;;EAgFJ,gBAAA,CACJ,MAAA,EAAQ,4BAAA,GACP,OAAA,CAAQ,8BAAA;EA3CD;;;;;;;;EA6DJ,eAAA,CACJ,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EAtBL;;;;;;;;EAwCA,YAAA,CACJ,MAAA,EAAQ,wBAAA,GACP,OAAA,CAAQ,0BAAA;EApBA;;;;;;;;EAsCL,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAAR;;;;;;;EAiBG,kBAAA,CACJ,MAAA,GAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAaD;;;;;;EADJ,wBAAA,CACJ,MAAA,GAAQ,oCAAA,GACP,OAAA,CAAQ,sCAAA;EAkBR;;;;;;;EAFG,uBAAA,CACJ,MAAA,GAAQ,mCAAA,GACP,OAAA,CAAQ,qCAAA;EA0CD;;;;;;;;;;EAvBJ,oBAAA,CACJ,MAAA,EAAQ,gCAAA,GACP,OAAA,CAAQ,kCAAA;EAoEG;;;AAkBa;;;;;;;EAlErB,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;;;;;;;;;;;EAoBL,gBAAA,CACJ,MAAA,GAAQ,4BAAA,GACP,OAAA,CAAQ,8BAAA;;;;UAYG,OAAA;;;;;UAQA,QAAA;EAAA,QAIA,WAAA;;;;;UAkBN,mBAAA;AAAA"}

package/dist/NuanzeClient.d.ts

@@ -0,0 +1,229 @@
+import { A as GetNuanzePlatformSummaryResponse, B as GetNuanzeWalletTradesResponse, C as GetNuanzeMarketsParams, D as GetNuanzeOpenPositionsParams, E as GetNuanzeNewsResponse, F as GetNuanzeWalletPositionsParams, I as GetNuanzeWalletPositionsResponse, L as GetNuanzeWalletSummaryParams, M as GetNuanzeWalletPnlResponse, N as GetNuanzeWalletPnlSeriesParams, O as GetNuanzeOpenPositionsResponse, P as GetNuanzeWalletPnlSeriesResponse, R as GetNuanzeWalletSummaryResponse, S as GetNuanzeMarketTradesResponse, T as GetNuanzeNewsParams, _ as GetNuanzeMarketPositioningParams, a as GetNuanzeCollateralFlowsParams, b as GetNuanzeMarketPositionsResponse, c as GetNuanzeFollowedLeaderboardResponse, d as GetNuanzeLeaderboardParams, f as GetNuanzeLeaderboardResponse, g as GetNuanzeMarketCandlesResponse, h as GetNuanzeMarketCandlesParams, i as GetNuanzeCollateralFlowSummaryResponse, j as GetNuanzeWalletPnlParams, k as GetNuanzePlatformSummaryParams, l as GetNuanzeFundingRatesParams, m as GetNuanzeMarketByTickerResponse, n as GetNuanzeCollateralFlowSeriesResponse, o as GetNuanzeCollateralFlowsResponse, p as GetNuanzeMarketByTickerParams, r as GetNuanzeCollateralFlowSummaryParams, s as GetNuanzeFollowedLeaderboardParams, t as GetNuanzeCollateralFlowSeriesParams, u as GetNuanzeFundingRatesResponse, v as GetNuanzeMarketPositioningResponse, w as GetNuanzeMarketsResponse, x as GetNuanzeMarketTradesParams, y as GetNuanzeMarketPositionsParams, z as GetNuanzeWalletTradesParams } from "./clientTypes-DdpinbkS.js";
+import { AxiosInstance } from "axios";
+
+//#region src/NuanzeClient.d.ts
+/**
+ * Options for constructing a {@link NuanzeClient}.
+ */
+interface NuanzeClientOpts {
+  /**
+   * Base URL of the Nuanze API, including the version segment, e.g. {@link NUANZE_CLIENT_ENDPOINTS}.
+   */
+  url: string;
+}
+/**
+ * Client for the Nuanze public analytics API: markets, wallets, trades, candles, collateral flows,
+ * and positioning.
+ *
+ * Read-only and credential-free, so unlike the other service clients it takes no wallet client or
+ * linked signer. It also sends no `x-nado-client-type` header: Nuanze is a public API that does not
+ * attribute traffic per client, and its `Access-Control-Allow-Headers` does not list the header, so
+ * sending it would fail CORS preflight in the browser. Most operations are GET;
+ * {@link NuanzeClient.getFollowedLeaderboard} is a non-mutating POST whose body carries a followed
+ * set larger than a query string can reliably hold. The API meters a weighted token bucket per
+ * client IP and reports its state in the `RateLimit-Limit`, `RateLimit-Remaining`, and
+ * `RateLimit-Reset` response headers; add an interceptor on {@link axiosInstance} to observe them.
+ */
+declare class NuanzeClient {
+  readonly opts: NuanzeClientOpts;
+  readonly axiosInstance: AxiosInstance;
+  constructor(opts: NuanzeClientOpts);
+  /**
+   * Lists published editorial stories, sorted by `publishedAt` descending then `id` descending.
+   * The opaque cursor is exclusive and bound to normalized filters. Raw article ingestion, scoring,
+   * queue, and newsdesk fields are excluded.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST`, `INVALID_CURSOR`, or
+   * `CURSOR_FILTER_MISMATCH` when filters or the cursor are invalid.
+   */
+  getNews(params?: GetNuanzeNewsParams): Promise<GetNuanzeNewsResponse>;
+  /**
+   * Gets the active market universe, ordered by `productId` ascending. Never truncated, so `count`
+   * always equals the length of `markets`. Market metadata refreshes about every five minutes and
+   * prices about every minute.
+   *
+   * @throws {NuanzeServerFailureError} With error code `BAD_REQUEST` if a filter value is not a
+   * documented venue or tradability state.
+   */
+  getMarkets(params?: GetNuanzeMarketsParams): Promise<GetNuanzeMarketsResponse>;
+  /**
+   * Resolves a market by ticker. Lookup is case-insensitive and accepts canonical tickers or
+   * legacy source symbols. An explicit unavailable venue returns `MARKET_NOT_FOUND`. With no
+   * venue, `strictVenue=true` returns `AMBIGUOUS_MARKET` for multi-venue assets; otherwise the
+   * primary venue is used.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`, or
+   * `BAD_REQUEST` on invalid selectors, and `MARKET_NOT_FOUND` when the ticker does not resolve.
+   */
+  getMarketByTicker(params: GetNuanzeMarketByTickerParams): Promise<GetNuanzeMarketByTickerResponse>;
+  /**
+   * Lists the latest funding observation per active perpetual market, refreshed about every five
+   * minutes.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if a filter value is invalid.
+   */
+  getFundingRates(params?: GetNuanzeFundingRatesParams): Promise<GetNuanzeFundingRatesResponse>;
+  /**
+   * Gets the account PnL leaderboard. Equity-basis account PnL includes realized and unrealized
+   * movement plus funding and is not realized PnL. All-time analytics cost five rate-limit units.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if a filter value is invalid.
+   */
+  getLeaderboard(params?: GetNuanzeLeaderboardParams): Promise<GetNuanzeLeaderboardResponse>;
+  /**
+   * Gets platform activity summary from five-minute aggregates.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if the window is not a documented value.
+   */
+  getPlatformSummary(params?: GetNuanzePlatformSummaryParams): Promise<GetNuanzePlatformSummaryResponse>;
+  /**
+   * Gets leaderboard stats for a set of followed subaccounts. POST rather than GET so the body can
+   * carry up to 300 `subaccountHex` values. The response preserves request order. Subaccounts with
+   * no data in the window are backfilled with `pnl: null`, `globalRank: null`, zero counts, and an
+   * empty `productIds`. Costs five rate-limit units. The response is not cached.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_SUBACCOUNT` if a hex is not 32-byte
+   * 0x-prefixed, and `BAD_REQUEST` if the set is empty, exceeds 300, or `timeframe` is not a
+   * documented value.
+   */
+  getFollowedLeaderboard(params: GetNuanzeFollowedLeaderboardParams): Promise<GetNuanzeFollowedLeaderboardResponse>;
+  /**
+   * Gets replica-backed wallet analytics. Without `subaccountName`, latest cumulative values are
+   * selected per known subaccount and then summed. The response is a snapshot and does not claim
+   * live health, withdrawable collateral, open-order, or signer state.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletSummary(params: GetNuanzeWalletSummaryParams): Promise<GetNuanzeWalletSummaryResponse>;
+  /**
+   * Lists at most 500 current replica position rows across all known subaccounts by default. Rows
+   * remain per subaccount. Spot rows are excluded unless `includeSpot=true`. This is not an
+   * execution-grade live feed.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletPositions(params: GetNuanzeWalletPositionsParams): Promise<GetNuanzeWalletPositionsResponse>;
+  /**
+   * Lists market trades: one taker-side row per match, sorted by `matchedAt` then `id` descending.
+   * The exclusive cursor is bound to operation and normalized filters. `from` is inclusive and
+   * `to` exclusive. Wallet identity is absent.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`,
+   * `INVALID_CURSOR`, `CURSOR_FILTER_MISMATCH`, `RANGE_TOO_LARGE`, or `BAD_REQUEST` on invalid
+   * input, and `MARKET_NOT_FOUND` when the ticker does not resolve.
+   */
+  getMarketTrades(params: GetNuanzeMarketTradesParams): Promise<GetNuanzeMarketTradesResponse>;
+  /**
+   * Lists market candles. Source storage is 1h; 4h and 1d are UTC-aligned rollups and missing bars
+   * are not interpolated. The newest `limit` matching bars are selected and returned
+   * oldest-to-newest, at most 750, with no pagination. A current bucket has `complete=false`.
+   *
+   * @throws {NuanzeServerFailureError} With `UNSUPPORTED_INTERVAL`, `RANGE_TOO_LARGE`,
+   * `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`, or `BAD_REQUEST` on invalid input, and
+   * `MARKET_NOT_FOUND` when the ticker does not resolve.
+   */
+  getMarketCandles(params: GetNuanzeMarketCandlesParams): Promise<GetNuanzeMarketCandlesResponse>;
+  /**
+   * Lists wallet-owned maker and taker execution rows, sorted by `matchedAt` then `id` descending.
+   * The cursor is exclusive and filter-bound. `from` is inclusive and `to` exclusive.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS`, `INVALID_CURSOR`,
+   * `CURSOR_FILTER_MISMATCH`, `RANGE_TOO_LARGE`, or `BAD_REQUEST` on invalid input, and
+   * `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletTrades(params: GetNuanzeWalletTradesParams): Promise<GetNuanzeWalletTradesResponse>;
+  /**
+   * Gets wallet account PnL. 24h is rolling and uses hourly snapshots with a daily fallback
+   * baseline. Longer windows use daily snapshots; `all` starts at earliest coverage. PnL includes
+   * realized and unrealized movement plus funding.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletPnl(params: GetNuanzeWalletPnlParams): Promise<GetNuanzeWalletPnlResponse>;
+  /**
+   * Gets a wallet account series of at most 1,000 deterministically sampled points ordered by
+   * timestamp. Series contain a boundary anchor and a carried-forward request-time tip; synthetic
+   * points are identified. Latest buckets may be provisional.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_ADDRESS` or `BAD_REQUEST` on invalid input,
+   * and `WALLET_NOT_FOUND` when the address has no wallet data.
+   */
+  getWalletPnlSeries(params: GetNuanzeWalletPnlSeriesParams): Promise<GetNuanzeWalletPnlSeriesResponse>;
+  /**
+   * Lists public collateral events, sorted by timestamp then `id` descending. Repeated `productId`
+   * uses OR semantics. `minUsd` excludes unvalued events; without it unvalued events remain.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST`, `INVALID_CURSOR`, or
+   * `CURSOR_FILTER_MISMATCH` when filters or the cursor are invalid.
+   */
+  getCollateralFlows(params?: GetNuanzeCollateralFlowsParams): Promise<GetNuanzeCollateralFlowsResponse>;
+  /**
+   * Gets collateral flow aggregates: deposited, withdrawn, net, and gross, with valuation coverage
+   * and a prior equal-window comparison. `all` has no prior window.
+   *
+   * @throws {NuanzeServerFailureError} With `BAD_REQUEST` if a filter value is invalid.
+   */
+  getCollateralFlowSummary(params?: GetNuanzeCollateralFlowSummaryParams): Promise<GetNuanzeCollateralFlowSummaryResponse>;
+  /**
+   * Gets collateral flow series of at most 1,000 UTC buckets. Allowed timeframe/bucket pairs are
+   * 24h/hour, 7d/hour or day (default hour), 30d/day, and all/day.
+   *
+   * @throws {NuanzeServerFailureError} With `UNSUPPORTED_BUCKET` or `BAD_REQUEST` when the pair or
+   * filters are invalid.
+   */
+  getCollateralFlowSeries(params?: GetNuanzeCollateralFlowSeriesParams): Promise<GetNuanzeCollateralFlowSeriesResponse>;
+  /**
+   * Gets privacy-preserving aggregate positioning for an active perpetual. Cross and isolated legs
+   * are summed within owner/subaccount/product before direction classification. Every cell requires
+   * at least 20 distinct contributing owners. No identity, individual position, entry price, PnL,
+   * margin, or leverage fields are returned. This operation costs five rate-limit units.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`, or
+   * `BAD_REQUEST` on invalid input, and `MARKET_NOT_FOUND` when the ticker does not resolve to a
+   * perp.
+   */
+  getMarketPositioning(params: GetNuanzeMarketPositioningParams): Promise<GetNuanzeMarketPositioningResponse>;
+  /**
+   * Lists open perpetual position legs for the resolved market. Results default to absolute
+   * notional descending and can be ordered by signed unrealized PnL or absolute base amount in
+   * either direction. Spot markets are not supported. Legs below $10 absolute notional are excluded.
+   * Wallet addresses and signed exact base amounts are returned.
+   *
+   * @throws {NuanzeServerFailureError} With `AMBIGUOUS_MARKET`, `MARKET_SELECTOR_MISMATCH`,
+   * `INVALID_CURSOR`, `CURSOR_FILTER_MISMATCH`, or `BAD_REQUEST` on invalid input, and
+   * `MARKET_NOT_FOUND` when the ticker does not resolve to a perp.
+   */
+  getMarketPositions(params: GetNuanzeMarketPositionsParams): Promise<GetNuanzeMarketPositionsResponse>;
+  /**
+   * Lists current open perpetual position legs across every market by signed unrealized PnL.
+   * Descending returns the largest gainers and ascending returns the largest losers. This is a
+   * latest indexed snapshot with no timeframe. Legs below $10 absolute notional are excluded.
+   * Each row includes market identity and its source snapshot timestamp. Costs five rate-limit
+   * units.
+   *
+   * @throws {NuanzeServerFailureError} With `INVALID_CURSOR`, `CURSOR_FILTER_MISMATCH`, or
+   * `BAD_REQUEST` when the query or cursor is invalid.
+   */
+  getOpenPositions(params?: GetNuanzeOpenPositionsParams): Promise<GetNuanzeOpenPositionsResponse>;
+  /**
+   * Performs a GET against `{baseUrl}{path}` and classifies the status before returning the body.
+   */
+  private getJson;
+  /**
+   * Performs a POST against `{baseUrl}{path}` with a JSON body and classifies the status before
+   * returning the response. Used only for the non-mutating followed-leaderboard operation.
+   */
+  private postJson;
+  private requestJson;
+  /**
+   * Validates the HTTP status before interpreting the body. Nuanze maps every domain failure onto a
+   * non-2xx status carrying a failure envelope, so anything else is a transport-level error.
+   */
+  private checkResponseStatus;
+}
+//#endregion
+export { NuanzeClient, NuanzeClientOpts };
+//# sourceMappingURL=NuanzeClient.d.ts.map

package/dist/NuanzeClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NuanzeClient.d.ts","names":[],"sources":["../src/src/NuanzeClient.ts"],"mappings":";;;;;;AA6FA;UAAiB,gBAAA;;;AAIZ;EAAH,GAAG;AAAA;;;;;;;;;;;;;;cAgBQ,YAAA;EAAA,SACF,IAAA,EAAM,gBAAA;EAAA,SACN,aAAA,EAAe,aAAA;cAEZ,IAAA,EAAM,gBAAA;EA2FP;;;;;;;;EAtEL,OAAA,CACJ,MAAA,GAAQ,mBAAA,GACP,OAAA,CAAQ,qBAAA;EA4HA;;;;;;;;EA9GL,UAAA,CACJ,MAAA,GAAQ,sBAAA,GACP,OAAA,CAAQ,wBAAA;EA0KA;;;;;;;;;EA3JL,iBAAA,CACJ,MAAA,EAAQ,6BAAA,GACP,OAAA,CAAQ,+BAAA;EAqNR;;;;;;EArMG,eAAA,CACJ,MAAA,GAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EAqPD;;;;;;EAtOJ,cAAA,CACJ,MAAA,GAAQ,0BAAA,GACP,OAAA,CAAQ,4BAAA;EAgRA;;;;;EAlQL,kBAAA,CACJ,MAAA,GAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAsRD;;;;;;;;;;EAnQJ,sBAAA,CACJ,MAAA,EAAQ,kCAAA,GACP,OAAA,CAAQ,oCAAA;EAzGR;;;;;;;;EA0HG,gBAAA,CACJ,MAAA,EAAQ,4BAAA,GACP,OAAA,CAAQ,8BAAA;EA5FT;;;;;;;;EA8GI,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EA7ED;;;;;;;;;EAgGJ,eAAA,CACJ,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EA7DD;;;;;;;;;EAgFJ,gBAAA,CACJ,MAAA,EAAQ,4BAAA,GACP,OAAA,CAAQ,8BAAA;EA3CD;;;;;;;;EA6DJ,eAAA,CACJ,MAAA,EAAQ,2BAAA,GACP,OAAA,CAAQ,6BAAA;EAtBL;;;;;;;;EAwCA,YAAA,CACJ,MAAA,EAAQ,wBAAA,GACP,OAAA,CAAQ,0BAAA;EApBA;;;;;;;;EAsCL,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAAR;;;;;;;EAiBG,kBAAA,CACJ,MAAA,GAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;EAaD;;;;;;EADJ,wBAAA,CACJ,MAAA,GAAQ,oCAAA,GACP,OAAA,CAAQ,sCAAA;EAkBR;;;;;;;EAFG,uBAAA,CACJ,MAAA,GAAQ,mCAAA,GACP,OAAA,CAAQ,qCAAA;EA0CD;;;;;;;;;;EAvBJ,oBAAA,CACJ,MAAA,EAAQ,gCAAA,GACP,OAAA,CAAQ,kCAAA;EAoEG;;;AAkBa;;;;;;;EAlErB,kBAAA,CACJ,MAAA,EAAQ,8BAAA,GACP,OAAA,CAAQ,gCAAA;;;;;;;;;;;EAoBL,gBAAA,CACJ,MAAA,GAAQ,4BAAA,GACP,OAAA,CAAQ,8BAAA;;;;UAYG,OAAA;;;;;UAQA,QAAA;EAAA,QAIA,WAAA;;;;;UAkBN,mBAAA;AAAA"}