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

package/dist/types/model/BetaCrossMarginPrimeXMPosition.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 BetaCrossMarginPrimeXMPosition = {
+    /**
+     * 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/BetaCrossMarginRiskParameters.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 BetaCrossMarginRiskParameters = {
+    /**
+     * 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/BetaGetCrossMarginPrimeOverviewResponse.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 { BetaCrossMarginPrimeMarginSummary } from './BetaCrossMarginPrimeMarginSummary';
+import { BetaPrimeXMControlStatus } from './enums/BetaPrimeXMControlStatus';
+import { BetaPrimeXMMarginLevel } from './enums/BetaPrimeXMMarginLevel';
+export type BetaGetCrossMarginPrimeOverviewResponse = {
+    controlStatus?: BetaPrimeXMControlStatus;
+    marginLevel?: BetaPrimeXMMarginLevel;
+    /**
+     * When margin metrics were evaluated.
+     */
+    evaluatedAt?: Date;
+    marginSummary?: BetaCrossMarginPrimeMarginSummary;
+};

package/dist/types/model/BetaGetCrossMarginRiskParametersResponse.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 { BetaCrossMarginRiskParameters } from './BetaCrossMarginRiskParameters';
+import { BetaTierPairRateEntry } from './BetaTierPairRateEntry';
+export type BetaGetCrossMarginRiskParametersResponse = {
+    /**
+     * Current XM tier risk parameters for the entity\'s client tier
+     */
+    riskParameters?: Array<BetaCrossMarginRiskParameters>;
+    /**
+     * Offset credit rate matrix for long/short tier pairs
+     */
+    offsetCreditMatrixLongShort?: Array<BetaTierPairRateEntry>;
+    /**
+     * Offset credit rate matrix for long/long tier pairs
+     */
+    offsetCreditMatrixLongLong?: Array<BetaTierPairRateEntry>;
+    /**
+     * Offset credit rate matrix for short/short tier pairs
+     */
+    offsetCreditMatrixShortShort?: Array<BetaTierPairRateEntry>;
+    /**
+     * Margin period of risk (number of days)
+     */
+    marginPeriodOfRisk?: number;
+};

package/dist/types/model/{DateOfBirth.d.ts → BetaGetMarketDataResponse.d.ts}

@@ -17,8 +17,12 @@
  *
  *  Do not edit the class manually.
  */
-export type DateOfBirth = {
-    year?: number;
-    month?: number;
-    day?: number;
+import { BetaMarketData } from './BetaMarketData';
+import { PaginatedResponse } from './PaginatedResponse';
+export type BetaGetMarketDataResponse = {
+    /**
+     * List of market data entries
+     */
+    marketData?: Array<BetaMarketData>;
+    pagination?: PaginatedResponse;
 };

package/dist/types/model/BetaMarketData.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 BetaMarketData = {
+    /**
+     * 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/BetaPrimeXMMarginCallThresholds.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 { BetaPrimeXMMarginThreshold } from './BetaPrimeXMMarginThreshold';
+export type BetaPrimeXMMarginCallThresholds = {
+    /**
+     * 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<BetaPrimeXMMarginThreshold>;
+};

package/dist/types/model/BetaPrimeXMMarginRequirementBreakdown.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 BetaPrimeXMMarginRequirementBreakdown = {
+    /**
+     * 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/{TravelRuleWalletDetails.d.ts → BetaPrimeXMMarginThreshold.d.ts}

@@ -17,12 +17,10 @@
  *
  *  Do not edit the class manually.
  */
-import { BlockchainAddress } from './BlockchainAddress';
-import { TravelRuleWalletType } from './enums/TravelRuleWalletType';
-/**
- * Details about the custody wallet used in the transfer.
- */
-export type TravelRuleWalletDetails = {
-    walletType?: TravelRuleWalletType;
-    walletAddress?: BlockchainAddress;
+import { BetaPrimeXMMarginLevel } from './enums/BetaPrimeXMMarginLevel';
+import { BetaPrimeXMMarginThresholdType } from './enums/BetaPrimeXMMarginThresholdType';
+export type BetaPrimeXMMarginThreshold = {
+    marginLevel?: BetaPrimeXMMarginLevel;
+    thresholdType?: BetaPrimeXMMarginThresholdType;
+    thresholdValue?: string;
 };

package/dist/types/model/BetaPrimeXMOffsetCreditBreakdown.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 BetaPrimeXMOffsetCreditBreakdown = {
+    /**
+     * Basis offset credit component.
+     */
+    basisCredit?: string;
+    /**
+     * Long/short tier-pair offset credit.
+     */
+    longShortCredit?: string;
+    /**
+     * Long/long tier-pair offset credit.
+     */
+    longLongCredit?: string;
+    /**
+     * Short/short tier-pair offset credit.
+     */
+    shortShortCredit?: string;
+    /**
+     * Same-tier offset credit.
+     */
+    sameTierCredit?: string;
+    /**
+     * Total offset credit.
+     */
+    totalCredit?: string;
+};

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * SetFundingSettingsResponse returns PCS activity metadata after the proposal is created.
+ */
+export type BetaSetFundingSettingsResponse = {
+    /**
+     * Identifier for the created activity / proposal
+     */
+    activityId?: string;
+    /**
+     * Type of the activity (e.g. PCS proposal type)
+     */
+    activityType?: string;
+    /**
+     * Number of approvals still required before the change applies
+     */
+    numApprovalsRemaining?: number;
+};

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

@@ -0,0 +1,36 @@
+/**
+ * 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.
+ */
+/**
+ * TierPairRateEntry represents a single (tier_a, tier_b) -> rate entry in an offset credit matrix.
+ */
+export type BetaTierPairRateEntry = {
+    /**
+     * First tier in the pair
+     */
+    tierA?: string;
+    /**
+     * Second tier in the pair
+     */
+    tierB?: string;
+    /**
+     * Credit rate for this tier pair
+     */
+    rate?: string;
+};

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

@@ -17,6 +17,7 @@
  *
  *  Do not edit the class manually.
  */
+import { ActiveLiquidationSummary } from './ActiveLiquidationSummary';
 import { XMControlStatus } from './enums/XMControlStatus';
 import { XMEntityCallStatus } from './enums/XMEntityCallStatus';
 import { XMLoan } from './XMLoan';
@@ -36,4 +37,5 @@ export type CrossMarginOverview = {
      * List of active XM loans
      */
     activeLoans?: Array<XMLoan>;
+    activeLiquidation?: ActiveLiquidationSummary;
 };

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

@@ -0,0 +1,40 @@
+/**
+ * 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 derivatives equity.
+ */
+export type CrossMarginPrimeDerivativesEquityBreakdown = {
+    /**
+     * Derivatives cash balance component.
+     */
+    cashBalance?: string;
+    /**
+     * Unrealized PnL component of derivatives equity.
+     */
+    unrealizedPnl?: string;
+    /**
+     * Realized PnL component of derivatives equity.
+     */
+    realizedPnl?: string;
+    /**
+     * Accrued funding PnL component of derivatives equity.
+     */
+    accruedFundingPnl?: string;
+};

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

@@ -0,0 +1,100 @@
+/**
+ * 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 { CrossMarginPrimeDerivativesEquityBreakdown } from './CrossMarginPrimeDerivativesEquityBreakdown';
+import { CrossMarginPrimeRiskNettingInfo } from './CrossMarginPrimeRiskNettingInfo';
+import { CrossMarginPrimeSpotEquityBreakdown } from './CrossMarginPrimeSpotEquityBreakdown';
+import { PrimeXMHealthStatus } from './enums/PrimeXMHealthStatus';
+import { PrimeXMMarginCallThresholds } from './PrimeXMMarginCallThresholds';
+import { PrimeXMMarginRequirementType } from './enums/PrimeXMMarginRequirementType';
+/**
+ * Cross-margin account summary and nested breakdowns.
+ */
+export type CrossMarginPrimeMarginSummary = {
+    /**
+     * Cross Margin Margin Requirement (XMMR) notional
+     */
+    marginRequirement?: string;
+    marginRequirementType?: PrimeXMMarginRequirementType;
+    /**
+     * Equity notional
+     */
+    accountEquity?: string;
+    /**
+     * Equity - XMMR (margin excess is > 0)
+     */
+    marginExcessShortfall?: string;
+    /**
+     * Credit consumed from Cross Margin Credit Limit (XMCL)
+     */
+    consumedCredit?: string;
+    /**
+     * XM Credit Limit (XMCL) is the maximum notional USD of total fiat and digital asset loans
+     */
+    xmCreditLimit?: string;
+    /**
+     * XM Margin Limit (XMML) is the maximum notional USD deficit
+     */
+    xmMarginLimit?: string;
+    /**
+     * Amount of the XM margin limit consumed by excess deficit.
+     */
+    consumedMarginLimit?: string;
+    /**
+     * Equity attributed by spot
+     */
+    spotEquity?: string;
+    /**
+     * Equity attributed by futures
+     */
+    futuresEquity?: string;
+    /**
+     * Gross market value.
+     */
+    grossMarketValue?: string;
+    /**
+     * Net market value.
+     */
+    netMarketValue?: string;
+    /**
+     * Net exposure.
+     */
+    netExposure?: string;
+    /**
+     * Gross leverage.
+     */
+    grossLeverage?: string;
+    spotEquityBreakdown?: CrossMarginPrimeSpotEquityBreakdown;
+    derivativesEquityBreakdown?: CrossMarginPrimeDerivativesEquityBreakdown;
+    riskNettingInfo?: CrossMarginPrimeRiskNettingInfo;
+    healthStatus?: PrimeXMHealthStatus;
+    /**
+     * Equity ratio.
+     */
+    equityRatio?: string;
+    /**
+     * Deficit ratio.
+     */
+    deficitRatio?: string;
+    marginThresholds?: PrimeXMMarginCallThresholds;
+    /**
+     * FCM excess available to return.
+     */
+    fcmExcessAvailableToReturn?: string;
+};