@pear-protocol/types 2.12.1 → 2.14.0

package/dist/auth/payloads.js

@@ -25,8 +25,8 @@ const StartXLinkRequest = z.object({
   returnTo: z.string().optional().describe("Page to send the browser back to once the link finishes, normally the page the user is on. Must be on the calling origin; defaults to that origin.")
 }).describe("Start of the X account link flow");
 const SetXVisibilityRequest = z.object({
-  xHidden: z.boolean().describe("True to withhold the linked X account from the leaderboard, false to publish it. The wanted state rather than a flip, so a retry lands on the same result and two tabs cannot disagree. Named to match `xHidden` on the user profile - one name for one value.")
-}).describe("Leaderboard visibility of the X account");
+  xHidden: z.boolean().describe("True to withhold the linked X account from the leaderboard and public trader profiles, false to publish it. The wanted state rather than a flip, so a retry lands on the same result and two tabs cannot disagree. Named to match `xHidden` on the user profile - one name for one value.")
+}).describe("Visibility of the X account on the leaderboard and public trader profiles");
 const PkceValue = z.string().regex(/^[A-Za-z0-9_-]{43}$/, "Must be 43 base64url characters");
 const StartXLoginRequest = z.object({
   returnTo: z.string().optional().describe("Page to send the browser back to once the sign-in finishes, normally the page the user is on. Must be on the calling origin; defaults to that origin. Any fragment is dropped - the flow returns its ticket there."),

package/dist/auth/response.js

@@ -38,8 +38,8 @@ const StartXLinkResponse = z.object({
   authorizeUrl: z.string().describe("X authorization URL to send the browser to. Expires with the flow's state.")
 }).describe("Start of the X account link flow");
 const SetXVisibilityResponse = z.object({
-  xHidden: z.boolean().describe("The stored state, read back from the write: true when the leaderboard withholds the X account. A confirmation of what was asked for, not a value the caller could not otherwise know.")
-}).describe("Leaderboard visibility of the X account after the write");
+  xHidden: z.boolean().describe("The stored state, read back from the write: true when the leaderboard and public trader profiles withhold the X account. A confirmation of what was asked for, not a value the caller could not otherwise know.")
+}).describe("Visibility of the X account on the leaderboard and public trader profiles after the write");
 const DisconnectXResponse = z.void().describe("Successful X account disconnect response");
 const StartXLoginResponse = z.object({
   authorizeUrl: z.string().describe("X authorization URL to send the browser to. Expires with the flow's state.")

package/dist/copy/entities.d.ts

@@ -37,6 +37,114 @@ export declare const CopySubscription: z.ZodObject<{
     endedAt: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type CopySubscription = z.infer<typeof CopySubscription>;
+/** Active position-lifetime USD totals; mark, basis, or exposure gaps can leave measured PnL partial. */
+export declare const CopySubscriptionMetrics: z.ZodObject<{
+    volume: z.ZodString;
+    grossRealizedPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    fundingPayment: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    totalNetPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+}, z.core.$strip>;
+export type CopySubscriptionMetrics = z.output<typeof CopySubscriptionMetrics>;
+/** Current subscription with volume, gross PnL, attributed funding, signed fees, and net PnL. */
+export declare const CopySubscriptionWithMetrics: z.ZodObject<{
+    id: z.ZodUUID;
+    leaderTradeAccountId: z.ZodUUID;
+    followerTradeAccountId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+        lighter_rhc: "lighter_rhc";
+    }>;
+    sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+    }, z.core.$strip>], "mode">;
+    createdAt: z.ZodString;
+    endedAt: z.ZodOptional<z.ZodString>;
+    status: z.ZodLiteral<"ACTIVE">;
+    volume: z.ZodString;
+    grossRealizedPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    fundingPayment: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    totalNetPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+}, z.core.$strip>;
+export type CopySubscriptionWithMetrics = z.output<typeof CopySubscriptionWithMetrics>;
+/** Ended subscription with lifetime turnover only. */
+export declare const CopyEndedSubscriptionWithVolume: z.ZodObject<{
+    id: z.ZodUUID;
+    leaderTradeAccountId: z.ZodUUID;
+    followerTradeAccountId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+        lighter_rhc: "lighter_rhc";
+    }>;
+    sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+    }, z.core.$strip>], "mode">;
+    createdAt: z.ZodString;
+    endedAt: z.ZodOptional<z.ZodString>;
+    status: z.ZodLiteral<"ENDED">;
+    volume: z.ZodString;
+}, z.core.$strip>;
+export type CopyEndedSubscriptionWithVolume = z.output<typeof CopyEndedSubscriptionWithVolume>;
+/** Read shape selected by subscription status. */
+export declare const CopySubscriptionRead: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodUUID;
+    leaderTradeAccountId: z.ZodUUID;
+    followerTradeAccountId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+        lighter_rhc: "lighter_rhc";
+    }>;
+    sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+    }, z.core.$strip>], "mode">;
+    createdAt: z.ZodString;
+    endedAt: z.ZodOptional<z.ZodString>;
+    status: z.ZodLiteral<"ACTIVE">;
+    volume: z.ZodString;
+    grossRealizedPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    fundingPayment: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    totalNetPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodUUID;
+    leaderTradeAccountId: z.ZodUUID;
+    followerTradeAccountId: z.ZodUUID;
+    connector: z.ZodEnum<{
+        hyperliquid: "hyperliquid";
+        binance: "binance";
+        bybit: "bybit";
+        okx: "okx";
+        lighter: "lighter";
+        lighter_rhc: "lighter_rhc";
+    }>;
+    sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+    }, z.core.$strip>], "mode">;
+    createdAt: z.ZodString;
+    endedAt: z.ZodOptional<z.ZodString>;
+    status: z.ZodLiteral<"ENDED">;
+    volume: z.ZodString;
+}, z.core.$strip>], "status">;
+export type CopySubscriptionRead = z.output<typeof CopySubscriptionRead>;
 export declare const CopyActivityOutcome: z.ZodEnum<{
     COPIED: "COPIED";
     PARTIAL: "PARTIAL";

package/dist/copy/entities.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { SignedDecimalString } from '../common/schema';
+import { SignedDecimalString, UnsignedDecimalString } from '../common/schema';
 import { Connector } from '../connector';
 import { InstrumentId } from '../instrument';
 
@@ -26,6 +26,27 @@ const CopySubscription = z.object({
   createdAt: z.string().describe("ISO 8601"),
   endedAt: z.string().optional().describe("ISO 8601; set once the follower unsubscribed")
 });
+const CopySubscriptionMetrics = z.object({
+  volume: UnsignedDecimalString.describe("Lifetime executed USD turnover across opens and closes; excludes fees and funding"),
+  grossRealizedPnl: SignedDecimalString.describe("Gross realized USD PnL over attributed positions, including partial reductions; excludes fees and funding"),
+  grossUpnl: SignedDecimalString.describe("Gross unrealized USD PnL on OPEN attributed positions at current marks; missing marks or entry basis can make this total partial; excludes fees and funding"),
+  fundingPayment: SignedDecimalString.describe("Signed USD funding attributed from historical exposure snapshots and per-unit payments; absent snapshots contribute no measured funding"),
+  tradeFee: SignedDecimalString.describe("Signed USD trade fees on attributed position fills; negative values are rebates"),
+  pearFee: SignedDecimalString.describe("Signed USD Pear fees on attributed position fills; negative values are rebates"),
+  totalNetPnl: SignedDecimalString.describe("Gross realized plus gross unrealized plus fundingPayment minus tradeFee and pearFee in USD; mark, basis, or exposure gaps can make the measured total partial")
+});
+const CopySubscriptionWithMetrics = CopySubscription.extend({
+  ...CopySubscriptionMetrics.shape,
+  status: z.literal("ACTIVE")
+});
+const CopyEndedSubscriptionWithVolume = CopySubscription.extend({
+  status: z.literal("ENDED"),
+  volume: CopySubscriptionMetrics.shape.volume
+});
+const CopySubscriptionRead = z.discriminatedUnion("status", [
+  CopySubscriptionWithMetrics,
+  CopyEndedSubscriptionWithVolume
+]);
 const CopyActivityOutcome = z.enum([
   "COPIED",
   "PARTIAL",
@@ -110,4 +131,4 @@ const CopyFollower = z.object({
   xAvatarUrl: z.string().optional()
 });
 
-export { CopyActivity, CopyActivityLeg, CopyActivityOutcome, CopyActivityState, CopyExecutionSource, CopyFollower, CopyLeaderAction, CopySizing, CopySkipReason, CopySubscription, CopySubscriptionStatus };
+export { CopyActivity, CopyActivityLeg, CopyActivityOutcome, CopyActivityState, CopyEndedSubscriptionWithVolume, CopyExecutionSource, CopyFollower, CopyLeaderAction, CopySizing, CopySkipReason, CopySubscription, CopySubscriptionMetrics, CopySubscriptionRead, CopySubscriptionStatus, CopySubscriptionWithMetrics };

package/dist/copy/queries.d.ts

@@ -1,4 +1,12 @@
 import { z } from 'zod';
+export declare const CopySubscriptionListQuery: z.ZodObject<{
+    status: z.ZodOptional<z.ZodEnum<{
+        ACTIVE: "ACTIVE";
+        ENDED: "ENDED";
+    }>>;
+}, z.core.$strip>;
+export type CopySubscriptionListQueryInput = z.input<typeof CopySubscriptionListQuery>;
+export type CopySubscriptionListQuery = z.output<typeof CopySubscriptionListQuery>;
 export declare const CopyActivityListParams: z.ZodObject<{
     limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
 }, z.core.$strip>;

package/dist/copy/queries.js

@@ -1,5 +1,9 @@
 import { z } from 'zod';
+import { CopySubscriptionStatus } from './entities';
 
+const CopySubscriptionListQuery = z.object({
+  status: CopySubscriptionStatus.optional()
+});
 const CopyActivityListParams = z.object({
   limit: z.coerce.number().int().min(1).max(200).default(50)
 });
@@ -13,4 +17,4 @@ const CopyStatsParams = z.object({
   ]
 });
 
-export { CopyActivityListParams, CopyStatsParams };
+export { CopyActivityListParams, CopyStatsParams, CopySubscriptionListQuery };

package/dist/copy/responses.d.ts

@@ -22,6 +22,13 @@ export declare const CopyStateResponse: z.ZodDiscriminatedUnion<[z.ZodObject<{
         createdAt: z.ZodString;
         endedAt: z.ZodOptional<z.ZodString>;
         status: z.ZodLiteral<"ACTIVE">;
+        volume: z.ZodString;
+        grossRealizedPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        fundingPayment: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        totalNetPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     }, z.core.$strip>;
 }, z.core.$strip>], "state">;
 export type CopyStateResponse = z.output<typeof CopyStateResponse>;
@@ -190,7 +197,7 @@ export declare const CreateCopySubscriptionResponse: z.ZodObject<{
 }, z.core.$strip>;
 export type CreateCopySubscriptionResponse = z.output<typeof CreateCopySubscriptionResponse>;
 export declare const CopySubscriptionListResponse: z.ZodObject<{
-    subscriptions: z.ZodArray<z.ZodObject<{
+    subscriptions: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         id: z.ZodUUID;
         leaderTradeAccountId: z.ZodUUID;
         followerTradeAccountId: z.ZodUUID;
@@ -202,16 +209,39 @@ export declare const CopySubscriptionListResponse: z.ZodObject<{
             lighter: "lighter";
             lighter_rhc: "lighter_rhc";
         }>;
-        status: z.ZodEnum<{
-            ACTIVE: "ACTIVE";
-            ENDED: "ENDED";
+        sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
+        }, z.core.$strip>], "mode">;
+        createdAt: z.ZodString;
+        endedAt: z.ZodOptional<z.ZodString>;
+        status: z.ZodLiteral<"ACTIVE">;
+        volume: z.ZodString;
+        grossRealizedPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        fundingPayment: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        tradeFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        pearFee: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        totalNetPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    }, z.core.$strip>, z.ZodObject<{
+        id: z.ZodUUID;
+        leaderTradeAccountId: z.ZodUUID;
+        followerTradeAccountId: z.ZodUUID;
+        connector: z.ZodEnum<{
+            hyperliquid: "hyperliquid";
+            binance: "binance";
+            bybit: "bybit";
+            okx: "okx";
+            lighter: "lighter";
+            lighter_rhc: "lighter_rhc";
         }>;
         sizing: z.ZodDiscriminatedUnion<[z.ZodObject<{
             mode: z.ZodLiteral<"LEADER_EQUITY_FRACTION">;
         }, z.core.$strip>], "mode">;
         createdAt: z.ZodString;
         endedAt: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
+        status: z.ZodLiteral<"ENDED">;
+        volume: z.ZodString;
+    }, z.core.$strip>], "status">>;
 }, z.core.$strip>;
 export type CopySubscriptionListResponse = z.output<typeof CopySubscriptionListResponse>;
 export declare const CopyActivityListResponse: z.ZodObject<{

package/dist/copy/responses.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { UnsignedDecimalString } from '../common/schema';
-import { CopySubscription, CopyFollower, CopySkipReason, CopyActivity, CopySubscriptionStatus } from './entities';
+import { CopySubscriptionWithMetrics, CopyFollower, CopySubscription, CopySkipReason, CopySubscriptionRead, CopyActivity, CopySubscriptionStatus } from './entities';
 
 const CopyStateResponse = z.discriminatedUnion("state", [
   z.object({
@@ -8,9 +8,7 @@ const CopyStateResponse = z.discriminatedUnion("state", [
   }),
   z.object({
     state: z.literal("ACTIVE"),
-    subscription: CopySubscription.extend({
-      status: z.literal("ACTIVE")
-    })
+    subscription: CopySubscriptionWithMetrics
   })
 ]);
 const CopyFollowersResponse = z.object({
@@ -52,7 +50,7 @@ const CreateCopySubscriptionResponse = CopySubscriptionResponse.extend({
   joinResults: z.array(CopyJoinResult)
 });
 const CopySubscriptionListResponse = z.object({
-  subscriptions: z.array(CopySubscription)
+  subscriptions: z.array(CopySubscriptionRead)
 });
 const CopyActivityListResponse = z.object({
   activities: z.array(CopyActivity)

package/dist/position/entities.d.ts

@@ -359,11 +359,10 @@ export declare const OpenPositionLeg: z.ZodObject<{
 }, z.core.$strip>;
 export type OpenPositionLeg = z.output<typeof OpenPositionLeg>;
 /**
- * The realized view of one open position: the part of it that has already been booked,
- * composed server-side from the same math /positions/closed uses.
+ * The lifetime economics of one open position, including booked realized PnL and
+ * gross unrealized PnL at live marks, composed server-side from shared position math.
  *
- * A pure ledger read — no mark price and therefore no unrealized PnL, which
- * /positions and /portfolio's openSnapshot already carry.
+ * Its gross unrealized PnL uses current marks where a priced entry basis is known.
  */
 export declare const OpenPosition: z.ZodObject<{
     positionId: z.ZodUUID;
@@ -384,6 +383,8 @@ export declare const OpenPosition: z.ZodObject<{
         EXTERNAL: "EXTERNAL";
     }>;
     realizedGrossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+    volume: z.ZodString;
+    grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     netCashflow: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     totalFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
     tradeFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;

package/dist/position/entities.js

@@ -313,6 +313,10 @@ const OpenPosition = z.object({
   * live, and revisable while it is — see netCashflow on reconciliation.
   */
   realizedGrossPnl: SignedDecimalString,
+  /** Lifetime executed USD turnover, including opening and closing fills. */
+  volume: UnsignedDecimalString.describe("Lifetime executed USD turnover across opening and closing fills"),
+  /** Gross unrealized PnL at current marks; missing marks or entry basis can make this total partial. */
+  grossUpnl: SignedDecimalString.describe("Gross unrealized USD PnL at current marks; missing marks or entry basis can make this total partial; excludes fees and funding"),
   /**
   * Cash booked so far: realized gross PnL minus every fee charged to date. Not a
   * settled return on closed quantity — it books every fee charged so far, including

package/dist/position/responses.d.ts

@@ -224,6 +224,8 @@ export declare const OpenPositionListResponse: z.ZodObject<{
             EXTERNAL: "EXTERNAL";
         }>;
         realizedGrossPnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
+        volume: z.ZodString;
+        grossUpnl: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         netCashflow: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         totalFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;
         tradeFees: z.ZodPipe<z.ZodString, z.ZodTransform<`-${string}` | `+${string}`, string>>;

package/dist/statistics/entities.d.ts

@@ -10,6 +10,7 @@ export declare const LeaderboardRow: z.ZodObject<{
         lighter: "lighter";
         lighter_rhc: "lighter_rhc";
     }>;
+    copyingEnabled: z.ZodBoolean;
     followers: z.ZodArray<z.ZodObject<{
         tradeAccountId: z.ZodUUID;
         status: z.ZodLiteral<"ACTIVE">;

package/dist/statistics/entities.js

@@ -10,8 +10,12 @@ const LeaderboardRow = z.object({
   // address beside a real name and a PnL deanonymizes a trader for good, and an address is
   // not reversible once scraped. Neither id here is a credential — every route that takes
   // one checks ownership or role, never knowledge of the id.
+  // This guarantee applies to private routes. Shared public profiles are addressable by
+  // tradeAccountId and omit the exchange identifier, including when the owner shows X identity.
   userId: z.string(),
   connector: Connector,
+  // Current owner consent; venue support and admission availability also apply.
+  copyingEnabled: z.boolean().describe("Whether the owner allows new copy subscriptions; venue support and admission availability also apply"),
   // Followers when this board was cached, independent of the performance date range.
   followers: z.array(CopyFollower),
   followerCount: z.number().int().nonnegative(),

package/dist/statistics/responses.d.ts

@@ -11,6 +11,7 @@ export declare const LeaderboardResponse: z.ZodObject<{
             lighter: "lighter";
             lighter_rhc: "lighter_rhc";
         }>;
+        copyingEnabled: z.ZodBoolean;
         followers: z.ZodArray<z.ZodObject<{
             tradeAccountId: z.ZodUUID;
             status: z.ZodLiteral<"ACTIVE">;

package/dist/traders/public.d.ts

@@ -2571,7 +2571,11 @@ export declare const PublicTraderResponse: z.ZodObject<{
         lighter: "lighter";
         lighter_rhc: "lighter_rhc";
     }>;
-    exchangeIdentifier: z.ZodString;
+    copyingEnabled: z.ZodBoolean;
+    xHandle: z.ZodOptional<z.ZodString>;
+    xName: z.ZodOptional<z.ZodString>;
+    xAvatarUrl: z.ZodOptional<z.ZodString>;
+    xUserId: z.ZodOptional<z.ZodString>;
     followers: z.ZodArray<z.ZodObject<{
         tradeAccountId: z.ZodUUID;
         status: z.ZodLiteral<"ACTIVE">;

package/dist/traders/public.js

@@ -148,7 +148,12 @@ const PublicLadder = Ladder.pick({
 });
 const PublicTraderResponse = z.object({
   connector: Connector.describe("Exchange connector type"),
-  exchangeIdentifier: z.string().describe("User identifier on the exchange"),
+  copyingEnabled: z.boolean().describe("Whether the owner allows new copy subscriptions; venue support and admission availability also apply"),
+  // Omit X identity when the owner hides it or has not linked an account.
+  xHandle: z.string().optional().describe("Public X handle at the last authorization; absent when hidden or unlinked"),
+  xName: z.string().optional().describe("Public X display name; absent when hidden or unlinked"),
+  xAvatarUrl: z.string().optional().describe("Public X avatar URL; absent when hidden or unlinked"),
+  xUserId: z.string().optional().describe("Immutable X numeric user ID; absent when hidden or unlinked"),
   // Followers are complete; the latest-20 limit applies only to trading records.
   followers: z.array(CopyFollower),
   followerCount: z.number().int().nonnegative(),

package/dist/users/entities.js

@@ -24,7 +24,7 @@ const UserProfile = z.object({
   // A plain boolean rather than nullable, matching `emailVerified` above: this is the
   // owner's own setting, which is known whether or not an X account is linked. With none
   // linked it describes what would happen once one is.
-  xHidden: z.boolean().describe("Whether the leaderboard withholds the linked X account")
+  xHidden: z.boolean().describe("Whether the leaderboard and public trader profiles withhold the linked X account")
 }).describe("User profile of the authenticated user");
 const BoundReferralReferee = z.object({
   status: z.literal("BOUND").describe("The referee resolves to a V3 user with a permanent binding"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pear-protocol/types",
-  "version": "2.12.1",
+  "version": "2.14.0",
   "description": "Pear Protocol Types definitions",
   "private": false,
   "type": "module",