@coinbase-sample/prime-sdk-ts 0.9.0 → 0.10.0

package/dist/types/model/CrossMarginPrimeRiskNettingInfo.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { CrossMarginPrimeXMPosition } from './CrossMarginPrimeXMPosition';
+import { PrimeXMMarginRequirementBreakdown } from './PrimeXMMarginRequirementBreakdown';
+import { PrimeXMOffsetCreditBreakdown } from './PrimeXMOffsetCreditBreakdown';
+/**
+ * Groups XM margin requirement components, offset credits, and per-asset rows.
+ */
+export type CrossMarginPrimeRiskNettingInfo = {
+    /**
+     * Derivatives Clearing Organization Margin Requirement (DMR) is the margin requirement for all futures positions, derived from the Derivatives Clearing Organization model
+     */
+    dcoMarginRequirement?: string;
+    /**
+     * Portfolio Margin Requirement (PMR) is the margin requirement for all spot positions, derived from the XM model
+     */
+    portfolioMarginRequirement?: string;
+    /**
+     * Integrated Portfolio Margin Requirement (IPMR) is the margin requirement for all spot positions + futures positions with underlying assets eligible in Portfolio Margin.
+     */
+    integratedPortfolioMarginRequirement?: string;
+    /**
+     * Ineligible Futures Margin Requirement (IFMR) is the margin requirement for IPMR-ineligible futures contracts
+     */
+    ineligibleFuturesMarginRequirement?: string;
+    pmrBreakdown?: PrimeXMMarginRequirementBreakdown;
+    ipmrBreakdown?: PrimeXMMarginRequirementBreakdown;
+    portfolioMarginOffsetCreditBreakdown?: PrimeXMOffsetCreditBreakdown;
+    integratedPortfolioMarginOffsetCreditBreakdown?: PrimeXMOffsetCreditBreakdown;
+    /**
+     * Netted positions used in the model calculation.
+     */
+    xmPositions?: Array<CrossMarginPrimeXMPosition>;
+};

package/dist/types/model/CrossMarginPrimeSpotEquityBreakdown.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * Breakdown of the components of spot equity.
+ */
+export type CrossMarginPrimeSpotEquityBreakdown = {
+    /**
+     * PM cash balance component of spot equity.
+     */
+    cashBalance?: string;
+    /**
+     * Long market value component of spot equity.
+     */
+    longMarketValue?: string;
+    /**
+     * Short market value component of spot equity.
+     */
+    shortMarketValue?: string;
+    /**
+     * Short collateral component of spot equity.
+     */
+    shortCollateral?: string;
+    /**
+     * Pending transfers affecting spot equity.
+     */
+    pendingTransfers?: string;
+};

package/dist/types/model/CrossMarginPrimeXMPosition.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * CrossMarginPrimeXMPosition is a single per-asset XM row (proto-backed fields from XMPositionDetails).
+ */
+export type CrossMarginPrimeXMPosition = {
+    /**
+     * Position currency
+     */
+    currency?: string;
+    /**
+     * Current market price
+     */
+    marketPrice?: string;
+    /**
+     * XM spot balance nominal
+     */
+    spotBalance?: string;
+    /**
+     * XM spot balance notional
+     */
+    spotBalanceNotional?: string;
+    /**
+     * XM futures balance nominal
+     */
+    futuresBalance?: string;
+    /**
+     * XM futures balance notional
+     */
+    futuresBalanceNotional?: string;
+    /**
+     * Base margin requirement notional
+     */
+    baseRequirement?: string;
+    /**
+     * Total margin required
+     */
+    totalPositionMargin?: string;
+    /**
+     * Basis offset credit applied to this asset row.
+     */
+    basisCredit?: string;
+    /**
+     * Post-netting USD notional for futures on this asset
+     */
+    futuresNettedNotional?: string;
+    /**
+     * Margin attributed to futures netting for this asset row.
+     */
+    futuresNettingMargin?: string;
+    /**
+     * Per-asset long amount from position_summary.
+     */
+    longAmount?: string;
+    /**
+     * Per-asset short amount from position_summary.
+     */
+    shortAmount?: string;
+    /**
+     * Volatility margin add-on for this asset.
+     */
+    volatilityAddon?: string;
+    /**
+     * Liquidity margin add-on for this asset.
+     */
+    liquidityAddon?: string;
+};

package/dist/types/model/CrossMarginRiskParameters.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+/**
+ * XM 2.0 risk parameters for an asset tier
+ */
+export type CrossMarginRiskParameters = {
+    /**
+     * Asset tier identifier
+     */
+    assetTier?: string;
+    /**
+     * Base ratio for long positions
+     */
+    baseRatioLong?: string;
+    /**
+     * Base ratio for short positions
+     */
+    baseRatioShort?: string;
+    /**
+     * Volatility rate for long positions
+     */
+    volatilityRateLong?: string;
+    /**
+     * Volatility rate for short positions
+     */
+    volatilityRateShort?: string;
+    /**
+     * Volatility low threshold
+     */
+    volatilityLowThreshold?: string;
+    /**
+     * Volatility high threshold
+     */
+    volatilityHighThreshold?: string;
+    /**
+     * Liquidity A for long positions
+     */
+    liquidityALong?: string;
+    /**
+     * Liquidity A for short positions
+     */
+    liquidityAShort?: string;
+    /**
+     * Liquidity B for short positions
+     */
+    liquidityBShort?: string;
+    /**
+     * Liquidity threshold
+     */
+    liquidityThreshold?: string;
+    /**
+     * Basis offset credit rate
+     */
+    basisOffsetCreditRate?: string;
+};

package/dist/types/model/EntityUser.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { SecondaryPermission } from './enums/SecondaryPermission';
 import { UserRole } from './enums/UserRole';
 export type EntityUser = {
     /**
@@ -36,4 +37,12 @@ export type EntityUser = {
      */
     entityId?: string;
     role?: UserRole;
+    /**
+     * All primary roles assigned to the user.
+     */
+    roles?: Array<UserRole>;
+    /**
+     * All secondary permissions assigned to the user.
+     */
+    secondaryPermissions?: Array<SecondaryPermission>;
 };

package/dist/types/model/Fill.d.ts

@@ -17,7 +17,9 @@
  *
  *  Do not edit the class manually.
  */
+import { CommissionDetailTotal } from './CommissionDetailTotal';
 import { OrderSide } from './enums/OrderSide';
+import { ProductType } from './enums/ProductType';
 export type Fill = {
     /**
      * The unique ID of the fill
@@ -68,4 +70,6 @@ export type Fill = {
      * The CES commission incurred for the fill
      */
     cesCommission?: string;
+    productType?: ProductType;
+    commissionDetailTotal?: CommissionDetailTotal;
 };

package/dist/types/model/GetCrossMarginPrimeOverviewResponse.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { CrossMarginPrimeMarginSummary } from './CrossMarginPrimeMarginSummary';
+import { PrimeXMControlStatus } from './enums/PrimeXMControlStatus';
+import { PrimeXMMarginLevel } from './enums/PrimeXMMarginLevel';
+export type GetCrossMarginPrimeOverviewResponse = {
+    controlStatus?: PrimeXMControlStatus;
+    marginLevel?: PrimeXMMarginLevel;
+    /**
+     * When margin metrics were evaluated.
+     */
+    evaluatedAt?: Date;
+    marginSummary?: CrossMarginPrimeMarginSummary;
+};

package/dist/types/model/GetCrossMarginRiskParametersResponse.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { CrossMarginRiskParameters } from './CrossMarginRiskParameters';
+import { TierPairRateEntry } from './TierPairRateEntry';
+export type GetCrossMarginRiskParametersResponse = {
+    /**
+     * Current XM tier risk parameters for the entity\'s client tier
+     */
+    riskParameters?: Array<CrossMarginRiskParameters>;
+    /**
+     * Offset credit rate matrix for long/short tier pairs
+     */
+    offsetCreditMatrixLongShort?: Array<TierPairRateEntry>;
+    /**
+     * Offset credit rate matrix for long/long tier pairs
+     */
+    offsetCreditMatrixLongLong?: Array<TierPairRateEntry>;
+    /**
+     * Offset credit rate matrix for short/short tier pairs
+     */
+    offsetCreditMatrixShortShort?: Array<TierPairRateEntry>;
+    /**
+     * Margin period of risk (number of days)
+     */
+    marginPeriodOfRisk?: number;
+};

package/dist/types/model/GetFcmRiskLimitsResponse.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { FcmMarginHealthState } from './enums/FcmMarginHealthState';
 export type GetFcmRiskLimitsResponse = {
     /**
      * Risk Limit set for a client
@@ -42,4 +43,9 @@ export type GetFcmRiskLimitsResponse = {
      * Unsettled accrued funding PNL from the last settlement
      */
     cfmUnsettledAccruedFundingPnl?: string;
+    /**
+     * Margin utilization as a decimal percentage between 0 and 1 (e.g. 0.5 means 50%)
+     */
+    marginUtilizationPercent?: string;
+    marginHealthState?: FcmMarginHealthState;
 };

package/dist/types/model/{GetWalletAddressesResponse.d.ts → GetMarketDataResponse.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright 2025-present Coinbase Global, Inc.
+ * Copyright 2026-present Coinbase Global, Inc.
  *
  * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
  *
@@ -17,9 +17,12 @@
  *
  *  Do not edit the class manually.
  */
-import { BlockchainAddress } from './BlockchainAddress';
+import { MarketData } from './MarketData';
 import { PaginatedResponse } from './PaginatedResponse';
-export type GetWalletAddressesResponse = {
-    addresses: Array<BlockchainAddress>;
-    pagination: PaginatedResponse;
+export type GetMarketDataResponse = {
+    /**
+     * List of market data entries
+     */
+    marketData?: Array<MarketData>;
+    pagination?: PaginatedResponse;
 };

package/dist/types/model/MarketData.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type MarketData = {
+    /**
+     * Base asset symbol (e.g., BTC, ETH, SOL)
+     */
+    symbol?: string;
+    /**
+     * Daily historical volatility over trailing 5 days (decimal, e.g., 0.65 = 65%)
+     */
+    vol5d?: string;
+    /**
+     * Daily historical volatility over trailing 30 days (decimal, e.g., 0.65 = 65%)
+     */
+    vol30d?: string;
+    /**
+     * Daily historical volatility over trailing 90 days (decimal, e.g., 0.65 = 65%)
+     */
+    vol90d?: string;
+    /**
+     * Average daily trading volume over trailing 30 days (USD)
+     */
+    adv30d?: string;
+    /**
+     * Weighted blend of the most recent vol_5d and the max vol_5d over last 30 days into a single volatility measure (decimal).
+     */
+    weightedVol?: string;
+};

package/dist/types/model/NetworkDetails.d.ts

@@ -56,4 +56,16 @@ export type NetworkDetails = {
      * Indicates the symbol that can be used to query other endpoints, related to transactions, wallets, and activities, to get information particularly for this asset on the network
      */
     networkScopedSymbol?: string;
+    /**
+     * The minimum withdrawal amount for this network. Applies to trading, prime custody, and vault wallets.
+     */
+    minWithdrawalAmount?: string;
+    /**
+     * The platform maximum withdrawal amount for this network. Applies to trading, prime custody, and vault wallets. Note that Prime Transfer policies may override this value.
+     */
+    maxWithdrawalAmount?: string;
+    /**
+     * The minimum deposit amount for this network. Applies to trading, prime custody, and vault wallets.
+     */
+    minDepositAmount?: string;
 };

package/dist/types/model/Order.d.ts

@@ -18,10 +18,12 @@
  *  Do not edit the class manually.
  */
 import { LimitOrderEdit } from './LimitOrderEdit';
+import { CommissionDetailTotal } from './CommissionDetailTotal';
 import { OrderEdit } from './OrderEdit';
 import { OrderSide } from './enums/OrderSide';
 import { OrderStatus } from './enums/OrderStatus';
 import { OrderType } from './enums/OrderType';
+import { ProductType } from './enums/ProductType';
 import { TimeInForceType } from './enums/TimeInForceType';
 export type Order = {
     /**
@@ -152,4 +154,6 @@ export type Order = {
      * The wig (would if good) level for PEG orders - best price opposite to limit_price
      */
     wigLevel?: string;
+    productType?: ProductType;
+    commissionDetailTotal?: CommissionDetailTotal;
 };

package/dist/types/model/PortfolioUser.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { SecondaryPermission } from './enums/SecondaryPermission';
 import { UserRole } from './enums/UserRole';
 export type PortfolioUser = {
     /**
@@ -40,4 +41,12 @@ export type PortfolioUser = {
      */
     entityId?: string;
     role?: UserRole;
+    /**
+     * All primary roles assigned to the user.
+     */
+    roles?: Array<UserRole>;
+    /**
+     * All secondary permissions assigned to the user.
+     */
+    secondaryPermissions?: Array<SecondaryPermission>;
 };

package/dist/types/model/PreviewUnstakeResponse.d.ts

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { ValidatorUnstakePreview } from './ValidatorUnstakePreview';
 /**
  * PreviewUnstakeResponse contains the response data from previewing an unstaking operation.
  */
@@ -25,4 +26,20 @@ export type PreviewUnstakeResponse = {
      * Estimated amount that would be unstaked
      */
     estimatedAmount: string;
+    /**
+     * The wallet ID
+     */
+    walletId?: string;
+    /**
+     * The blockchain address of the wallet
+     */
+    walletAddress?: string;
+    /**
+     * Timestamp at which this preview was generated (ISO 8601)
+     */
+    currentTimestamp?: string;
+    /**
+     * Per-validator breakdown of the unstake simulation
+     */
+    validators?: Array<ValidatorUnstakePreview>;
 };

package/dist/types/model/PrimeXMMarginCallThresholds.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+import { PrimeXMMarginThreshold } from './PrimeXMMarginThreshold';
+export type PrimeXMMarginCallThresholds = {
+    /**
+     * Deficit threshold (DT).
+     */
+    deficitThreshold?: string;
+    /**
+     * Warning threshold (WT).
+     */
+    warningThreshold?: string;
+    /**
+     * Urgent margin call threshold (UMCT).
+     */
+    criticalThreshold?: string;
+    /**
+     * Liquidation threshold (LT).
+     */
+    liquidationThreshold?: string;
+    /**
+     * Structured margin thresholds by margin level.
+     */
+    marginThresholds?: Array<PrimeXMMarginThreshold>;
+};

package/dist/types/model/PrimeXMMarginRequirementBreakdown.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2026-present Coinbase Global, Inc.
+ *
+ * This file is generated by Openapi Generator https://github.com/openapitools/openapi-generator
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  Do not edit the class manually.
+ */
+export type PrimeXMMarginRequirementBreakdown = {
+    /**
+     * Base margin requirement component.
+     */
+    baseMargin?: string;
+    /**
+     * Volatility add-on component.
+     */
+    volatilityAddon?: string;
+    /**
+     * Liquidity add-on component.
+     */
+    liquidityAddon?: string;
+    /**
+     * Credits that offset margin charges due to portfolio composition.
+     */
+    offsetCredit?: string;
+    /**
+     * Futures margin charge applied for any futures trades of the opposing direction but of the same underlying.
+     */
+    futuresMargin?: string;
+};

package/dist/types/model/{VASP.d.ts → PrimeXMMarginThreshold.d.ts}

@@ -17,11 +17,10 @@
  *
  *  Do not edit the class manually.
  */
-/**
- * Virtual Asset Service Provider (VASP).
- */
-export type VASP = {
-    id?: string;
-    countryCode?: string;
-    leiNumber?: string;
+import { PrimeXMMarginLevel } from './enums/PrimeXMMarginLevel';
+import { PrimeXMMarginThresholdType } from './enums/PrimeXMMarginThresholdType';
+export type PrimeXMMarginThreshold = {
+    marginLevel?: PrimeXMMarginLevel;
+    thresholdType?: PrimeXMMarginThresholdType;
+    thresholdValue?: string;
 };