Skip to content

CHANGELOG.md

Latest commit

 

History

History
538 lines (435 loc) · 28.5 KB

CHANGELOG.md

File metadata and controls

538 lines (435 loc) · 28.5 KB

Changelog

[1.10.0] - 2026-JUN-17

Added

New & Updated Models

  • CrossMarginPrimeDerivativesEquityBreakdown, CrossMarginPrimeRiskNettingInfo, CrossMarginPrimeSpotEquityBreakdown, CrossMarginPrimeXMPosition: Cross-margin Prime overview breakdown types
  • CustomStablecoinRewardDetails: Custom stablecoin reward metadata
  • PrimeXMMarginCallThresholds, PrimeXMMarginRequirementBreakdown, PrimeXMMarginThreshold, PrimeXMOffsetCreditBreakdown: Prime XM margin detail types
  • WalletStakingMetadata: Wallet staking metadata payload
  • DateOfBirth: Date-of-birth value type
  • Regenerated models include class and field Javadoc from OpenAPI title / description

New Enums

  • PrimeXMHealthStatus, PrimeXMMarginRequirementType, PrimeXMMarginThresholdType
  • XMControlStatus, XMEntityCallStatus, XMMarginLevel
  • ValidatorProvider: ETH validator service providers for staking unstake requests

Changed

  • Cross-margin model renames (update imports): XmLoan → XMLoan, XmMarginCall → XMMarginCall, XmPosition → XMPosition, XmRiskNettingInfo → XMRiskNettingInfo, XmSummary → XMSummary
  • Cross-margin enum renames (update imports): XmCallStatus → XMCallStatus, XmCallType → XMCallType, XmControlStatus → XMControlStatus, XmEntityCallStatus → XMEntityCallStatus, XmLiquidationStatus → XMLiquidationStatus, XmParty → XMParty
  • CreateStakeRequest / CreateUnstakeRequest: Added metadata (WalletStakingMetadata) for wallet staking initiate/unstake
  • PortfolioStakingUnstakeRequest: Added validatorProvider (ValidatorProvider) for portfolio unstake
  • Regenerated model/ and model/enums/ from the latest OpenAPI spec via restored tools/model-generator

Removed

  • TravelRuleEntry, TravelRuleWalletDetails, Vasp: Removed from the public OpenAPI spec
  • XmMarginLevel: Replaced by XMMarginLevel (wire values unchanged; update imports)
  • PositionsService.listAggregatePositions() / listPositions(): Use listAggregateEntityPositions() / listEntityPositions()
  • AdvancedTransferService.getPortfolioCounterpartyId(): Use PortfoliosService.getPortfolioCounterpartyId()
  • Unused legacy request/response types superseded by canonical names: ListUsersRequest/Response (use ListEntityUsersRequest/Response), CreateTransferRequest/Response (use CreateWalletTransferRequest/Response), CreateWithdrawalRequest/Response (use CreateWalletWithdrawalRequest/Response), CreatePortfolioStakeRequest/Response (use PortfolioStakingInitiateRequest/Response), CreatePortfolioUnstakeRequest/Response (use PortfolioStakingUnstakeRequest/Response), ClaimStakingRewardsRequest/Response (use ClaimRewardsRequest/Response), GetOrderRequest/Response (use GetOrderByOrderIdRequest/Response), ListAggregatePositionsRequest/Response, ListPositionsRequest/Response, advancedtransfer.GetPortfolioCounterpartyIdRequest/Response

Notes

  • Minor release: OpenAPI spec sync, regenerated models/enums, and service-layer request alignment. No new service methods.
  • Consumers on deprecated position/counterparty helpers or removed legacy types should migrate to the replacements listed above.

[1.9.0] - 2026-06-03

Changed

  • Moved the canonical repository to coinbase/prime-sdk-java.
  • Added GitHub Actions for format, lint, test, Salus security scan, and Maven Central publish.
  • Added .github/CODEOWNERS for @coinbase/prime-sdk-java-write and @coinbase/prime-sdk-java-admin.

Notes

  • No intentional API breaking changes; minor bump signals repository migration.
  • Spotless (Google Java Format) was introduced in 1.8.1; this release adds CI that runs spotless:check.
  • Equivalent to 1.8.0 on coinbase-samples aside from repository, tooling, and formatting.

[1.8.1] - 2026-06-03

Changed

  • Marked coinbase-samples/prime-sdk-java as deprecated in the README.
  • Documented migration to coinbase/prime-sdk-java and coinbase-prime-sdk-java 1.9.0+ on Maven Central.
  • Added Spotless (Google Java Format) and applied formatting across the codebase.

Notes

  • No intentional API changes.

[1.8.0] - 2026-MAY-13

Added

New API Endpoints

Financing Service

  • getCrossMarginPrimeOverview(): Cross-margin Prime overview; issues the request against API v2 via CoinbasePrimeClient.withBaseUrl(Constants.versionedBaseUrl(Constants.CB_PRIME_BASE_URL, "v2")) for this call only (GET /v2/entities/{entity_id}/cross_margin/prime)
  • getCrossMarginRiskParameters(): Cross-margin risk parameters (GET /entities/{entity_id}/cross_margin/risk_parameters)
  • updateFundingSettings(): Update entity funding settings (POST /entities/{entity_id}/funding_settings)
  • getMarketData(): Entity market data (GET /entities/{entity_id}/market_data)

Advanced Transfer Service

  • listAdvancedTransferTransactions(): List transactions for an advanced transfer (GET /portfolios/{portfolio_id}/advanced_transfers/{advanced_transfer_id}/transactions)

Note: GET /portfolios/{portfolio_id}/counterparty is surfaced as PortfoliosService.getPortfolioCounterpartyId() (canonical). The same helper on AdvancedTransferService remains for compatibility but is deprecated in favor of the portfolios API.

Positions Service

  • listAggregateEntityPositions(): Aggregate entity positions (GET /entities/{entity_id}/aggregate_positions)
  • listEntityPositions(): Entity positions (GET /entities/{entity_id}/positions)

Products Service

  • getCandles(): Public product candles (GET /portfolios/{portfolio_id}/candles)

New & Updated Models

  • CrossMarginPrimeMarginSummary: Margin summary on the cross-margin Prime overview
  • CrossMarginRiskParameters: Cross-margin risk parameters payload
  • MarketData: Entity market data
  • TierPairRateEntry: Trade-finance tier pair rate entry
  • CoinbasePrimeClient: withBaseUrl() for per-call base URL overrides (e.g. v2-only routes)
  • Constants: versionedBaseUrl() helper to swap the trailing /vN API segment
  • CreateOrderRequest: pegOffsetType uses PegOffsetType; build validation aligned with spec (no auto-generated client_order_id)

Deprecated

  • PositionsService.listAggregatePositions() / listPositions(): same routes as listAggregateEntityPositions() / listEntityPositions(); prefer the spec-aligned entity-named methods.
  • AdvancedTransferService.getPortfolioCounterpartyId(): prefer PortfoliosService.getPortfolioCounterpartyId() (same HTTP route).

Removed

  • tools/model-generator: removed; maintain models, requests, responses, and services against apiSpec/prime-public-spec.yaml
  • com.coinbase.prime.advancedtransfers package and AdvancedTransfersService: renamed to com.coinbase.prime.advancedtransfer and AdvancedTransferService; PrimeServiceFactory.createAdvancedTransfersService() replaced by createAdvancedTransferService()
  • TransactionsService.listAdvancedTransferTransactions(): use AdvancedTransferService.listAdvancedTransferTransactions()
  • AllocationsService.getPortfolioAllocations(): renamed to listPortfolioAllocations()
  • FinancingService.listTfObligations() with ListTfObligationsRequest / ListTfObligationsResponse: replaced by listTradeFinanceObligations() with ListTradeFinanceObligationsRequest / ListTradeFinanceObligationsResponse
  • FinancingService.listFinancingEligibleAssets(ListFinancingEligibleAssetsRequest): replaced by no-argument listFinancingEligibleAssets()
  • ProductsService.listCandles() with ListCandlesRequest / ListCandlesResponse: replaced by getCandles(), GetCandlesRequest, and GetCandlesResponse (standalone ListCandles* Java types removed)
  • Unused legacy types (ListAddressBookEntriesRequest/Response, ListAllocationsByClientNettingIdRequest/Response) superseded by the wired request/response classes on AddressBookService and AllocationsService

[1.7.1] - 2026-04-21

Added

New Models

  • ActiveLiquidationSummary - Active liquidation summary on cross-margin overview
  • ValidatorUnstakePreview - Per-validator unstake preview data

New Enums

  • XmLiquidationStatus - Cross-margin liquidation status

New Examples

  • GetCrossMarginOverviewExample - Entity cross-margin overview
  • ListMarginCallSummariesExample - Entity margin call summaries
  • GetPortfolioCreditInformationExample - Portfolio post-trade credit
  • ListEntityFuturesSweepsExample - Entity futures sweeps
  • GetStakingStatus - Wallet staking status

Changed

  • Model and types refresh from the Prime OpenAPI spec (https://api.prime.coinbase.com/v1/openapi.yaml). The experimental tools/model-generator workflow described here was removed in 1.8.0; newer releases maintain the SDK manually against apiSpec/prime-public-spec.yaml.- Regenerated com.coinbase.prime.model and model.enums from latest Prime OpenAPI spec (https://api.prime.coinbase.com/v1/openapi.yaml)
  • Model generator (PostProcessor): map GoogleTypeDate to DateOfBirth so TravelRuleParty.date_of_birth compiles when Google* types are excluded
  • ActivityMetadataConsensus, Asset, CreateAllocationResponseBody, CreateNetAllocationResponseBody, CrossMarginOverview, EvmParams, FcmTradingSessionDetails, FuturesSweep, MarginSummary, NetworkDetails, OnchainTransactionDetails, Order, PmAssetInfo, PostTradeCreditInformation, RequestToSubmitTravelRuleDataForAnExistingDepositTransaction, RfqProductDetails, RiskAssessment, RpcConfig, TravelRuleData, TravelRuleParty, XmPosition, XmRiskNettingInfo, UserRole - field updates per spec

Examples

  • GetOrderById, ListOrderEditHistory, ListOrderFills - when no order_id arg or COINBASE_PRIME_ORDER_ID, use first order from listPortfolioOrders (limit 1)

[1.7.0] - 2026-03-19

Added

New Services

  • Advanced Transfers Service (advancedtransfers package)
    • listAdvancedTransfers - List advanced transfers for an entity
    • createAdvancedTransfer - Create a new advanced transfer
    • cancelAdvancedTransfer - Cancel an existing advanced transfer

New Endpoints

  • Futures Service
    • getFcmEquity - Get FCM equity information for an entity
  • Transactions Service
    • getTransactionTravelRuleData - Get travel rule data for a transaction (moved from removed travelrule package)
    • listAdvancedTransferTransactions - List transactions associated with an advanced transfer

New Models

  • AdvancedTransfer - Advanced transfer details including state, type, and fund movements
  • BlindMatchMetadata - Metadata for blind match advanced transfers
  • CommissionDetailTotal - Commission detail totals for orders and fills
  • EntityUser - Entity user information
  • FcmScheduledMaintenance - FCM scheduled maintenance details
  • FcmTradingSessionDetails - FCM trading session information including state and maintenance schedules
  • FundMovement - Fund movement details within advanced transfers
  • FutureProductDetails - Futures product details including contract specifications
  • GoogleTypeDate - Date representation using Google's date type
  • PerpetualProductDetails - Perpetual product details
  • PortfolioUser - Portfolio user association data
  • RequestToSubmitTravelRuleDataForAnExistingDepositTransaction - Travel rule submission request model
  • ValidatorAllocation - Validator allocation details for staking

New Enums

  • AdvancedTransferState - Advanced transfer lifecycle states
  • AdvancedTransferType - Advanced transfer types (e.g., ADVANCED_TRANSFER_TYPE_BLIND_MATCH)
  • ContractExpiryType - Contract expiry types for futures products
  • ExpiringContractStatus - Status of expiring futures contracts
  • FcmMarginHealthState - FCM margin health states
  • FcmTradingSessionClosedReason - Reasons for FCM trading session closure
  • FcmTradingSessionState - FCM trading session states
  • ProductType - Product types (spot, futures, perpetuals, etc.)
  • RiskManagementType - Risk management types
  • SecondaryPermission - Secondary permission types

New Examples

  • GetTransactionTravelRuleData.java - Retrieve travel rule data for a transaction

Changed

  • Moved getTransactionTravelRuleData from TravelRuleService into TransactionsService; removed the travelrule package and PrimeServiceFactory.createTravelRuleService
  • Order - Added productType and commissionDetailTotal fields
  • Fill - Added productType and commissionDetailTotal fields
  • Product - Added productType, fcmTradingSessionDetails, and futureProductDetails fields
  • Boolean fields in generated models updated from Boolean wrapper to primitive boolean type

[1.6.2] - 2026-01-12

Added

New Endpoints

  • Transactions Service
    • submitDepositTravelRuleData - Submit travel rule data for deposit transactions (Beta)

New Models

  • TravelRuleData - Travel rule compliance data with beneficiary/originator info

Changed

  • CreateWalletWithdrawalRequest - Added travelRuleData field for withdrawal travel rule compliance
  • TravelRuleParty - Updated with additional fields for party details

[1.6.1] - 2025-12-18

Added

New Endpoints

  • Staking Service
    • previewUnstake - Preview unstaking operation to get estimated amounts
    • getUnstakingStatus - Get unstaking status and estimated completion times for validators
  • Futures Service
    • getFcmSettings - Get FCM settings including target derivatives excess
    • setFcmSettings - Update FCM settings
  • Financing Service
    • listTFObligations - List trade finance obligations for an entity
    • listFinancingEligibleAssets - List assets eligible for trade finance

New Models

  • ProcessRequirements - Travel rule status requirements for transactions
  • RewardMetadata - Staking reward metadata
  • TfAsset - Trade finance asset with adjustment factors
  • TFObligation - Trade finance obligation details
  • UnstakingStatus - Unstaking status with estimated completion times
  • ValidatorUnstakingInfo - Validator-specific unstaking information

New Enums

  • EstimateType - Estimate confidence types for unstaking
  • RewardSubtype - Reward subtypes for staking
  • TravelRuleStatus - Travel rule submission status
  • UnstakeType - Unstaking operation types

New Examples

  • Staking Examples (8 new)
    • PortfolioStakingInitiate.java
    • PortfolioStakingUnstake.java
    • CreateStake.java
    • CreateUnstake.java
    • ClaimRewards.java
    • ListTransactionValidators.java
    • PreviewUnstake.java
    • GetUnstakingStatus.java
  • Futures Examples (2 new)
    • GetFcmSettings.java
    • SetFcmSettings.java
  • Financing Examples (2 new)
    • ListTFObligations.java
    • ListFinancingEligibleAssets.java

Changed

  • Updated Order model with PEG order fields (pegOffsetType, offset, wigLevel)
  • Updated Transaction model with processRequirements field
  • Updated TransactionMetadata model with spec changes
  • Updated UserRole, XmCallType, XmEntityCallStatus enums with new values

[1.5.3] - 2025-11-05

Fixed

  • Fixed not passing request in GetWalletDepositInstructions

Added

  • Unit tests and examples for several endpoints

[1.5.2] - 2025-11-04

Changed

  • Updated Core-Java to 1.0.2 which includes support for deserializing advanced Java Time modules

Added

  • Unit tests for serialization/deserialization specifically around Orders as well as more general tests

[1.5.1] - 2025-10-30

Fixed

  • Fixed casing in FCM, XM, and PM class files due to git case sensitivity miss

[1.5.0] - 2025-10-28

Added

Orders Service - Advanced Order Type Support

  • CreateOrderRequest: Added support for advanced order types
    • settlCurrency - Settlement currency for futures contracts
    • postOnly - Post-only flag for maker-only LIMIT orders
    • pegOffsetType - Peg offset type for PEG orders
    • offset - Offset value for PEG orders (0 = peg to best bid/offer)
    • wigLevel - WIG (Would if Good) level for pegged orders
  • GetOrderPreviewRequest: Added same advanced order fields as CreateOrderRequest plus:
    • displayQuoteSize - Maximum order size visible on venue books (quote currency) for iceberg orders
    • displayBaseSize - Maximum order size visible on venue books (base currency) for iceberg orders
  • GetOrderPreviewResponse: Added isRaiseExact field for raise exact order flag
  • EditOrderRequest: Added iceberg and stop order support
    • displayQuoteSize - Display size for iceberg orders
    • displayBaseSize - Display size for iceberg orders
    • stopPrice - Stop price at which order activates

Futures Service

  • GetFcmRiskLimitsResponse: Added comprehensive FCM margin and PnL fields
    • cfmTotalMargin - Total margin required for both positions and open orders
    • cfmDeltaOte - Open Trade Equity accrued during current trading session
    • cfmUnsettledRealizedPnl - Unsettled realized PNL for positions closed intraday
    • cfmUnsettledAccruedFundingPnl - Unsettled accrued funding PNL from last settlement

Transactions Service

  • CreateConversionResponse: Added transactionId field - UUID of the conversion transaction

Wallets Service

  • CreateWalletResponse: Added networkFamily field for wallet network family
  • GetWalletDepositInstructionsResponse: Added proper JSON property annotations
    • @JsonProperty("crypto_instructions") for crypto deposit instructions
    • @JsonProperty("fiat_instructions") for fiat deposit instructions

Changed

Breaking Changes

  • GetCrossMarginOverviewResponse (Financing Service): Renamed field and methods for OpenAPI alignment
    • Field: crossMarginOverview → overview
    • JSON property: "cross_margin_overview" → "overview"
    • Getter: getCrossMarginOverview() → getOverview()
    • Setter: setCrossMarginOverview() → setOverview()

Fixed

  • Aligned all Request/Response classes with OpenAPI specification v0.1
  • Fixed missing optional fields across 11 classes in 5 services
  • Added 26 fields total to match OpenAPI spec completely
  • Fixed JSON property mappings for proper snake_case to camelCase conversion
  • Fixed acronym casing in model classes (XM* → Xm*, FCM* → Fcm*) to match Java naming conventions
  • Fixed field naming consistency across Request/Response classes
  • Corrected method signatures and naming:
    • getAllocationsByClientNettingId → listAllocationsByNettingId
    • Updated corresponding request/response classes: GetAllocationsByClientNettingIdRequest → ListAllocationsByNettingIdRequest
  • Fixed activity type enum: PrimeActivityType → CustodyActivityType
  • Removed nettingId field from CreateAllocationRequest to align with API specification

[1.4.0] - 2025-10-15

Added

OpenAPI Specification

  • Updated apiSpec/prime-public-spec.yaml to latest version
  • Reached 100% OpenAPI specification coverage (79/79 operations)
  • tools/model-generator/ - OpenAPI Generator integration for model generation

New Endpoints

  • Activities
    • getActivity - Get single activity by ID (renamed from getActivityByActivityId)
    • getPortfolioActivity - Get portfolio-specific activity
  • Assets
    • listEntityAssets - List assets for an entity
  • Futures
    • getFcmMarginCallDetails - Get FCM margin call details
    • getFcmRiskLimits - Get FCM risk limits
    • getPositions - Get entity positions (renamed from getEntityPositions)
  • Financing
    • getCrossMarginOverview - Get cross margin overview
  • Orders
    • editOrder - Edit an existing order
    • listOrderEditHistory - List order edit history
  • Payment Methods
    • getPaymentMethodDetails - Get detailed payment method information (renamed from getEntityPaymentMethod)
  • Portfolios
    • getPortfolio - Get portfolio by ID with new request structure
    • getPortfolioCounterpartyId - Get portfolio counterparty ID
    • listPortfolios - List portfolios with proper request object
  • Products
    • listCandles - List price candles for products
  • Staking
    • portfolioStakingInitiate - Initiate staking for portfolio
    • portfolioStakingUnstake - Unstake from portfolio
    • createStake - Create stake
    • createUnstake - Create unstake
    • claimRewards - Claim staking rewards
    • listTransactionValidators - List validators for transactions
  • Transactions
    • createWalletTransfer - Create wallet transfer
    • createWalletWithdrawal - Create wallet withdrawal
    • getTransaction - Get transaction by ID
  • Users
    • listEntityUsers - List users for an entity
  • Wallets
    • createWalletDepositAddress - Create deposit address for wallet
    • listWalletAddresses - List addresses for a wallet

New Models

  • Activities: ActivityMetadataAccount, ActivityMetadataConsensus, ActivityMetadataOrders, ActivityMetadataTransactions
  • Address Book: AddressBookConfiguration, AddressBookMetadata, AddressBookSummary, AddressEntry, TrustedAddressConfiguration
  • Allocations: AllocationRule, AllocationStrategy, CreateAllocationResponseBody, CreateNetAllocationResponseBody, DestinationAlloc
  • Commission: CommissionCalculation, CommissionRate
  • Futures: FcmBalance, FcmFuturesSweep, FcmFuturesSweepRequestAmount, FcmMarginCall, FcmMarginCallDetail, FcmPosition, FcmRiskLimit, FcmRiskLimits
  • Financing: ConversionDetail, CrossMarginOverview, ExistingLocate, MarginConversion, TradeFinanceFee, XMLoan, XMMarginCall, XMPosition, XMRiskNettingInfo, XMSummary
  • Orders: Fill, LimitOrderEdit, OrderEdit, QuoteResponse, RfqProductDetails
  • Payment Methods: PaymentMethodDestination, PaymentMethodDetails, PaymentMethodSummary
  • Portfolios: Counterparty, CounterpartyDestination, PortfolioStakingMetadata, PortfolioUser
  • Products: Candle
  • Staking: CreateStakeInputs, CreateUnstakeInputs, RewardsSummary, StakingBalance, StakingInitiateResponse, StakingPosition, StakingReward, StakingSummary, StakingUnstakeResponse, StakingYield, UnbondingEntry, ValidatorInfo, WalletClaimRewardsInputs, WalletStakeInputs, WalletUnstakeInputs
  • Transactions: OnchainTransactionDetails, OnchainTransactionMetadata, CreateOnchainTransactionEvmParams, CreateOnchainTransactionRequestEvmParams, TransactionMetadata, TransactionValidator
  • Wallets: AggregatedFiatBalance, DefiBalance, OnchainBalance, WalletBalance, WalletCryptoDepositInstructions, WalletFiatDepositInstructions
  • Common: PaginationCursor, RequestAmount, RpcConfig, VolumeDiscount

New Enums

  • Action, ActivityLevel, ActivityType, AddressBookCategory, AddressBookState, AddressValidationStatus, AllocationSizeType
  • CandlesGranularity, CommissionCategory, CommissionType
  • FcmFuturesSweepStatus, FcmMarginCallState, FcmMarginCallType, FcmPositionSide, FeeModel
  • HierarchyType, NetworkFamily, PortfolioBalanceType, PositionSide, PositionStatus, PositionType, ProductPermissions
  • SortDirection, StakingRewardType, StakingStatus
  • TimeInForceType, TrustedAddressLevel, UnbondingStatus, UserRole, ValidatorStatus, Visibility
  • WalletDepositInstructionType, WalletVisibility
  • XMCallStatus, XMCallType, XMControlStatus, XMEntityCallStatus, XMMarginLevel, XMParty

Tests

  • CoinbasePrimeCredentialsTest - Credentials validation tests
  • VersionHeaderIntegrationTest - SDK version header tests
  • ConstantsTest - Constants validation tests

Changed

Naming Conventions

  • Web3WalletAsset → OnchainAsset
  • Replaced "Web3" terminology with "Onchain" throughout codebase
  • Method renames:
    • getActivityByActivityId → getActivity
    • listActivities → listPortfolioActivities
    • getPortfolioAddressBook → listAddressBook
    • getEntityPositions → getPositions
    • getEntityPaymentMethod → getPaymentMethodDetails
    • listEntityPaymentMethods → listPaymentMethods
    • getPortfolioById → getPortfolio
    • getTransactionByTransactionId → getTransaction
    • createTransfer → createWalletTransfer
    • createWithdrawal → createWalletWithdrawal
    • listUsers → listEntityUsers
    • getWalletById → getWallet

Request/Response Class Renames

  • GetActivityByActivityIdRequest → GetActivityRequest
  • GetActivityByActivityIdResponse → GetPortfolioActivityResponse
  • GetEntityActivityByActivityIdResponse → GetActivityResponse
  • ListActivitiesRequest → ListPortfolioActivitiesRequest
  • ListActivitiesResponse → ListPortfolioActivitiesResponse
  • GetPortfolioAddressBookRequest → ListAddressBookRequest
  • GetPortfolioAddressBookResponse → ListAddressBookResponse
  • GetPortfolioAllocationsRequest → ListPortfolioAllocationsRequest
  • GetEntityPaymentMethodRequest → GetPaymentMethodDetailsRequest
  • GetEntityPaymentMethodResponse → GetPaymentMethodDetailsResponse
  • ListEntityPaymentMethodsRequest → ListPaymentMethodsRequest
  • GetPortfolioByIdRequest → GetPortfolioRequest
  • GetPortfolioByIdResponse → GetPortfolioResponse
  • GetEntityPositionsRequest → GetPositionsRequest
  • GetEntityPositionsResponse → GetPositionsResponse
  • GetTransactionByTransactionIdRequest → GetTransactionRequest
  • GetTransactionByTransactionIdResponse → GetTransactionResponse
  • CreateTransferRequest → CreateWalletTransferRequest
  • CreateTransferResponse → CreateWalletTransferResponse
  • CreateWithdrawalRequest → CreateWalletWithdrawalRequest
  • CreateWithdrawalResponse → CreateWalletWithdrawalResponse
  • ListUsersRequest → ListEntityUsersRequest
  • ListUsersResponse → ListEntityUsersResponse
  • GetWalletByIdRequest → GetWalletRequest
  • GetWalletByIdResponse → GetWalletResponse

Model Class Renames

  • AllocationDestination → DestinationAlloc
  • ConversionDetails → ConversionDetail
  • EntityPaymentMethod → PaymentMethodSummary
  • Web3WalletAsset → OnchainAsset

Models and Serialization

  • Updated request/response models with Jackson annotations
  • Added PaginationCursor for paginated responses
  • Updated model field names to match OpenAPI specification
  • Moved Pagination from com.coinbase.prime.model to com.coinbase.prime.common
  • Removed redundant response wrapper classes

Package Structure

  • Created onchainaddressbook package for onchain address book operations
  • Created common package for shared models like Pagination
  • Updated PrimeServiceFactory to include new services

Removed Classes

  • Models: AccountMetadata, Consensus, EvmParams, OnchainAddress, OnchainDetails, OrderFill (replaced by Fill), PaymentMethod, RequestedAmount (replaced by RequestAmount), Rpc, Sweep, TotalBalance, TransactionsMetadata, GetOrderPreviewResponse, OrdersMetadata, StakingInputs, FiatDepositInstructions
  • Enums: Role (replaced by UserRole), SizeType (replaced by AllocationSizeType), TimeInForce (replaced by TimeInForceType), UserActionType, BalanceType (replaced by PortfolioBalanceType), DepositType (replaced by WalletDepositInstructionType)

Fixed

  • Query parameter handling in list operations
  • Response deserialization for nested objects
  • Copyright headers

[1.3.0] - 2025-MAY-15

Added

  • Entity Endpoints
    • ListEntityBalances
    • ListAggregateEntityPositions
    • ListEntityPositions
  • Futures Endpoints
    • cancelEntityFuturesSweep
    • getEntityFcmBalance
    • getEntityPositions
    • listEntityFuturesSweeps
    • scheduleEntityFuturesSweeps
    • setAutoSweep
  • RFQ Endpoints
    • createQuoteRequest
    • acceptQuote
  • Prime Financing Endpoints
    • listExistingLocations
    • listInterestAccruals
    • listPortfolioInterestAccruals
    • listMarginCallSummaries
    • listMarginConversions
    • getEntityLocateAvailabilities
    • getMarginInformation
    • getPortfolioBuyingPower
    • getPortfolioCreditInformation
    • getPortfolioWithdrawalPower
    • getTieredPricingFees
    • createNewLocates
  • Prime Staking Endpoints
    • CreateStake
    • CreateUnstake
  • Moved all models to one communal package for easier export
  • Moved all Request/Response object to service specific package