@0xmonaco/types 1.0.73 → 1.0.74-develop.367860f

package/dist/margin-accounts/index.d.ts

@@ -9,7 +9,17 @@ export interface MarginAccountSummary {
     selectedTradingPairIds?: string[];
     tradingPairId?: string;
     strategyKey?: string;
-    accountState: string;
+    /**
+     * The risk bucket's lifecycle state: `NORMAL`, `PENDING_LIQUIDATION`,
+     * `LIQUIDATING`, `BAD_DEBT` or `CLOSED`. Present only on risk-bucket rows —
+     * a parent margin account has no lifecycle of its own; liquidation and bad
+     * debt live in its risk buckets.
+     */
+    riskBucketState?: string;
+    /** The margin account's sub-account key; `default` is the default margin account. */
+    subaccountKey?: string;
+    /** The margin account's state: `ACTIVE`, or `CLOSED` for a closed sub-account. */
+    marginAccountState?: string;
     equity: string;
     initialMarginRequired: string;
     maintenanceMarginRequired: string;
@@ -19,13 +29,21 @@ export interface MarginAccountSummary {
      * The largest amount a transfer-out of this scope will actually accept.
      *
      * Not a clamped `freeCollateral`. Free collateral is equity headroom, and
-     * equity includes realized PnL, accrued funding and mark-to-market gains
-     * that are not principal a transfer can move — so the two can differ
-     * without limit. An unrealized gain never counts toward this figure.
+     * equity includes mark-to-market gains that a transfer cannot move — so the
+     * two can differ without limit. An unrealized gain never counts toward this
+     * figure.
      *
-     * For a risk bucket this is capped by the bucket's allocated collateral;
-     * for a parent margin account, by deposited collateral that no risk bucket
-     * has earmarked. Size transfers against this field, not `freeCollateral`.
+     * For a risk bucket this is the bucket's allocated collateral plus its
+     * realized PnL, less what its positions and resting orders require (the
+     * bucket's allocation may go negative, which is how realized profit leaves
+     * a live bucket); for a parent margin account, net deposits plus settled
+     * realized PnL that no risk bucket has allocated. Every smaller amount is
+     * accepted too. It is zero on a risk bucket that is not `NORMAL` (under
+     * liquidation or frozen as bad debt) and on one whose realized loss has used
+     * up its allocation; the parent margin account is charged at most a risk
+     * bucket's allocation. Size transfers against this field, not
+     * `freeCollateral`. Truncated toward zero at the quote asset's precision,
+     * so the printed amount itself is always accepted.
      */
     withdrawableCollateral: string;
     totalPositionNotional: string;
@@ -71,7 +89,8 @@ export interface MarginAccountSummary {
      *
      * Present only on risk-bucket rows served from a live risk engine snapshot;
      * absent (the key is omitted, never null) on parent rows and on
-     * persisted-fallback reads.
+     * persisted-fallback reads. Truncated toward zero at the quote asset's
+     * precision, like `withdrawableCollateral`.
      */
     availableOrderCollateral?: string;
     /**
@@ -88,16 +107,52 @@ export interface MarginAccountSummary {
     copyLeaderHandle?: string;
 }
 export interface ListMarginAccountsParams {
-    page?: number;
+    /** Number of items per page, 1 to 1000 (default 20) */
     pageSize?: number;
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position, from the lowest margin account id.
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2788): there is no `page`, and
+     * sending one is a `400`. The walk seeks on
+     * `(marginAccountId, tradingPairId, riskBucketId, strategyKey)` over the
+     * repriced set the server builds per request — the parent account row ahead
+     * of its own bucket rows — so a bucket that opens or closes mid-walk no
+     * longer shifts the rows behind it across the resume point. The strategy key
+     * is part of the key because an auto bucket the engine has not materialized
+     * yet carries no `riskBucketId`, and one account and pair can hold several
+     * strategies; such a row sorts under the id its bucket will carry once the
+     * engine projects it, so provisioning completing mid-walk cannot serve the
+     * same risk bucket twice. The filters must match the request that minted the
+     * token.
+     */
+    pageToken?: string;
+    /**
+     * Keep only risk-bucket rows in this state (see
+     * {@link MarginAccountSummary.riskBucketState}). A parent margin account row
+     * has no state, so any filter excludes it.
+     */
     state?: string;
     tradingPairId?: string;
 }
 export interface ListMarginAccountsResponse {
     accounts: MarginAccountSummary[];
+    /**
+     * Rows matching the filters. Exact — a user's margin accounts and risk
+     * buckets are a small bounded set, counted in memory after the repricing
+     * pass.
+     */
     total: number;
-    page: number;
     pageSize: number;
+    /**
+     * Cursor for the next page, `""` once the walk is exhausted. The whole set
+     * is already in memory, so each page over-fetches one row and an empty token
+     * is definitive — follow a non-empty token, stop on an empty one.
+     */
+    nextPageToken: string;
 }
 export interface GetMarginAccountSummaryParams {
     tradingPairId?: string;
@@ -118,13 +173,13 @@ export interface GetAvailableCollateralResponse {
      * margin account yet.
      *
      * This is **not** trading headroom for existing cross exposure. It is
-     * bounded by allocation (principal not earmarked by risk buckets) as well
-     * as by margin requirements, and an unrealized gain does not raise it: a
+     * bounded by allocation (net deposits plus settled realized PnL not
+     * allocated to risk buckets) as well as by margin requirements, and an unrealized gain does not raise it: a
      * mark-to-market gain is initial margin against existing cross exposure but
      * may not fund an exit. `MarginAccountSummary.freeCollateral` credits that
      * gain in full and remains the trading-margin headroom for existing cross
      * exposure — but a **new** isolated or first-use position allocates
-     * principal through the same gate this field measures, so size those from
+     * collateral through the same gate this field measures, so size those from
      * this field.
      *
      * Note the two `margin*` fields answer opposite questions:
@@ -158,6 +213,8 @@ export interface TransferCollateralToParentMarginAccountRequest {
  */
 export interface TransferCollateralToIsolatedRiskBucketRequest extends TransferCollateralToParentMarginAccountRequest {
     marginMode?: "ISOLATED";
+    /** The margin account whose bucket is funded: omit for the default account, or name an open sub-account. */
+    marginAccountId?: string;
     tradingPairId: string;
     strategyKey?: string;
     selectedTradingPairIds?: never;
@@ -192,6 +249,8 @@ export interface TransferCollateralToIsolatedRiskBucketRequest extends TransferC
  */
 export interface TransferCollateralToCrossRiskBucketRequest extends TransferCollateralToParentMarginAccountRequest {
     marginMode: "CROSS";
+    /** The margin account whose cross bucket is funded: omit for the default account, or name an open sub-account. */
+    marginAccountId?: string;
     /**
      * Removed. This used to declare — and on every top-up REPLACE — the cross
      * bucket's scope, which let a partial list silently evict every flat pair it
@@ -221,6 +280,10 @@ export interface TransferCollateralResponse {
     status: string;
     newEquity: string;
     newTotalCollateralValue: string;
+    /**
+     * The largest amount a further transfer-out will accept after this one,
+     * truncated toward zero at the collateral asset's precision.
+     */
     newWithdrawableCollateral: string;
     /**
      * Whether the transfer was committed to a position's stored margin. Present
@@ -235,8 +298,21 @@ export interface TransferCollateralResponse {
 }
 export interface GetMarginAccountMovementsParams {
     movementType?: string;
-    page?: number;
+    /** Items per page, 1 to 1000 (default 20). */
     pageSize?: number;
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position, from the newest row — this listing always sorts
+     *   newest-first.
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2788): there is no `page`, and
+     * sending one is a 400. Filters must match the request that produced the
+     * token, or the request is rejected.
+     */
+    pageToken?: string;
 }
 export interface MarginAccountMovement {
     movementId: string;
@@ -248,15 +324,17 @@ export interface MarginAccountMovement {
 }
 export interface GetMarginAccountMovementsResponse {
     movements: MarginAccountMovement[];
+    pageSize: number;
     /**
-     * Matching movements. Exact up to 10,000 pages of the requested page size
-     * (`pageSize` x 10,000 rows) and saturates there, so a caller with more
-     * movements than the listing can page through reads the cap, not its
-     * lifetime total. `page` is capped at 10,000.
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page: this listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`. A non-empty token always
+     * has at least one further row behind it.
+     *
+     * The response carries no item count: the underlying ledger is too large to
+     * count behind a filter.
      */
-    total: number;
-    page: number;
-    pageSize: number;
+    nextPageToken: string;
 }
 export interface SimulateOrderRiskRequest {
     tradingPairId: string;
@@ -291,6 +369,8 @@ export interface SimulateOrderRiskRequest {
 }
 export type SimulateIsolatedRiskBucketOrderRiskRequest = SimulateOrderRiskRequest & {
     marginMode?: "ISOLATED";
+    /** The margin account previewed: omit for the default account, or name an open sub-account. */
+    marginAccountId?: string;
     strategyKey?: string;
     selectedTradingPairIds?: never;
 };
@@ -305,6 +385,8 @@ export type SimulateIsolatedRiskBucketOrderRiskRequest = SimulateOrderRiskReques
  */
 export type SimulateCrossRiskBucketOrderRiskRequest = SimulateOrderRiskRequest & {
     marginMode: "CROSS";
+    /** The margin account previewed: omit for the default account, or name an open sub-account. */
+    marginAccountId?: string;
     /**
      * Removed. This used to declare the scope the preview ran against (required,
      * containing `tradingPairId`, covering every open cross position) while the
@@ -416,7 +498,89 @@ export interface SimulateOrderRiskResponse {
      */
     referencePrice?: string;
 }
+/**
+ * Open a margin sub-account: another margin account of the caller, keyed by
+ * `subaccountKey`, with its own collateral and risk buckets. Keys are up to 64
+ * letters, digits, `_`, `-`, `.` or `:`; `copy:` keys are reserved and
+ * `default` names the default margin account. Re-creating the key of a closed
+ * sub-account re-opens it.
+ */
+export interface CreateMarginSubAccountRequest {
+    subaccountKey: string;
+    label?: string;
+}
+export interface CreateMarginSubAccountResponse {
+    marginAccountId: string;
+    subaccountKey: string;
+    marginAccountState: string;
+    label?: string;
+}
+/** One margin account's own PnL (default or sub-account); the owner's accounts sum to the owner-wide figure. */
+export interface MarginAccountPnl {
+    marginAccountId: string;
+    /** Settled on the account plus still held in its open risk buckets. */
+    realizedPnl: string;
+    /** The account's open positions repriced at the latest risk marks. */
+    unrealizedPnl: string;
+}
+export interface CloseMarginSubAccountResponse {
+    marginAccountId: string;
+    /** The default margin account that received the remaining collateral. */
+    defaultMarginAccountId: string;
+    /** Collateral moved to the default margin account. */
+    amount: string;
+}
+/** One side of a collateral transfer: the spot wallet, or a margin account. */
+export type CollateralTransferEndpoint = {
+    wallet: true;
+    marginAccountId?: never;
+    riskBucketId?: never;
+} | {
+    wallet?: never;
+    marginAccountId: string;
+    riskBucketId?: string;
+};
+/**
+ * Move collateral between the spot wallet and the caller's margin accounts.
+ * Supported: wallet to the default margin account and back, and margin
+ * account to margin account.
+ */
+export interface TransferMarginCollateralRequest {
+    asset: string;
+    amount: string;
+    from: CollateralTransferEndpoint;
+    to: CollateralTransferEndpoint;
+}
+export interface TransferMarginCollateralResponse {
+    movementId: string;
+    amount: string;
+    fromMarginAccountId?: string;
+    toMarginAccountId?: string;
+    toRiskBucketId?: string;
+}
 export interface MarginAccountsAPI extends BaseAPI {
+    /**
+     * Open a margin sub-account. Refused past the owner's cap on open sub-accounts (10 at the
+     * first volume tier, up to 50, or an admin override); copy-trading sub-accounts do not count.
+     */
+    createMarginSubAccount(request: CreateMarginSubAccountRequest): Promise<CreateMarginSubAccountResponse>;
+    /**
+     * Close a flat margin sub-account in one call: its flat, solvent risk buckets close and all of
+     * its collateral moves to the default margin account. A risk bucket in liquidation or bad debt
+     * refuses the close.
+     */
+    closeMarginSubAccount(marginAccountId: string): Promise<CloseMarginSubAccountResponse>;
+    /** One of the caller's margin accounts' own realized and unrealized PnL. */
+    getMarginAccountPnl(marginAccountId: string): Promise<MarginAccountPnl>;
+    transferMarginCollateral(request: TransferMarginCollateralRequest): Promise<TransferMarginCollateralResponse>;
+    /**
+     * Move collateral from the default margin account to one of the caller's sub-accounts, in one
+     * sequenced step. The default margin account itself is refused; fund it with the
+     * parent-margin-account routes.
+     */
+    transferCollateralToSubAccount(marginAccountId: string, amount: string): Promise<TransferMarginCollateralResponse>;
+    /** Move collateral from one of the caller's sub-accounts back to the default margin account. */
+    transferCollateralFromSubAccount(marginAccountId: string, amount: string): Promise<TransferMarginCollateralResponse>;
     listMarginAccounts(params?: ListMarginAccountsParams): Promise<ListMarginAccountsResponse>;
     getParentMarginAccountSummary(params?: GetMarginAccountSummaryParams): Promise<MarginAccountSummary>;
     /**

package/dist/market/index.d.ts

@@ -48,6 +48,12 @@ export interface TradingPair {
     category: string;
     /** Whether the market is active */
     isActive: boolean;
+    /**
+     * Isolated-only market: cross margin may only reduce a position here. A
+     * CROSS order that is not reduce-only is rejected with the error code
+     * `CROSS_MARGIN_NOT_ALLOWED`; open the position with `marginMode: "ISOLATED"`.
+     */
+    isolatedOnly: boolean;
     /** Maker fee in basis points */
     makerFeeBps: number;
     /** Taker fee in basis points */
@@ -486,30 +492,94 @@ export interface FundingRecord {
 export interface ListFundingHistoryParams {
     startTime?: string;
     endTime?: string;
-    page?: number;
+    /** Number of items per page, 1 to 1000 (default 50) */
     pageSize?: number;
-    /** Sort direction for epoch: "ASC" or "DESC" (default DESC). */
+    /** Sort direction for `settledAt`: "ASC" or "DESC" (default DESC). */
     orderBy?: "ASC" | "DESC";
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position, from the newest settlement (the oldest when
+     *   `orderBy` is `"ASC"`).
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2788): there is no `page`, and
+     * sending one is a `400`. The walk seeks on `(settledAt, id)` in the
+     * requested direction. Filters and `orderBy` must match the request that
+     * minted the token.
+     */
+    pageToken?: string;
 }
 export interface ListFundingHistoryResponse {
     records: FundingRecord[];
+    /**
+     * Settlements matching the filter, bounded by the server count ceiling — see
+     * `totalCapped`. A lower bound when `totalCapped` is `true`.
+     */
     total: number;
-    page: number;
+    /** Items per page */
     pageSize: number;
+    /**
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page. This listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`. A non-empty token always
+     * has at least one further row behind it.
+     */
+    nextPageToken: string;
+    /**
+     * `true` when MORE than the server ceiling of settlements matched, so the
+     * count stopped at the ceiling and `total` is a lower bound. `false` when
+     * `total` is the exact count — including exactly the ceiling, which is
+     * still reported exactly.
+     */
+    totalCapped: boolean;
 }
 export interface ListAllFundingHistoryParams {
     startTime?: string;
     endTime?: string;
-    page?: number;
+    /** Number of items per page, 1 to 1000 (default 50) */
     pageSize?: number;
-    /** Sort direction for settledAt (default DESC). */
+    /** Sort direction for `settledAt` (default DESC). */
     orderBy?: "ASC" | "DESC";
+    /**
+     * Pagination cursor with two states:
+     * - Omitted (`undefined`) or empty string (`""`): start a cursor walk with
+     *   no prior position, from the newest settlement (the oldest when
+     *   `orderBy` is `"ASC"`).
+     * - Non-empty: an opaque cursor from a previous response's
+     *   `nextPageToken`; results resume immediately after that position.
+     *
+     * Page-number pagination was removed (0XM-2788): there is no `page`, and
+     * sending one is a `400`. The walk seeks on `(settledAt, id)` in the
+     * requested direction. Filters and `orderBy` must match the request that
+     * minted the token.
+     */
+    pageToken?: string;
 }
 export interface ListAllFundingHistoryResponse {
     records: FundingRecord[];
+    /**
+     * Settlements matching the filter, bounded by the server count ceiling — see
+     * `totalCapped`. A lower bound when `totalCapped` is `true`.
+     */
     total: number;
-    page: number;
+    /** Items per page */
     pageSize: number;
+    /**
+     * Cursor for the next page, minted from the last row of an over-fetched
+     * page. This listing is one ordered read, so a page shorter than `pageSize`
+     * proves the walk is exhausted and this is `""`. A non-empty token always
+     * has at least one further row behind it.
+     */
+    nextPageToken: string;
+    /**
+     * `true` when MORE than the server ceiling of settlements matched, so the
+     * count stopped at the ceiling and `total` is a lower bound. `false` when
+     * `total` is the exact count — including exactly the ceiling, which is
+     * still reported exactly.
+     */
+    totalCapped: boolean;
 }
 export interface OpenInterest {
     tradingPairId: string;

package/dist/pitpass/index.d.ts

@@ -4,7 +4,7 @@
  * Types for PitPass TraderCode API: code lookup, rewards balance, and transfer.
  */
 import type { BaseAPI } from "../api";
-import type { GetMyReferralDownlineResponse, GetMyReferralPositionResponse, GetRewardsBalanceResponse, TraderCodeAvailabilityResponse, TraderCodeInfoResponse, TraderCodeResponse, TransferRewardsParams, TransferRewardsResponse } from "./responses";
+import type { GetMyReferralDownlineParams, GetMyReferralDownlineResponse, GetMyReferralPositionResponse, GetMyReferralTreeParams, GetMyReferralTreeResponse, GetRewardsBalanceResponse, TraderCodeAvailabilityResponse, TraderCodeInfoResponse, TraderCodeResponse, TransferRewardsParams, TransferRewardsResponse } from "./responses";
 /**
  * PitPass TraderCode API interface.
  *
@@ -92,8 +92,9 @@ export interface PitpassAPI extends BaseAPI {
      */
     transferRewards(params: TransferRewardsParams): Promise<TransferRewardsResponse>;
     /**
-     * Read your own referral position: your direct (L1) referrer, total earned,
-     * and most recent reward rows.
+     * Read your own referral position: your referral chain upward (`upline`, L1
+     * then L2 then L3), your direct referrer, total earned, and most recent
+     * reward rows.
      *
      * Self-scoped — the server derives your identity from the session, so you can
      * only ever read your own chain. `referrer` is the empty string when you were
@@ -101,20 +102,39 @@ export interface PitpassAPI extends BaseAPI {
      * identified by their public wallet address (with a `display` handle-or-wallet
      * variant), never an internal id.
      *
-     * @returns Promise resolving to your referrer, total earned, and recent rewards
+     * @returns Promise resolving to your upline, referrer, total earned, and recent rewards
      */
     getMyReferralPosition(): Promise<GetMyReferralPositionResponse>;
     /**
-     * Read your own downline: who you earn from and how much (earnings by source
-     * across L1/L2/L3), your L1 direct-referee roster (including referees who have
-     * not traded yet), and a per-level earnings summary.
+     * Read your own downline: one page of who you earn from and how much
+     * (earnings by source across every reward level, largest first), your L1
+     * direct-referee roster (including referees who have not traded yet), and a
+     * per-level earnings summary that covers every level and source on every
+     * page. Without `pageSize` / `pageToken` you get the first page (100 rows),
+     * not every row: follow `nextPageToken` until it is empty.
      *
      * Self-scoped and read-only. Every source and referee is a public wallet
      * address plus a `display` handle-or-wallet variant, never an internal id.
      *
-     * @returns Promise resolving to earnings-by-source, the direct-referee roster, and a summary
+     * @param params - Optional `pageSize` (1-500, default 100) and `pageToken`
+     * @returns Promise resolving to the earnings page, the direct-referee roster, a summary, and the next page token
      */
-    getMyReferralDownline(): Promise<GetMyReferralDownlineResponse>;
+    getMyReferralDownline(params?: GetMyReferralDownlineParams): Promise<GetMyReferralDownlineResponse>;
+    /**
+     * Read one level of your own referral tree: the wallets `parent` directly
+     * referred (yourself when `parent` is omitted), a page at a time, newest
+     * first. Expand a node by calling again with `parent` set to its wallet;
+     * nodes with `refereeCount > 0` are expandable, down to the deepest level
+     * PitPass rewards (configured by Monaco, at most 10).
+     *
+     * Self-scoped: `parent` must be you or one of your own referees above that
+     * deepest level — any other wallet is a 404. Each wallet appears once, under the referrer that
+     * earns from it.
+     *
+     * @param params - Optional `parent` wallet, `pageSize` (1-200), and `pageToken`
+     * @returns Promise resolving to the page of nodes and the next page token
+     */
+    getMyReferralTree(params?: GetMyReferralTreeParams): Promise<GetMyReferralTreeResponse>;
 }
-export type { GetMyReferralDownlineResponse, GetMyReferralPositionResponse, GetRewardsBalanceResponse, ReferralDirectReferee, ReferralEarningsSource, ReferralEarningsSummary, ReferralRewardEntry, RewardsBalanceEntry, SetTraderCodeParams, TraderCodeAvailabilityReason, TraderCodeAvailabilityResponse, TraderCodeInfoResponse, TraderCodeResponse, TransferRewardsParams, TransferRewardsResponse, } from "./responses";
-export { GetMyReferralDownlineResponseSchema, GetMyReferralPositionResponseSchema, GetRewardsBalanceResponseSchema, ReferralDirectRefereeSchema, ReferralEarningsSourceSchema, ReferralEarningsSummarySchema, ReferralRewardEntrySchema, RewardsBalanceEntrySchema, SetTraderCodeParamsSchema, TraderCodeAvailabilityReasonSchema, TraderCodeAvailabilityResponseSchema, TraderCodeInfoResponseSchema, TraderCodeResponseSchema, TransferRewardsParamsSchema, TransferRewardsResponseSchema, } from "./responses";
+export type { GetMyReferralDownlineParams, GetMyReferralDownlineResponse, GetMyReferralPositionResponse, GetMyReferralTreeParams, GetMyReferralTreeResponse, GetRewardsBalanceResponse, LevelEarnings, ReferralDirectReferee, ReferralEarningsSource, ReferralEarningsSummary, ReferralRewardEntry, ReferralTreeNode, ReferralUplineEntry, RewardsBalanceEntry, SetTraderCodeParams, TraderCodeAvailabilityReason, TraderCodeAvailabilityResponse, TraderCodeInfoResponse, TraderCodeResponse, TransferRewardsParams, TransferRewardsResponse, } from "./responses";
+export { GetMyReferralDownlineParamsSchema, GetMyReferralDownlineResponseSchema, GetMyReferralPositionResponseSchema, GetMyReferralTreeParamsSchema, GetMyReferralTreeResponseSchema, GetRewardsBalanceResponseSchema, LevelEarningsSchema, ReferralDirectRefereeSchema, ReferralEarningsSourceSchema, ReferralEarningsSummarySchema, ReferralRewardEntrySchema, ReferralTreeNodeSchema, ReferralUplineEntrySchema, RewardsBalanceEntrySchema, SetTraderCodeParamsSchema, TraderCodeAvailabilityReasonSchema, TraderCodeAvailabilityResponseSchema, TraderCodeInfoResponseSchema, TraderCodeResponseSchema, TransferRewardsParamsSchema, TransferRewardsResponseSchema, } from "./responses";

package/dist/pitpass/index.js

@@ -3,4 +3,4 @@
  *
  * Types for PitPass TraderCode API: code lookup, rewards balance, and transfer.
  */
-export { GetMyReferralDownlineResponseSchema, GetMyReferralPositionResponseSchema, GetRewardsBalanceResponseSchema, ReferralDirectRefereeSchema, ReferralEarningsSourceSchema, ReferralEarningsSummarySchema, ReferralRewardEntrySchema, RewardsBalanceEntrySchema, SetTraderCodeParamsSchema, TraderCodeAvailabilityReasonSchema, TraderCodeAvailabilityResponseSchema, TraderCodeInfoResponseSchema, TraderCodeResponseSchema, TransferRewardsParamsSchema, TransferRewardsResponseSchema, } from "./responses";
+export { GetMyReferralDownlineParamsSchema, GetMyReferralDownlineResponseSchema, GetMyReferralPositionResponseSchema, GetMyReferralTreeParamsSchema, GetMyReferralTreeResponseSchema, GetRewardsBalanceResponseSchema, LevelEarningsSchema, ReferralDirectRefereeSchema, ReferralEarningsSourceSchema, ReferralEarningsSummarySchema, ReferralRewardEntrySchema, ReferralTreeNodeSchema, ReferralUplineEntrySchema, RewardsBalanceEntrySchema, SetTraderCodeParamsSchema, TraderCodeAvailabilityReasonSchema, TraderCodeAvailabilityResponseSchema, TraderCodeInfoResponseSchema, TraderCodeResponseSchema, TransferRewardsParamsSchema, TransferRewardsResponseSchema, } from "./responses";

package/dist/pitpass/responses.d.ts

@@ -77,6 +77,12 @@ export declare const ReferralRewardEntrySchema: z.ZodObject<{
     rateApplied: z.ZodString;
     createdAt: z.ZodString;
 }, z.core.$strip>;
+/** One ancestor in the caller's referral chain. */
+export declare const ReferralUplineEntrySchema: z.ZodObject<{
+    wallet: z.ZodString;
+    display: z.ZodString;
+    level: z.ZodNumber;
+}, z.core.$strip>;
 /** The caller's own referral position: who referred them and what they've earned. */
 export declare const GetMyReferralPositionResponseSchema: z.ZodObject<{
     referrer: z.ZodString;
@@ -91,6 +97,11 @@ export declare const GetMyReferralPositionResponseSchema: z.ZodObject<{
         rateApplied: z.ZodString;
         createdAt: z.ZodString;
     }, z.core.$strip>>;
+    upline: z.ZodArray<z.ZodObject<{
+        wallet: z.ZodString;
+        display: z.ZodString;
+        level: z.ZodNumber;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 /** One aggregated earnings row per (source trader, level, token) the caller earns from. */
 export declare const ReferralEarningsSourceSchema: z.ZodObject<{
@@ -107,12 +118,26 @@ export declare const ReferralDirectRefereeSchema: z.ZodObject<{
     referredAt: z.ZodString;
     totalEarned: z.ZodString;
 }, z.core.$strip>;
+/** What the caller has earned at one referral level. */
+export declare const LevelEarningsSchema: z.ZodObject<{
+    level: z.ZodNumber;
+    earned: z.ZodString;
+}, z.core.$strip>;
 /** Per-level breakdown of the caller's total referral earnings. */
 export declare const ReferralEarningsSummarySchema: z.ZodObject<{
     totalEarned: z.ZodString;
     level1Earned: z.ZodString;
     level2Earned: z.ZodString;
     level3Earned: z.ZodString;
+    byLevel: z.ZodArray<z.ZodObject<{
+        level: z.ZodNumber;
+        earned: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Query parameters for reading the caller's downline. */
+export declare const GetMyReferralDownlineParamsSchema: z.ZodObject<{
+    pageSize: z.ZodOptional<z.ZodNumber>;
+    pageToken: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /** The caller's own downline: who they earn from, their L1 roster, and a summary. */
 export declare const GetMyReferralDownlineResponseSchema: z.ZodObject<{
@@ -134,7 +159,43 @@ export declare const GetMyReferralDownlineResponseSchema: z.ZodObject<{
         level1Earned: z.ZodString;
         level2Earned: z.ZodString;
         level3Earned: z.ZodString;
+        byLevel: z.ZodArray<z.ZodObject<{
+            level: z.ZodNumber;
+            earned: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
+    nextPageToken: z.ZodString;
+}, z.core.$strip>;
+/** Query parameters for reading one level of the caller's referral tree. */
+export declare const GetMyReferralTreeParamsSchema: z.ZodObject<{
+    parent: z.ZodOptional<z.ZodString>;
+    pageSize: z.ZodOptional<z.ZodNumber>;
+    pageToken: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** One wallet in the caller's referral tree. */
+export declare const ReferralTreeNodeSchema: z.ZodObject<{
+    wallet: z.ZodString;
+    display: z.ZodString;
+    level: z.ZodNumber;
+    parent: z.ZodString;
+    referredAt: z.ZodString;
+    refereeCount: z.ZodNumber;
+    totalEarned: z.ZodString;
+}, z.core.$strip>;
+/** One page of one level of the caller's referral tree. */
+export declare const GetMyReferralTreeResponseSchema: z.ZodObject<{
+    parent: z.ZodString;
+    parentLevel: z.ZodNumber;
+    nodes: z.ZodArray<z.ZodObject<{
+        wallet: z.ZodString;
+        display: z.ZodString;
+        level: z.ZodNumber;
+        parent: z.ZodString;
+        referredAt: z.ZodString;
+        refereeCount: z.ZodNumber;
+        totalEarned: z.ZodString;
+    }, z.core.$strip>>;
+    nextPageToken: z.ZodString;
 }, z.core.$strip>;
 export type RewardsBalanceEntry = z.infer<typeof RewardsBalanceEntrySchema>;
 export type GetRewardsBalanceResponse = z.infer<typeof GetRewardsBalanceResponseSchema>;
@@ -150,4 +211,10 @@ export type GetMyReferralPositionResponse = z.infer<typeof GetMyReferralPosition
 export type ReferralEarningsSource = z.infer<typeof ReferralEarningsSourceSchema>;
 export type ReferralDirectReferee = z.infer<typeof ReferralDirectRefereeSchema>;
 export type ReferralEarningsSummary = z.infer<typeof ReferralEarningsSummarySchema>;
+export type LevelEarnings = z.infer<typeof LevelEarningsSchema>;
+export type GetMyReferralDownlineParams = z.infer<typeof GetMyReferralDownlineParamsSchema>;
 export type GetMyReferralDownlineResponse = z.infer<typeof GetMyReferralDownlineResponseSchema>;
+export type ReferralUplineEntry = z.infer<typeof ReferralUplineEntrySchema>;
+export type GetMyReferralTreeParams = z.infer<typeof GetMyReferralTreeParamsSchema>;
+export type ReferralTreeNode = z.infer<typeof ReferralTreeNodeSchema>;
+export type GetMyReferralTreeResponse = z.infer<typeof GetMyReferralTreeResponseSchema>;