diff --git a/.github/workflows/create-pr.yml b/.github/workflows/create-pr.yml
deleted file mode 100644
index 86ab898a..00000000
--- a/.github/workflows/create-pr.yml
+++ /dev/null
@@ -1,25 +0,0 @@
-name: Create Pull Request
-
-on:
- push:
- branches:
- - 'fireblocks-api-spec/generated/*'
-
-jobs:
- create-pull-request:
- runs-on: ubuntu-latest
-
- steps:
- - name: Check out repository code
- uses: actions/checkout@v4
-
- - name: Create pull request
- run: |
- gh pr create \
- --title "${{ github.event.commits[0].message }}" \
- --body "This PR was automatically generated." \
- --base master \
- --head ${{ github.ref }} \
- --reviewer asafs932,YoavBZ
- env:
- GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/publish-maven.yml b/.github/workflows/publish-maven.yml
index 065db401..a68ef7e5 100644
--- a/.github/workflows/publish-maven.yml
+++ b/.github/workflows/publish-maven.yml
@@ -8,10 +8,17 @@ jobs:
bump-version:
runs-on: ubuntu-latest
steps:
+ - name: Generate GitHub App token
+ id: generate-token
+ uses: actions/create-github-app-token@v2
+ with:
+ app-id: ${{ vars.SDK_GENERATION_APP_ID }}
+ private-key: ${{ secrets.SDK_GENERATION_APP_PRIVATE_KEY }}
+
- name: Check out repository code
uses: actions/checkout@v4
with:
- token: ${{ secrets.RELEASE_TOKEN }}
+ token: ${{ steps.generate-token.outputs.token }}
- name: Set up Python
uses: actions/setup-python@v2
with:
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
index dcbbdc02..fad4ea45 100644
--- a/.openapi-generator/FILES
+++ b/.openapi-generator/FILES
@@ -11,6 +11,9 @@ build.sbt
docs/APIUser.md
docs/AbaPaymentInfo.md
docs/AbiFunction.md
+docs/AccessRegistryAddressItem.md
+docs/AccessRegistryCurrentStateResponse.md
+docs/AccessRegistrySummaryResponse.md
docs/AccessType.md
docs/Account.md
docs/AccountAccess.md
@@ -20,7 +23,6 @@ docs/AccountBasedAccessProviderDetails.md
docs/AccountConfig.md
docs/AccountHolderDetails.md
docs/AccountIdentifier.md
-docs/AccountProviderID.md
docs/AccountReference.md
docs/AccountType.md
docs/AccountType2.md
@@ -40,6 +42,8 @@ docs/AddExchangeAccountResponse.md
docs/AdditionalInfo.md
docs/AdditionalInfoRequest.md
docs/AdditionalInfoRequestAdditionalInfo.md
+docs/AddressBalanceItemDto.md
+docs/AddressBalancePagedResponse.md
docs/AddressNotAvailableError.md
docs/AlertExposureTypeEnum.md
docs/AlertLevelEnum.md
@@ -63,6 +67,7 @@ docs/AmountRangeMinMax2.md
docs/ApiKey.md
docs/ApiKeysPaginatedResponse.md
docs/ApiUserApi.md
+docs/ApprovalRequest.md
docs/ApproversConfig.md
docs/ApproversConfigApprovalGroupsInner.md
docs/Asset.md
@@ -91,18 +96,23 @@ docs/AssetPriceNotFoundErrorResponse.md
docs/AssetPriceResponse.md
docs/AssetResponse.md
docs/AssetScope.md
+docs/AssetTypeEnum.md
docs/AssetTypeResponse.md
docs/AssetTypesConfigInner.md
docs/AssetWallet.md
-docs/AssetsApi.md
docs/AuditLogData.md
docs/AuditLogsApi.md
docs/AuditorData.md
docs/AuthorizationGroups.md
docs/AuthorizationInfo.md
+docs/BalanceHistoryItemDto.md
+docs/BalanceHistoryPagedResponse.md
+docs/BankAddress.md
docs/BaseProvider.md
docs/BasicAddressRequest.md
docs/BlockInfo.md
+docs/BlockchainAddress.md
+docs/BlockchainDestination.md
docs/BlockchainExplorer.md
docs/BlockchainMedia.md
docs/BlockchainMetadata.md
@@ -112,6 +122,7 @@ docs/BlockchainResponse.md
docs/BlockchainTransfer.md
docs/BlockchainsAssetsApi.md
docs/BpsFee.md
+docs/BusinessEntityTypeEnum.md
docs/BusinessIdentification.md
docs/CallbackHandler.md
docs/CallbackHandlerRequest.md
@@ -132,6 +143,7 @@ docs/CollectionOwnershipResponse.md
docs/CollectionTokenMetadataAttributeDto.md
docs/CollectionTokenMetadataDto.md
docs/CollectionType.md
+docs/CommittedQuoteEnum.md
docs/CommittedQuoteType.md
docs/ComplianceApi.md
docs/ComplianceResultFullPayload.md
@@ -153,6 +165,7 @@ docs/ConnectedAccountAssetType.md
docs/ConnectedAccountBalances.md
docs/ConnectedAccountBalancesResponse.md
docs/ConnectedAccountCapability.md
+docs/ConnectedAccountErrorResponse.md
docs/ConnectedAccountManifest.md
docs/ConnectedAccountRateResponse.md
docs/ConnectedAccountTotalBalance.md
@@ -167,6 +180,7 @@ docs/ConsoleUser.md
docs/ConsoleUserApi.md
docs/ContractAbiResponseDto.md
docs/ContractAbiResponseDtoAbiInner.md
+docs/ContractAddressResponse.md
docs/ContractAttributes.md
docs/ContractDataDecodeDataType.md
docs/ContractDataDecodeError.md
@@ -206,7 +220,6 @@ docs/CosignersPaginatedResponse.md
docs/CreateAPIUser.md
docs/CreateAddressRequest.md
docs/CreateAddressResponse.md
-docs/CreateAssetsBulkRequest.md
docs/CreateAssetsRequest.md
docs/CreateConfigOperationRequest.md
docs/CreateConnectionRequest.md
@@ -247,8 +260,11 @@ docs/CreateWorkflowExecutionRequestParamsInner.md
docs/CustomRoutingDest.md
docs/DAppAddressConfig.md
docs/DVPSettlement.md
+docs/DVPSettlementType.md
+docs/DecodedLog.md
docs/DefaultNetworkRoutingDest.md
docs/Delegation.md
+docs/DelegationBlockchainPositionInfo.md
docs/DelegationSummary.md
docs/DeleteNetworkConnectionResponse.md
docs/DeleteNetworkIdResponse.md
@@ -307,16 +323,23 @@ docs/EmbeddedWalletLatestBackupKey.md
docs/EmbeddedWalletLatestBackupResponse.md
docs/EmbeddedWalletPaginatedAddressesResponse.md
docs/EmbeddedWalletPaginatedAssetsResponse.md
+docs/EmbeddedWalletPaginatedDevicesResponse.md
docs/EmbeddedWalletPaginatedWalletsResponse.md
+docs/EmbeddedWalletRequiredAlgorithms.md
docs/EmbeddedWalletSetUpStatus.md
+docs/EmbeddedWalletSetupStatusResponse.md
docs/EmbeddedWalletsApi.md
-docs/ErrorCodes.md
+docs/EnableDevice.md
+docs/EnableWallet.md
docs/ErrorResponse.md
docs/ErrorResponseError.md
docs/ErrorSchema.md
docs/EstimatedFeeDetails.md
docs/EstimatedNetworkFeeResponse.md
docs/EstimatedTransactionFeeResponse.md
+docs/EthereumBlockchainData.md
+docs/EuropeanSEPAAddress.md
+docs/EuropeanSEPADestination.md
docs/ExchangeAccount.md
docs/ExchangeAccountsApi.md
docs/ExchangeAsset.md
@@ -331,15 +354,22 @@ docs/ExecutionRequestDetails.md
docs/ExecutionResponseBaseDetails.md
docs/ExecutionResponseDetails.md
docs/ExecutionScreeningOperation.md
-docs/ExecutionStep.md
-docs/ExecutionStepDetails.md
docs/ExecutionStepError.md
docs/ExecutionStepStatusEnum.md
docs/ExecutionStepType.md
docs/ExecutionTransferOperation.md
docs/ExternalAccount.md
+docs/ExternalAccountLocalBankAfrica.md
+docs/ExternalAccountLocalBankAfricaType.md
+docs/ExternalAccountMobileMoney.md
+docs/ExternalAccountMobileMoneyProvider.md
+docs/ExternalAccountMobileMoneyType.md
+docs/ExternalAccountSenderInformation.md
+docs/ExternalAccountType.md
docs/ExternalWalletAsset.md
docs/ExternalWalletsApi.md
+docs/Failure.md
+docs/FailureReason.md
docs/Fee.md
docs/FeeBreakdown.md
docs/FeeBreakdownOneOf.md
@@ -348,13 +378,16 @@ docs/FeeInfo.md
docs/FeeLevel.md
docs/FeePayerInfo.md
docs/FeePropertiesDetails.md
+docs/FeeTypeEnum.md
docs/FetchAbiRequestDto.md
docs/FiatAccount.md
docs/FiatAccountType.md
docs/FiatAccountsApi.md
docs/FiatAsset.md
docs/FiatDestination.md
+docs/FiatPaymentMetadata.md
docs/FiatTransfer.md
+docs/FixedAmountTypeEnum.md
docs/FixedFee.md
docs/FreezeTransactionResponse.md
docs/FunctionDoc.md
@@ -375,6 +408,7 @@ docs/GetFilterParameter.md
docs/GetLayerZeroDvnConfigResponse.md
docs/GetLayerZeroPeersResponse.md
docs/GetLinkedCollectionsPaginatedResponse.md
+docs/GetMaxBipIndexUsedResponse.md
docs/GetMaxSpendableAmountResponse.md
docs/GetMpcKeysResponse.md
docs/GetNFTsResponse.md
@@ -394,6 +428,7 @@ docs/IbanDestination.md
docs/IbanPaymentInfo.md
docs/Identification.md
docs/IdlType.md
+docs/IndicativeQuoteEnum.md
docs/IndicativeQuoteType.md
docs/InitiatorConfig.md
docs/InitiatorConfigPattern.md
@@ -402,9 +437,7 @@ docs/InternalReference.md
docs/InternalTransferResponse.md
docs/InternalWalletsApi.md
docs/InvalidParamaterValueError.md
-docs/Job.md
docs/JobCreated.md
-docs/JobManagementApi.md
docs/KeyLinkBetaApi.md
docs/KeysBetaApi.md
docs/LayerZeroAdapterCreateParams.md
@@ -440,9 +473,7 @@ docs/LegacyPolicyValidation.md
docs/LegacyPublishDraftRequest.md
docs/LegacyPublishResult.md
docs/LegacySrcOrDestAttributesInner.md
-docs/LimitExecutionRequestDetails.md
-docs/LimitExecutionResponseDetails.md
-docs/LimitTypeDetails.md
+docs/LinkedTokensCount.md
docs/ListAssetsResponse.md
docs/ListBlockchainsResponse.md
docs/ListOwnedCollectionsResponse.md
@@ -453,7 +484,9 @@ docs/Manifest.md
docs/MarketExecutionRequestDetails.md
docs/MarketExecutionResponseDetails.md
docs/MarketRequoteRequestDetails.md
+docs/MarketRequoteTypeEnum.md
docs/MarketTypeDetails.md
+docs/MarketTypeEnum.md
docs/MediaEntityResponse.md
docs/MergeStakeAccountsRequest.md
docs/MergeStakeAccountsResponse.md
@@ -487,11 +520,16 @@ docs/NotificationPaginatedResponse.md
docs/NotificationStatus.md
docs/NotificationWithData.md
docs/OffExchangesApi.md
+docs/OnchainDataApi.md
+docs/OnchainTransaction.md
+docs/OnchainTransactionsPagedResponse.md
docs/OneTimeAddress.md
docs/OneTimeAddressAccount.md
+docs/OneTimeAddressPeerType.md
docs/OneTimeAddressReference.md
docs/OperationExecutionFailure.md
docs/OrderDetails.md
+docs/OrderExecutionStep.md
docs/OrderSide.md
docs/OrderStatus.md
docs/OrderSummary.md
@@ -515,7 +553,7 @@ docs/PaymentAccount.md
docs/PaymentAccountResponse.md
docs/PaymentAccountType.md
docs/PaymentInstructions.md
-docs/PaymentInstructionsDetails.md
+docs/PaymentInstructionsOneOf.md
docs/PaymentsPayoutApi.md
docs/PayoutInitMethod.md
docs/PayoutInstruction.md
@@ -526,12 +564,14 @@ docs/PayoutState.md
docs/PayoutStatus.md
docs/PeerAdapterInfo.md
docs/PeerType.md
+docs/PersonalEntityTypeEnum.md
docs/PersonalIdentification.md
docs/PersonalIdentificationFullName.md
docs/PixAddress.md
docs/PixDestination.md
docs/PixPaymentInfo.md
docs/PlatformAccount.md
+docs/PlatformPeerType.md
docs/Players.md
docs/PolicyAndValidationResponse.md
docs/PolicyCheckResult.md
@@ -550,24 +590,24 @@ docs/PolicyType.md
docs/PolicyValidation.md
docs/PolicyVerdictActionEnum.md
docs/PolicyVerdictActionEnum2.md
-docs/PostOrderSettlement.md
docs/PostalAddress.md
docs/PreScreening.md
docs/PrefundedSettlement.md
+docs/PrefundedSettlementType.md
docs/ProgramCallConfig.md
docs/Provider.md
-docs/ProviderID.md
docs/ProvidersListResponse.md
docs/PublicKeyInformation.md
docs/PublishDraftRequest.md
docs/PublishResult.md
docs/Quote.md
docs/QuoteExecutionRequestDetails.md
-docs/QuoteExecutionResponseDetails.md
+docs/QuoteExecutionStep.md
docs/QuoteExecutionTypeDetails.md
docs/QuoteExecutionWithRequoteRequestDetails.md
docs/QuoteExecutionWithRequoteResponseDetails.md
docs/QuotePropertiesDetails.md
+docs/QuoteTypeEnum.md
docs/QuotesResponse.md
docs/ReQuoteDetails.md
docs/ReQuoteDetailsReQuote.md
@@ -585,9 +625,10 @@ docs/RemoveLayerZeroAdaptersRequest.md
docs/RemoveLayerZeroAdaptersResponse.md
docs/RemoveLayerZeroPeersRequest.md
docs/RemoveLayerZeroPeersResponse.md
+docs/RenameConnectedAccountRequest.md
+docs/RenameConnectedAccountResponse.md
docs/RenameCosigner.md
docs/RenameVaultAccountResponse.md
-docs/RescanTransaction.md
docs/ResendFailedNotificationsJobStatusResponse.md
docs/ResendFailedNotificationsRequest.md
docs/ResendFailedNotificationsResponse.md
@@ -598,12 +639,16 @@ docs/ResendWebhooksResponse.md
docs/ResetDeviceApi.md
docs/RespondToConnectionRequest.md
docs/RetryRequoteRequestDetails.md
+docs/RetryRequoteTypeEnum.md
docs/RewardInfo.md
docs/RewardsInfo.md
+docs/RoleDetails.md
+docs/RoleGrantee.md
docs/SEPAAddress.md
docs/SEPADestination.md
docs/SOLAccount.md
docs/SOLAccountWithValue.md
+docs/ScopeItem.md
docs/ScreeningAlertExposureTypeEnum.md
docs/ScreeningAmlAlert.md
docs/ScreeningAmlMatchedRule.md
@@ -660,6 +705,7 @@ docs/Settlement.md
docs/SettlementRequestBody.md
docs/SettlementResponse.md
docs/SettlementSourceAccount.md
+docs/Side.md
docs/SignedMessage.md
docs/SignedMessageSignature.md
docs/SigningKeyDto.md
@@ -707,27 +753,70 @@ docs/SpeiBasicPaymentInfo.md
docs/SpeiDestination.md
docs/SplitRequest.md
docs/SplitResponse.md
+docs/StEthBlockchainData.md
docs/StakeRequest.md
docs/StakeResponse.md
docs/StakingApi.md
docs/StakingProvider.md
docs/Status.md
docs/StellarRippleCreateParamsDto.md
+docs/SupportedBlockChainsResponse.md
+docs/SupportedBlockchain.md
docs/SwiftAddress.md
docs/SwiftDestination.md
docs/SystemMessageInfo.md
+docs/TRLinkAPIPagedResponse.md
docs/TRLinkAmount.md
+docs/TRLinkAmount2.md
+docs/TRLinkAmountRange.md
+docs/TRLinkAssessTravelRuleRequest.md
+docs/TRLinkAssessTravelRuleResponse.md
+docs/TRLinkAssessmentDecision.md
+docs/TRLinkAsset.md
+docs/TRLinkAssetData.md
+docs/TRLinkAssetFormat.md
+docs/TRLinkAssetsListPagedResponse.md
+docs/TRLinkCancelTrmRequest.md
+docs/TRLinkConnectIntegrationRequest.md
+docs/TRLinkCreateCustomerRequest.md
+docs/TRLinkCreateIntegrationRequest.md
+docs/TRLinkCreateTrmRequest.md
+docs/TRLinkCurrency.md
+docs/TRLinkCustomerIntegrationResponse.md
+docs/TRLinkCustomerResponse.md
+docs/TRLinkDestinationTransferPeerPath.md
+docs/TRLinkDiscoverableStatus.md
+docs/TRLinkFiatValue.md
+docs/TRLinkGeographicAddressRequest.md
+docs/TRLinkGetSupportedAssetResponse.md
+docs/TRLinkIvms.md
+docs/TRLinkIvmsResponse.md
+docs/TRLinkJwkPublicKey.md
docs/TRLinkMissingTrmAction.md
+docs/TRLinkMissingTrmAction2.md
docs/TRLinkMissingTrmActionEnum.md
docs/TRLinkMissingTrmDecision.md
docs/TRLinkMissingTrmRule.md
+docs/TRLinkMissingTrmRule2.md
+docs/TRLinkOneTimeAddress.md
+docs/TRLinkPaging.md
+docs/TRLinkPartnerResponse.md
+docs/TRLinkPolicyResponse.md
+docs/TRLinkPostScreeningAction.md
docs/TRLinkPostScreeningRule.md
+docs/TRLinkPostScreeningRule2.md
docs/TRLinkPreScreeningAction.md
+docs/TRLinkPreScreeningAction2.md
docs/TRLinkPreScreeningActionEnum.md
docs/TRLinkPreScreeningRule.md
+docs/TRLinkPreScreeningRule2.md
+docs/TRLinkProviderData.md
docs/TRLinkProviderResult.md
docs/TRLinkProviderResultWithRule.md
docs/TRLinkProviderResultWithRule2.md
+docs/TRLinkPublicAssetInfo.md
+docs/TRLinkPublicKeyResponse.md
+docs/TRLinkRedirectTrmRequest.md
docs/TRLinkRegistrationResult.md
docs/TRLinkRegistrationResultFullPayload.md
docs/TRLinkRegistrationStatus.md
@@ -735,23 +824,40 @@ docs/TRLinkRegistrationStatusEnum.md
docs/TRLinkResult.md
docs/TRLinkResultFullPayload.md
docs/TRLinkRuleBase.md
+docs/TRLinkSetDestinationTravelRuleMessageIdRequest.md
+docs/TRLinkSetDestinationTravelRuleMessageIdResponse.md
+docs/TRLinkSetTransactionTravelRuleMessageIdRequest.md
+docs/TRLinkSetTransactionTravelRuleMessageIdResponse.md
+docs/TRLinkSourceTransferPeerPath.md
+docs/TRLinkTestConnectionResponse.md
+docs/TRLinkThresholds.md
+docs/TRLinkTransactionDirection.md
+docs/TRLinkTransferPeerPath.md
+docs/TRLinkTrmDirection.md
+docs/TRLinkTrmInfoResponse.md
docs/TRLinkTrmScreeningStatus.md
docs/TRLinkTrmScreeningStatusEnum.md
+docs/TRLinkTrmStatus.md
+docs/TRLinkTxnInfo.md
+docs/TRLinkUpdateCustomerRequest.md
+docs/TRLinkVaspDto.md
+docs/TRLinkVaspGeographicAddress.md
+docs/TRLinkVaspListDto.md
+docs/TRLinkVaspNationalIdentification.md
docs/TRLinkVerdict.md
docs/TRLinkVerdictEnum.md
docs/Tag.md
docs/TagAttachmentOperationAction.md
docs/TagsApi.md
docs/TagsPagedResponse.md
-docs/Task.md
docs/TemplatesPaginatedResponse.md
docs/ThirdPartyRouting.md
-docs/TimeInForce.md
docs/TimePeriodConfig.md
docs/TimePeriodMatchType.md
docs/ToCollateralTransaction.md
docs/ToExchangeTransaction.md
docs/TokenCollectionResponse.md
+docs/TokenContractSummaryResponse.md
docs/TokenInfoNotFoundErrorResponse.md
docs/TokenLinkDto.md
docs/TokenLinkDtoTokenMetadata.md
@@ -764,10 +870,12 @@ docs/TokenOwnershipStatusUpdatePayload.md
docs/TokenResponse.md
docs/TokenizationApi.md
docs/TokensPaginatedResponse.md
+docs/TotalSupplyItemDto.md
+docs/TotalSupplyPagedResponse.md
+docs/TrLinkApi.md
docs/TradingAccountType.md
docs/TradingBetaApi.md
-docs/TradingErrorResponse.md
-docs/TradingErrorResponseError.md
+docs/TradingErrorSchema.md
docs/TradingProvider.md
docs/Transaction.md
docs/TransactionDirection.md
@@ -848,7 +956,11 @@ docs/TravelRuleValidateTransactionRequest.md
docs/TravelRuleValidateTransactionResponse.md
docs/TravelRuleVaspForVault.md
docs/TravelRuleVerdictEnum.md
+docs/TrustProofOfAddressCreateResponse.md
+docs/TrustProofOfAddressRequest.md
+docs/TrustProofOfAddressResponse.md
docs/TxLog.md
+docs/TypedMessageTransactionStatusEnum.md
docs/USWireAddress.md
docs/USWireDestination.md
docs/UnfreezeTransactionResponse.md
@@ -878,7 +990,6 @@ docs/UserType.md
docs/UsersApi.md
docs/ValidateAddressResponse.md
docs/ValidateLayerZeroChannelResponse.md
-docs/ValidatedTransactionsForRescan.md
docs/ValidationKeyDto.md
docs/Validator.md
docs/VaultAccount.md
@@ -889,14 +1000,13 @@ docs/VaultAccountsPagedResponse.md
docs/VaultAccountsPagedResponsePaging.md
docs/VaultAccountsTagAttachmentOperationsRequest.md
docs/VaultAccountsTagAttachmentOperationsResponse.md
-docs/VaultAccountsTagAttachmentsRequest.md
docs/VaultActionStatus.md
docs/VaultAsset.md
docs/VaultWalletAddress.md
docs/VaultsApi.md
docs/VendorDto.md
docs/VerdictConfig.md
-docs/Version.md
+docs/VersionSummary.md
docs/WalletAsset.md
docs/WalletAssetAdditionalInfo.md
docs/Web3ConnectionsApi.md
@@ -945,7 +1055,6 @@ src/main/java/com/fireblocks/sdk/SystemWrapper.java
src/main/java/com/fireblocks/sdk/UserAgentUtil.java
src/main/java/com/fireblocks/sdk/ValidationUtils.java
src/main/java/com/fireblocks/sdk/api/ApiUserApi.java
-src/main/java/com/fireblocks/sdk/api/AssetsApi.java
src/main/java/com/fireblocks/sdk/api/AuditLogsApi.java
src/main/java/com/fireblocks/sdk/api/BlockchainsAssetsApi.java
src/main/java/com/fireblocks/sdk/api/ComplianceApi.java
@@ -963,12 +1072,12 @@ src/main/java/com/fireblocks/sdk/api/ExternalWalletsApi.java
src/main/java/com/fireblocks/sdk/api/FiatAccountsApi.java
src/main/java/com/fireblocks/sdk/api/GasStationsApi.java
src/main/java/com/fireblocks/sdk/api/InternalWalletsApi.java
-src/main/java/com/fireblocks/sdk/api/JobManagementApi.java
src/main/java/com/fireblocks/sdk/api/KeyLinkBetaApi.java
src/main/java/com/fireblocks/sdk/api/KeysBetaApi.java
src/main/java/com/fireblocks/sdk/api/NetworkConnectionsApi.java
src/main/java/com/fireblocks/sdk/api/NftsApi.java
src/main/java/com/fireblocks/sdk/api/OffExchangesApi.java
+src/main/java/com/fireblocks/sdk/api/OnchainDataApi.java
src/main/java/com/fireblocks/sdk/api/OtaBetaApi.java
src/main/java/com/fireblocks/sdk/api/PaymentsPayoutApi.java
src/main/java/com/fireblocks/sdk/api/PolicyEditorBetaApi.java
@@ -978,6 +1087,7 @@ src/main/java/com/fireblocks/sdk/api/SmartTransferApi.java
src/main/java/com/fireblocks/sdk/api/StakingApi.java
src/main/java/com/fireblocks/sdk/api/TagsApi.java
src/main/java/com/fireblocks/sdk/api/TokenizationApi.java
+src/main/java/com/fireblocks/sdk/api/TrLinkApi.java
src/main/java/com/fireblocks/sdk/api/TradingBetaApi.java
src/main/java/com/fireblocks/sdk/api/TransactionsApi.java
src/main/java/com/fireblocks/sdk/api/TravelRuleApi.java
@@ -993,6 +1103,9 @@ src/main/java/com/fireblocks/sdk/model/APIUser.java
src/main/java/com/fireblocks/sdk/model/AbaPaymentInfo.java
src/main/java/com/fireblocks/sdk/model/AbiFunction.java
src/main/java/com/fireblocks/sdk/model/AbstractOpenApiSchema.java
+src/main/java/com/fireblocks/sdk/model/AccessRegistryAddressItem.java
+src/main/java/com/fireblocks/sdk/model/AccessRegistryCurrentStateResponse.java
+src/main/java/com/fireblocks/sdk/model/AccessRegistrySummaryResponse.java
src/main/java/com/fireblocks/sdk/model/AccessType.java
src/main/java/com/fireblocks/sdk/model/Account.java
src/main/java/com/fireblocks/sdk/model/AccountAccess.java
@@ -1002,7 +1115,6 @@ src/main/java/com/fireblocks/sdk/model/AccountBasedAccessProviderDetails.java
src/main/java/com/fireblocks/sdk/model/AccountConfig.java
src/main/java/com/fireblocks/sdk/model/AccountHolderDetails.java
src/main/java/com/fireblocks/sdk/model/AccountIdentifier.java
-src/main/java/com/fireblocks/sdk/model/AccountProviderID.java
src/main/java/com/fireblocks/sdk/model/AccountReference.java
src/main/java/com/fireblocks/sdk/model/AccountType.java
src/main/java/com/fireblocks/sdk/model/AccountType2.java
@@ -1022,6 +1134,8 @@ src/main/java/com/fireblocks/sdk/model/AddExchangeAccountResponse.java
src/main/java/com/fireblocks/sdk/model/AdditionalInfo.java
src/main/java/com/fireblocks/sdk/model/AdditionalInfoRequest.java
src/main/java/com/fireblocks/sdk/model/AdditionalInfoRequestAdditionalInfo.java
+src/main/java/com/fireblocks/sdk/model/AddressBalanceItemDto.java
+src/main/java/com/fireblocks/sdk/model/AddressBalancePagedResponse.java
src/main/java/com/fireblocks/sdk/model/AddressNotAvailableError.java
src/main/java/com/fireblocks/sdk/model/AlertExposureTypeEnum.java
src/main/java/com/fireblocks/sdk/model/AlertLevelEnum.java
@@ -1044,6 +1158,7 @@ src/main/java/com/fireblocks/sdk/model/AmountRangeMinMax.java
src/main/java/com/fireblocks/sdk/model/AmountRangeMinMax2.java
src/main/java/com/fireblocks/sdk/model/ApiKey.java
src/main/java/com/fireblocks/sdk/model/ApiKeysPaginatedResponse.java
+src/main/java/com/fireblocks/sdk/model/ApprovalRequest.java
src/main/java/com/fireblocks/sdk/model/ApproversConfig.java
src/main/java/com/fireblocks/sdk/model/ApproversConfigApprovalGroupsInner.java
src/main/java/com/fireblocks/sdk/model/Asset.java
@@ -1072,6 +1187,7 @@ src/main/java/com/fireblocks/sdk/model/AssetPriceNotFoundErrorResponse.java
src/main/java/com/fireblocks/sdk/model/AssetPriceResponse.java
src/main/java/com/fireblocks/sdk/model/AssetResponse.java
src/main/java/com/fireblocks/sdk/model/AssetScope.java
+src/main/java/com/fireblocks/sdk/model/AssetTypeEnum.java
src/main/java/com/fireblocks/sdk/model/AssetTypeResponse.java
src/main/java/com/fireblocks/sdk/model/AssetTypesConfigInner.java
src/main/java/com/fireblocks/sdk/model/AssetWallet.java
@@ -1079,9 +1195,14 @@ src/main/java/com/fireblocks/sdk/model/AuditLogData.java
src/main/java/com/fireblocks/sdk/model/AuditorData.java
src/main/java/com/fireblocks/sdk/model/AuthorizationGroups.java
src/main/java/com/fireblocks/sdk/model/AuthorizationInfo.java
+src/main/java/com/fireblocks/sdk/model/BalanceHistoryItemDto.java
+src/main/java/com/fireblocks/sdk/model/BalanceHistoryPagedResponse.java
+src/main/java/com/fireblocks/sdk/model/BankAddress.java
src/main/java/com/fireblocks/sdk/model/BaseProvider.java
src/main/java/com/fireblocks/sdk/model/BasicAddressRequest.java
src/main/java/com/fireblocks/sdk/model/BlockInfo.java
+src/main/java/com/fireblocks/sdk/model/BlockchainAddress.java
+src/main/java/com/fireblocks/sdk/model/BlockchainDestination.java
src/main/java/com/fireblocks/sdk/model/BlockchainExplorer.java
src/main/java/com/fireblocks/sdk/model/BlockchainMedia.java
src/main/java/com/fireblocks/sdk/model/BlockchainMetadata.java
@@ -1090,6 +1211,7 @@ src/main/java/com/fireblocks/sdk/model/BlockchainOnchain.java
src/main/java/com/fireblocks/sdk/model/BlockchainResponse.java
src/main/java/com/fireblocks/sdk/model/BlockchainTransfer.java
src/main/java/com/fireblocks/sdk/model/BpsFee.java
+src/main/java/com/fireblocks/sdk/model/BusinessEntityTypeEnum.java
src/main/java/com/fireblocks/sdk/model/BusinessIdentification.java
src/main/java/com/fireblocks/sdk/model/CallbackHandler.java
src/main/java/com/fireblocks/sdk/model/CallbackHandlerRequest.java
@@ -1110,6 +1232,7 @@ src/main/java/com/fireblocks/sdk/model/CollectionOwnershipResponse.java
src/main/java/com/fireblocks/sdk/model/CollectionTokenMetadataAttributeDto.java
src/main/java/com/fireblocks/sdk/model/CollectionTokenMetadataDto.java
src/main/java/com/fireblocks/sdk/model/CollectionType.java
+src/main/java/com/fireblocks/sdk/model/CommittedQuoteEnum.java
src/main/java/com/fireblocks/sdk/model/CommittedQuoteType.java
src/main/java/com/fireblocks/sdk/model/ComplianceResultFullPayload.java
src/main/java/com/fireblocks/sdk/model/ComplianceResultStatusesEnum.java
@@ -1129,6 +1252,7 @@ src/main/java/com/fireblocks/sdk/model/ConnectedAccountAssetType.java
src/main/java/com/fireblocks/sdk/model/ConnectedAccountBalances.java
src/main/java/com/fireblocks/sdk/model/ConnectedAccountBalancesResponse.java
src/main/java/com/fireblocks/sdk/model/ConnectedAccountCapability.java
+src/main/java/com/fireblocks/sdk/model/ConnectedAccountErrorResponse.java
src/main/java/com/fireblocks/sdk/model/ConnectedAccountManifest.java
src/main/java/com/fireblocks/sdk/model/ConnectedAccountRateResponse.java
src/main/java/com/fireblocks/sdk/model/ConnectedAccountTotalBalance.java
@@ -1141,6 +1265,7 @@ src/main/java/com/fireblocks/sdk/model/ConnectedSingleAccountResponse.java
src/main/java/com/fireblocks/sdk/model/ConsoleUser.java
src/main/java/com/fireblocks/sdk/model/ContractAbiResponseDto.java
src/main/java/com/fireblocks/sdk/model/ContractAbiResponseDtoAbiInner.java
+src/main/java/com/fireblocks/sdk/model/ContractAddressResponse.java
src/main/java/com/fireblocks/sdk/model/ContractAttributes.java
src/main/java/com/fireblocks/sdk/model/ContractDataDecodeDataType.java
src/main/java/com/fireblocks/sdk/model/ContractDataDecodeError.java
@@ -1176,7 +1301,6 @@ src/main/java/com/fireblocks/sdk/model/CosignersPaginatedResponse.java
src/main/java/com/fireblocks/sdk/model/CreateAPIUser.java
src/main/java/com/fireblocks/sdk/model/CreateAddressRequest.java
src/main/java/com/fireblocks/sdk/model/CreateAddressResponse.java
-src/main/java/com/fireblocks/sdk/model/CreateAssetsBulkRequest.java
src/main/java/com/fireblocks/sdk/model/CreateAssetsRequest.java
src/main/java/com/fireblocks/sdk/model/CreateConfigOperationRequest.java
src/main/java/com/fireblocks/sdk/model/CreateConnectionRequest.java
@@ -1217,8 +1341,11 @@ src/main/java/com/fireblocks/sdk/model/CreateWorkflowExecutionRequestParamsInner
src/main/java/com/fireblocks/sdk/model/CustomRoutingDest.java
src/main/java/com/fireblocks/sdk/model/DAppAddressConfig.java
src/main/java/com/fireblocks/sdk/model/DVPSettlement.java
+src/main/java/com/fireblocks/sdk/model/DVPSettlementType.java
+src/main/java/com/fireblocks/sdk/model/DecodedLog.java
src/main/java/com/fireblocks/sdk/model/DefaultNetworkRoutingDest.java
src/main/java/com/fireblocks/sdk/model/Delegation.java
+src/main/java/com/fireblocks/sdk/model/DelegationBlockchainPositionInfo.java
src/main/java/com/fireblocks/sdk/model/DelegationSummary.java
src/main/java/com/fireblocks/sdk/model/DeleteNetworkConnectionResponse.java
src/main/java/com/fireblocks/sdk/model/DeleteNetworkIdResponse.java
@@ -1276,15 +1403,22 @@ src/main/java/com/fireblocks/sdk/model/EmbeddedWalletLatestBackupKey.java
src/main/java/com/fireblocks/sdk/model/EmbeddedWalletLatestBackupResponse.java
src/main/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedAddressesResponse.java
src/main/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedAssetsResponse.java
+src/main/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedDevicesResponse.java
src/main/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedWalletsResponse.java
+src/main/java/com/fireblocks/sdk/model/EmbeddedWalletRequiredAlgorithms.java
src/main/java/com/fireblocks/sdk/model/EmbeddedWalletSetUpStatus.java
-src/main/java/com/fireblocks/sdk/model/ErrorCodes.java
+src/main/java/com/fireblocks/sdk/model/EmbeddedWalletSetupStatusResponse.java
+src/main/java/com/fireblocks/sdk/model/EnableDevice.java
+src/main/java/com/fireblocks/sdk/model/EnableWallet.java
src/main/java/com/fireblocks/sdk/model/ErrorResponse.java
src/main/java/com/fireblocks/sdk/model/ErrorResponseError.java
src/main/java/com/fireblocks/sdk/model/ErrorSchema.java
src/main/java/com/fireblocks/sdk/model/EstimatedFeeDetails.java
src/main/java/com/fireblocks/sdk/model/EstimatedNetworkFeeResponse.java
src/main/java/com/fireblocks/sdk/model/EstimatedTransactionFeeResponse.java
+src/main/java/com/fireblocks/sdk/model/EthereumBlockchainData.java
+src/main/java/com/fireblocks/sdk/model/EuropeanSEPAAddress.java
+src/main/java/com/fireblocks/sdk/model/EuropeanSEPADestination.java
src/main/java/com/fireblocks/sdk/model/ExchangeAccount.java
src/main/java/com/fireblocks/sdk/model/ExchangeAsset.java
src/main/java/com/fireblocks/sdk/model/ExchangeSettlementTransactionsResponse.java
@@ -1298,14 +1432,21 @@ src/main/java/com/fireblocks/sdk/model/ExecutionRequestDetails.java
src/main/java/com/fireblocks/sdk/model/ExecutionResponseBaseDetails.java
src/main/java/com/fireblocks/sdk/model/ExecutionResponseDetails.java
src/main/java/com/fireblocks/sdk/model/ExecutionScreeningOperation.java
-src/main/java/com/fireblocks/sdk/model/ExecutionStep.java
-src/main/java/com/fireblocks/sdk/model/ExecutionStepDetails.java
src/main/java/com/fireblocks/sdk/model/ExecutionStepError.java
src/main/java/com/fireblocks/sdk/model/ExecutionStepStatusEnum.java
src/main/java/com/fireblocks/sdk/model/ExecutionStepType.java
src/main/java/com/fireblocks/sdk/model/ExecutionTransferOperation.java
src/main/java/com/fireblocks/sdk/model/ExternalAccount.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountLocalBankAfrica.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountLocalBankAfricaType.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountMobileMoney.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountMobileMoneyProvider.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountMobileMoneyType.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountSenderInformation.java
+src/main/java/com/fireblocks/sdk/model/ExternalAccountType.java
src/main/java/com/fireblocks/sdk/model/ExternalWalletAsset.java
+src/main/java/com/fireblocks/sdk/model/Failure.java
+src/main/java/com/fireblocks/sdk/model/FailureReason.java
src/main/java/com/fireblocks/sdk/model/Fee.java
src/main/java/com/fireblocks/sdk/model/FeeBreakdown.java
src/main/java/com/fireblocks/sdk/model/FeeBreakdownOneOf.java
@@ -1314,12 +1455,15 @@ src/main/java/com/fireblocks/sdk/model/FeeInfo.java
src/main/java/com/fireblocks/sdk/model/FeeLevel.java
src/main/java/com/fireblocks/sdk/model/FeePayerInfo.java
src/main/java/com/fireblocks/sdk/model/FeePropertiesDetails.java
+src/main/java/com/fireblocks/sdk/model/FeeTypeEnum.java
src/main/java/com/fireblocks/sdk/model/FetchAbiRequestDto.java
src/main/java/com/fireblocks/sdk/model/FiatAccount.java
src/main/java/com/fireblocks/sdk/model/FiatAccountType.java
src/main/java/com/fireblocks/sdk/model/FiatAsset.java
src/main/java/com/fireblocks/sdk/model/FiatDestination.java
+src/main/java/com/fireblocks/sdk/model/FiatPaymentMetadata.java
src/main/java/com/fireblocks/sdk/model/FiatTransfer.java
+src/main/java/com/fireblocks/sdk/model/FixedAmountTypeEnum.java
src/main/java/com/fireblocks/sdk/model/FixedFee.java
src/main/java/com/fireblocks/sdk/model/FreezeTransactionResponse.java
src/main/java/com/fireblocks/sdk/model/FunctionDoc.java
@@ -1339,6 +1483,7 @@ src/main/java/com/fireblocks/sdk/model/GetFilterParameter.java
src/main/java/com/fireblocks/sdk/model/GetLayerZeroDvnConfigResponse.java
src/main/java/com/fireblocks/sdk/model/GetLayerZeroPeersResponse.java
src/main/java/com/fireblocks/sdk/model/GetLinkedCollectionsPaginatedResponse.java
+src/main/java/com/fireblocks/sdk/model/GetMaxBipIndexUsedResponse.java
src/main/java/com/fireblocks/sdk/model/GetMaxSpendableAmountResponse.java
src/main/java/com/fireblocks/sdk/model/GetMpcKeysResponse.java
src/main/java/com/fireblocks/sdk/model/GetNFTsResponse.java
@@ -1358,6 +1503,7 @@ src/main/java/com/fireblocks/sdk/model/IbanDestination.java
src/main/java/com/fireblocks/sdk/model/IbanPaymentInfo.java
src/main/java/com/fireblocks/sdk/model/Identification.java
src/main/java/com/fireblocks/sdk/model/IdlType.java
+src/main/java/com/fireblocks/sdk/model/IndicativeQuoteEnum.java
src/main/java/com/fireblocks/sdk/model/IndicativeQuoteType.java
src/main/java/com/fireblocks/sdk/model/InitiatorConfig.java
src/main/java/com/fireblocks/sdk/model/InitiatorConfigPattern.java
@@ -1365,7 +1511,6 @@ src/main/java/com/fireblocks/sdk/model/InstructionAmount.java
src/main/java/com/fireblocks/sdk/model/InternalReference.java
src/main/java/com/fireblocks/sdk/model/InternalTransferResponse.java
src/main/java/com/fireblocks/sdk/model/InvalidParamaterValueError.java
-src/main/java/com/fireblocks/sdk/model/Job.java
src/main/java/com/fireblocks/sdk/model/JobCreated.java
src/main/java/com/fireblocks/sdk/model/LayerZeroAdapterCreateParams.java
src/main/java/com/fireblocks/sdk/model/LbtPaymentInfo.java
@@ -1400,9 +1545,7 @@ src/main/java/com/fireblocks/sdk/model/LegacyPolicyValidation.java
src/main/java/com/fireblocks/sdk/model/LegacyPublishDraftRequest.java
src/main/java/com/fireblocks/sdk/model/LegacyPublishResult.java
src/main/java/com/fireblocks/sdk/model/LegacySrcOrDestAttributesInner.java
-src/main/java/com/fireblocks/sdk/model/LimitExecutionRequestDetails.java
-src/main/java/com/fireblocks/sdk/model/LimitExecutionResponseDetails.java
-src/main/java/com/fireblocks/sdk/model/LimitTypeDetails.java
+src/main/java/com/fireblocks/sdk/model/LinkedTokensCount.java
src/main/java/com/fireblocks/sdk/model/ListAssetsResponse.java
src/main/java/com/fireblocks/sdk/model/ListBlockchainsResponse.java
src/main/java/com/fireblocks/sdk/model/ListOwnedCollectionsResponse.java
@@ -1413,7 +1556,9 @@ src/main/java/com/fireblocks/sdk/model/Manifest.java
src/main/java/com/fireblocks/sdk/model/MarketExecutionRequestDetails.java
src/main/java/com/fireblocks/sdk/model/MarketExecutionResponseDetails.java
src/main/java/com/fireblocks/sdk/model/MarketRequoteRequestDetails.java
+src/main/java/com/fireblocks/sdk/model/MarketRequoteTypeEnum.java
src/main/java/com/fireblocks/sdk/model/MarketTypeDetails.java
+src/main/java/com/fireblocks/sdk/model/MarketTypeEnum.java
src/main/java/com/fireblocks/sdk/model/MediaEntityResponse.java
src/main/java/com/fireblocks/sdk/model/MergeStakeAccountsRequest.java
src/main/java/com/fireblocks/sdk/model/MergeStakeAccountsResponse.java
@@ -1444,11 +1589,15 @@ src/main/java/com/fireblocks/sdk/model/NotificationAttemptsPaginatedResponse.jav
src/main/java/com/fireblocks/sdk/model/NotificationPaginatedResponse.java
src/main/java/com/fireblocks/sdk/model/NotificationStatus.java
src/main/java/com/fireblocks/sdk/model/NotificationWithData.java
+src/main/java/com/fireblocks/sdk/model/OnchainTransaction.java
+src/main/java/com/fireblocks/sdk/model/OnchainTransactionsPagedResponse.java
src/main/java/com/fireblocks/sdk/model/OneTimeAddress.java
src/main/java/com/fireblocks/sdk/model/OneTimeAddressAccount.java
+src/main/java/com/fireblocks/sdk/model/OneTimeAddressPeerType.java
src/main/java/com/fireblocks/sdk/model/OneTimeAddressReference.java
src/main/java/com/fireblocks/sdk/model/OperationExecutionFailure.java
src/main/java/com/fireblocks/sdk/model/OrderDetails.java
+src/main/java/com/fireblocks/sdk/model/OrderExecutionStep.java
src/main/java/com/fireblocks/sdk/model/OrderSide.java
src/main/java/com/fireblocks/sdk/model/OrderStatus.java
src/main/java/com/fireblocks/sdk/model/OrderSummary.java
@@ -1471,7 +1620,7 @@ src/main/java/com/fireblocks/sdk/model/PaymentAccount.java
src/main/java/com/fireblocks/sdk/model/PaymentAccountResponse.java
src/main/java/com/fireblocks/sdk/model/PaymentAccountType.java
src/main/java/com/fireblocks/sdk/model/PaymentInstructions.java
-src/main/java/com/fireblocks/sdk/model/PaymentInstructionsDetails.java
+src/main/java/com/fireblocks/sdk/model/PaymentInstructionsOneOf.java
src/main/java/com/fireblocks/sdk/model/PayoutInitMethod.java
src/main/java/com/fireblocks/sdk/model/PayoutInstruction.java
src/main/java/com/fireblocks/sdk/model/PayoutInstructionResponse.java
@@ -1481,12 +1630,14 @@ src/main/java/com/fireblocks/sdk/model/PayoutState.java
src/main/java/com/fireblocks/sdk/model/PayoutStatus.java
src/main/java/com/fireblocks/sdk/model/PeerAdapterInfo.java
src/main/java/com/fireblocks/sdk/model/PeerType.java
+src/main/java/com/fireblocks/sdk/model/PersonalEntityTypeEnum.java
src/main/java/com/fireblocks/sdk/model/PersonalIdentification.java
src/main/java/com/fireblocks/sdk/model/PersonalIdentificationFullName.java
src/main/java/com/fireblocks/sdk/model/PixAddress.java
src/main/java/com/fireblocks/sdk/model/PixDestination.java
src/main/java/com/fireblocks/sdk/model/PixPaymentInfo.java
src/main/java/com/fireblocks/sdk/model/PlatformAccount.java
+src/main/java/com/fireblocks/sdk/model/PlatformPeerType.java
src/main/java/com/fireblocks/sdk/model/Players.java
src/main/java/com/fireblocks/sdk/model/PolicyAndValidationResponse.java
src/main/java/com/fireblocks/sdk/model/PolicyCheckResult.java
@@ -1503,24 +1654,24 @@ src/main/java/com/fireblocks/sdk/model/PolicyType.java
src/main/java/com/fireblocks/sdk/model/PolicyValidation.java
src/main/java/com/fireblocks/sdk/model/PolicyVerdictActionEnum.java
src/main/java/com/fireblocks/sdk/model/PolicyVerdictActionEnum2.java
-src/main/java/com/fireblocks/sdk/model/PostOrderSettlement.java
src/main/java/com/fireblocks/sdk/model/PostalAddress.java
src/main/java/com/fireblocks/sdk/model/PreScreening.java
src/main/java/com/fireblocks/sdk/model/PrefundedSettlement.java
+src/main/java/com/fireblocks/sdk/model/PrefundedSettlementType.java
src/main/java/com/fireblocks/sdk/model/ProgramCallConfig.java
src/main/java/com/fireblocks/sdk/model/Provider.java
-src/main/java/com/fireblocks/sdk/model/ProviderID.java
src/main/java/com/fireblocks/sdk/model/ProvidersListResponse.java
src/main/java/com/fireblocks/sdk/model/PublicKeyInformation.java
src/main/java/com/fireblocks/sdk/model/PublishDraftRequest.java
src/main/java/com/fireblocks/sdk/model/PublishResult.java
src/main/java/com/fireblocks/sdk/model/Quote.java
src/main/java/com/fireblocks/sdk/model/QuoteExecutionRequestDetails.java
-src/main/java/com/fireblocks/sdk/model/QuoteExecutionResponseDetails.java
+src/main/java/com/fireblocks/sdk/model/QuoteExecutionStep.java
src/main/java/com/fireblocks/sdk/model/QuoteExecutionTypeDetails.java
src/main/java/com/fireblocks/sdk/model/QuoteExecutionWithRequoteRequestDetails.java
src/main/java/com/fireblocks/sdk/model/QuoteExecutionWithRequoteResponseDetails.java
src/main/java/com/fireblocks/sdk/model/QuotePropertiesDetails.java
+src/main/java/com/fireblocks/sdk/model/QuoteTypeEnum.java
src/main/java/com/fireblocks/sdk/model/QuotesResponse.java
src/main/java/com/fireblocks/sdk/model/ReQuoteDetails.java
src/main/java/com/fireblocks/sdk/model/ReQuoteDetailsReQuote.java
@@ -1538,9 +1689,10 @@ src/main/java/com/fireblocks/sdk/model/RemoveLayerZeroAdaptersRequest.java
src/main/java/com/fireblocks/sdk/model/RemoveLayerZeroAdaptersResponse.java
src/main/java/com/fireblocks/sdk/model/RemoveLayerZeroPeersRequest.java
src/main/java/com/fireblocks/sdk/model/RemoveLayerZeroPeersResponse.java
+src/main/java/com/fireblocks/sdk/model/RenameConnectedAccountRequest.java
+src/main/java/com/fireblocks/sdk/model/RenameConnectedAccountResponse.java
src/main/java/com/fireblocks/sdk/model/RenameCosigner.java
src/main/java/com/fireblocks/sdk/model/RenameVaultAccountResponse.java
-src/main/java/com/fireblocks/sdk/model/RescanTransaction.java
src/main/java/com/fireblocks/sdk/model/ResendFailedNotificationsJobStatusResponse.java
src/main/java/com/fireblocks/sdk/model/ResendFailedNotificationsRequest.java
src/main/java/com/fireblocks/sdk/model/ResendFailedNotificationsResponse.java
@@ -1550,12 +1702,16 @@ src/main/java/com/fireblocks/sdk/model/ResendWebhooksByTransactionIdResponse.jav
src/main/java/com/fireblocks/sdk/model/ResendWebhooksResponse.java
src/main/java/com/fireblocks/sdk/model/RespondToConnectionRequest.java
src/main/java/com/fireblocks/sdk/model/RetryRequoteRequestDetails.java
+src/main/java/com/fireblocks/sdk/model/RetryRequoteTypeEnum.java
src/main/java/com/fireblocks/sdk/model/RewardInfo.java
src/main/java/com/fireblocks/sdk/model/RewardsInfo.java
+src/main/java/com/fireblocks/sdk/model/RoleDetails.java
+src/main/java/com/fireblocks/sdk/model/RoleGrantee.java
src/main/java/com/fireblocks/sdk/model/SEPAAddress.java
src/main/java/com/fireblocks/sdk/model/SEPADestination.java
src/main/java/com/fireblocks/sdk/model/SOLAccount.java
src/main/java/com/fireblocks/sdk/model/SOLAccountWithValue.java
+src/main/java/com/fireblocks/sdk/model/ScopeItem.java
src/main/java/com/fireblocks/sdk/model/ScreeningAlertExposureTypeEnum.java
src/main/java/com/fireblocks/sdk/model/ScreeningAmlAlert.java
src/main/java/com/fireblocks/sdk/model/ScreeningAmlMatchedRule.java
@@ -1612,6 +1768,7 @@ src/main/java/com/fireblocks/sdk/model/Settlement.java
src/main/java/com/fireblocks/sdk/model/SettlementRequestBody.java
src/main/java/com/fireblocks/sdk/model/SettlementResponse.java
src/main/java/com/fireblocks/sdk/model/SettlementSourceAccount.java
+src/main/java/com/fireblocks/sdk/model/Side.java
src/main/java/com/fireblocks/sdk/model/SignedMessage.java
src/main/java/com/fireblocks/sdk/model/SignedMessageSignature.java
src/main/java/com/fireblocks/sdk/model/SigningKeyDto.java
@@ -1658,26 +1815,69 @@ src/main/java/com/fireblocks/sdk/model/SpeiBasicPaymentInfo.java
src/main/java/com/fireblocks/sdk/model/SpeiDestination.java
src/main/java/com/fireblocks/sdk/model/SplitRequest.java
src/main/java/com/fireblocks/sdk/model/SplitResponse.java
+src/main/java/com/fireblocks/sdk/model/StEthBlockchainData.java
src/main/java/com/fireblocks/sdk/model/StakeRequest.java
src/main/java/com/fireblocks/sdk/model/StakeResponse.java
src/main/java/com/fireblocks/sdk/model/StakingProvider.java
src/main/java/com/fireblocks/sdk/model/Status.java
src/main/java/com/fireblocks/sdk/model/StellarRippleCreateParamsDto.java
+src/main/java/com/fireblocks/sdk/model/SupportedBlockChainsResponse.java
+src/main/java/com/fireblocks/sdk/model/SupportedBlockchain.java
src/main/java/com/fireblocks/sdk/model/SwiftAddress.java
src/main/java/com/fireblocks/sdk/model/SwiftDestination.java
src/main/java/com/fireblocks/sdk/model/SystemMessageInfo.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAPIPagedResponse.java
src/main/java/com/fireblocks/sdk/model/TRLinkAmount.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAmount2.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAmountRange.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAssessTravelRuleRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAssessTravelRuleResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAssessmentDecision.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAsset.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAssetData.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAssetFormat.java
+src/main/java/com/fireblocks/sdk/model/TRLinkAssetsListPagedResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCancelTrmRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkConnectIntegrationRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCreateCustomerRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCreateIntegrationRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCreateTrmRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCurrency.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCustomerIntegrationResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkCustomerResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkDestinationTransferPeerPath.java
+src/main/java/com/fireblocks/sdk/model/TRLinkDiscoverableStatus.java
+src/main/java/com/fireblocks/sdk/model/TRLinkFiatValue.java
+src/main/java/com/fireblocks/sdk/model/TRLinkGeographicAddressRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkGetSupportedAssetResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkIvms.java
+src/main/java/com/fireblocks/sdk/model/TRLinkIvmsResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkJwkPublicKey.java
src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction.java
+src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2.java
src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmActionEnum.java
src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmDecision.java
src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmRule.java
+src/main/java/com/fireblocks/sdk/model/TRLinkMissingTrmRule2.java
+src/main/java/com/fireblocks/sdk/model/TRLinkOneTimeAddress.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPaging.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPartnerResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPolicyResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPostScreeningAction.java
src/main/java/com/fireblocks/sdk/model/TRLinkPostScreeningRule.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPostScreeningRule2.java
src/main/java/com/fireblocks/sdk/model/TRLinkPreScreeningAction.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPreScreeningAction2.java
src/main/java/com/fireblocks/sdk/model/TRLinkPreScreeningActionEnum.java
src/main/java/com/fireblocks/sdk/model/TRLinkPreScreeningRule.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPreScreeningRule2.java
+src/main/java/com/fireblocks/sdk/model/TRLinkProviderData.java
src/main/java/com/fireblocks/sdk/model/TRLinkProviderResult.java
src/main/java/com/fireblocks/sdk/model/TRLinkProviderResultWithRule.java
src/main/java/com/fireblocks/sdk/model/TRLinkProviderResultWithRule2.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPublicAssetInfo.java
+src/main/java/com/fireblocks/sdk/model/TRLinkPublicKeyResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkRedirectTrmRequest.java
src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationResult.java
src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationResultFullPayload.java
src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationStatus.java
@@ -1685,22 +1885,39 @@ src/main/java/com/fireblocks/sdk/model/TRLinkRegistrationStatusEnum.java
src/main/java/com/fireblocks/sdk/model/TRLinkResult.java
src/main/java/com/fireblocks/sdk/model/TRLinkResultFullPayload.java
src/main/java/com/fireblocks/sdk/model/TRLinkRuleBase.java
+src/main/java/com/fireblocks/sdk/model/TRLinkSetDestinationTravelRuleMessageIdRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkSetDestinationTravelRuleMessageIdResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkSetTransactionTravelRuleMessageIdRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkSetTransactionTravelRuleMessageIdResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkSourceTransferPeerPath.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTestConnectionResponse.java
+src/main/java/com/fireblocks/sdk/model/TRLinkThresholds.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTransactionDirection.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTransferPeerPath.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTrmDirection.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTrmInfoResponse.java
src/main/java/com/fireblocks/sdk/model/TRLinkTrmScreeningStatus.java
src/main/java/com/fireblocks/sdk/model/TRLinkTrmScreeningStatusEnum.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTrmStatus.java
+src/main/java/com/fireblocks/sdk/model/TRLinkTxnInfo.java
+src/main/java/com/fireblocks/sdk/model/TRLinkUpdateCustomerRequest.java
+src/main/java/com/fireblocks/sdk/model/TRLinkVaspDto.java
+src/main/java/com/fireblocks/sdk/model/TRLinkVaspGeographicAddress.java
+src/main/java/com/fireblocks/sdk/model/TRLinkVaspListDto.java
+src/main/java/com/fireblocks/sdk/model/TRLinkVaspNationalIdentification.java
src/main/java/com/fireblocks/sdk/model/TRLinkVerdict.java
src/main/java/com/fireblocks/sdk/model/TRLinkVerdictEnum.java
src/main/java/com/fireblocks/sdk/model/Tag.java
src/main/java/com/fireblocks/sdk/model/TagAttachmentOperationAction.java
src/main/java/com/fireblocks/sdk/model/TagsPagedResponse.java
-src/main/java/com/fireblocks/sdk/model/Task.java
src/main/java/com/fireblocks/sdk/model/TemplatesPaginatedResponse.java
src/main/java/com/fireblocks/sdk/model/ThirdPartyRouting.java
-src/main/java/com/fireblocks/sdk/model/TimeInForce.java
src/main/java/com/fireblocks/sdk/model/TimePeriodConfig.java
src/main/java/com/fireblocks/sdk/model/TimePeriodMatchType.java
src/main/java/com/fireblocks/sdk/model/ToCollateralTransaction.java
src/main/java/com/fireblocks/sdk/model/ToExchangeTransaction.java
src/main/java/com/fireblocks/sdk/model/TokenCollectionResponse.java
+src/main/java/com/fireblocks/sdk/model/TokenContractSummaryResponse.java
src/main/java/com/fireblocks/sdk/model/TokenInfoNotFoundErrorResponse.java
src/main/java/com/fireblocks/sdk/model/TokenLinkDto.java
src/main/java/com/fireblocks/sdk/model/TokenLinkDtoTokenMetadata.java
@@ -1712,9 +1929,10 @@ src/main/java/com/fireblocks/sdk/model/TokenOwnershipSpamUpdatePayload.java
src/main/java/com/fireblocks/sdk/model/TokenOwnershipStatusUpdatePayload.java
src/main/java/com/fireblocks/sdk/model/TokenResponse.java
src/main/java/com/fireblocks/sdk/model/TokensPaginatedResponse.java
+src/main/java/com/fireblocks/sdk/model/TotalSupplyItemDto.java
+src/main/java/com/fireblocks/sdk/model/TotalSupplyPagedResponse.java
src/main/java/com/fireblocks/sdk/model/TradingAccountType.java
-src/main/java/com/fireblocks/sdk/model/TradingErrorResponse.java
-src/main/java/com/fireblocks/sdk/model/TradingErrorResponseError.java
+src/main/java/com/fireblocks/sdk/model/TradingErrorSchema.java
src/main/java/com/fireblocks/sdk/model/TradingProvider.java
src/main/java/com/fireblocks/sdk/model/Transaction.java
src/main/java/com/fireblocks/sdk/model/TransactionDirection.java
@@ -1793,7 +2011,11 @@ src/main/java/com/fireblocks/sdk/model/TravelRuleValidateTransactionRequest.java
src/main/java/com/fireblocks/sdk/model/TravelRuleValidateTransactionResponse.java
src/main/java/com/fireblocks/sdk/model/TravelRuleVaspForVault.java
src/main/java/com/fireblocks/sdk/model/TravelRuleVerdictEnum.java
+src/main/java/com/fireblocks/sdk/model/TrustProofOfAddressCreateResponse.java
+src/main/java/com/fireblocks/sdk/model/TrustProofOfAddressRequest.java
+src/main/java/com/fireblocks/sdk/model/TrustProofOfAddressResponse.java
src/main/java/com/fireblocks/sdk/model/TxLog.java
+src/main/java/com/fireblocks/sdk/model/TypedMessageTransactionStatusEnum.java
src/main/java/com/fireblocks/sdk/model/USWireAddress.java
src/main/java/com/fireblocks/sdk/model/USWireDestination.java
src/main/java/com/fireblocks/sdk/model/UnfreezeTransactionResponse.java
@@ -1821,7 +2043,6 @@ src/main/java/com/fireblocks/sdk/model/UserStatus.java
src/main/java/com/fireblocks/sdk/model/UserType.java
src/main/java/com/fireblocks/sdk/model/ValidateAddressResponse.java
src/main/java/com/fireblocks/sdk/model/ValidateLayerZeroChannelResponse.java
-src/main/java/com/fireblocks/sdk/model/ValidatedTransactionsForRescan.java
src/main/java/com/fireblocks/sdk/model/ValidationKeyDto.java
src/main/java/com/fireblocks/sdk/model/Validator.java
src/main/java/com/fireblocks/sdk/model/VaultAccount.java
@@ -1832,13 +2053,12 @@ src/main/java/com/fireblocks/sdk/model/VaultAccountsPagedResponse.java
src/main/java/com/fireblocks/sdk/model/VaultAccountsPagedResponsePaging.java
src/main/java/com/fireblocks/sdk/model/VaultAccountsTagAttachmentOperationsRequest.java
src/main/java/com/fireblocks/sdk/model/VaultAccountsTagAttachmentOperationsResponse.java
-src/main/java/com/fireblocks/sdk/model/VaultAccountsTagAttachmentsRequest.java
src/main/java/com/fireblocks/sdk/model/VaultActionStatus.java
src/main/java/com/fireblocks/sdk/model/VaultAsset.java
src/main/java/com/fireblocks/sdk/model/VaultWalletAddress.java
src/main/java/com/fireblocks/sdk/model/VendorDto.java
src/main/java/com/fireblocks/sdk/model/VerdictConfig.java
-src/main/java/com/fireblocks/sdk/model/Version.java
+src/main/java/com/fireblocks/sdk/model/VersionSummary.java
src/main/java/com/fireblocks/sdk/model/WalletAsset.java
src/main/java/com/fireblocks/sdk/model/WalletAssetAdditionalInfo.java
src/main/java/com/fireblocks/sdk/model/Webhook.java
@@ -1861,7 +2081,6 @@ src/test/java/com/fireblocks/sdk/FireblocksTest.java
src/test/java/com/fireblocks/sdk/UserAgentUtilTest.java
src/test/java/com/fireblocks/sdk/ValidationUtilsTest.java
src/test/java/com/fireblocks/sdk/api/ApiUserApiTest.java
-src/test/java/com/fireblocks/sdk/api/AssetsApiTest.java
src/test/java/com/fireblocks/sdk/api/AuditLogsApiTest.java
src/test/java/com/fireblocks/sdk/api/BlockchainsAssetsApiTest.java
src/test/java/com/fireblocks/sdk/api/ComplianceApiTest.java
@@ -1879,12 +2098,12 @@ src/test/java/com/fireblocks/sdk/api/ExternalWalletsApiTest.java
src/test/java/com/fireblocks/sdk/api/FiatAccountsApiTest.java
src/test/java/com/fireblocks/sdk/api/GasStationsApiTest.java
src/test/java/com/fireblocks/sdk/api/InternalWalletsApiTest.java
-src/test/java/com/fireblocks/sdk/api/JobManagementApiTest.java
src/test/java/com/fireblocks/sdk/api/KeyLinkBetaApiTest.java
src/test/java/com/fireblocks/sdk/api/KeysBetaApiTest.java
src/test/java/com/fireblocks/sdk/api/NetworkConnectionsApiTest.java
src/test/java/com/fireblocks/sdk/api/NftsApiTest.java
src/test/java/com/fireblocks/sdk/api/OffExchangesApiTest.java
+src/test/java/com/fireblocks/sdk/api/OnchainDataApiTest.java
src/test/java/com/fireblocks/sdk/api/OtaBetaApiTest.java
src/test/java/com/fireblocks/sdk/api/PaymentsPayoutApiTest.java
src/test/java/com/fireblocks/sdk/api/PolicyEditorBetaApiTest.java
@@ -1894,6 +2113,7 @@ src/test/java/com/fireblocks/sdk/api/SmartTransferApiTest.java
src/test/java/com/fireblocks/sdk/api/StakingApiTest.java
src/test/java/com/fireblocks/sdk/api/TagsApiTest.java
src/test/java/com/fireblocks/sdk/api/TokenizationApiTest.java
+src/test/java/com/fireblocks/sdk/api/TrLinkApiTest.java
src/test/java/com/fireblocks/sdk/api/TradingBetaApiTest.java
src/test/java/com/fireblocks/sdk/api/TransactionsApiTest.java
src/test/java/com/fireblocks/sdk/api/TravelRuleApiTest.java
@@ -1908,6 +2128,9 @@ src/test/java/com/fireblocks/sdk/api/WorkspaceStatusBetaApiTest.java
src/test/java/com/fireblocks/sdk/model/APIUserTest.java
src/test/java/com/fireblocks/sdk/model/AbaPaymentInfoTest.java
src/test/java/com/fireblocks/sdk/model/AbiFunctionTest.java
+src/test/java/com/fireblocks/sdk/model/AccessRegistryAddressItemTest.java
+src/test/java/com/fireblocks/sdk/model/AccessRegistryCurrentStateResponseTest.java
+src/test/java/com/fireblocks/sdk/model/AccessRegistrySummaryResponseTest.java
src/test/java/com/fireblocks/sdk/model/AccessTypeTest.java
src/test/java/com/fireblocks/sdk/model/AccountAccessTest.java
src/test/java/com/fireblocks/sdk/model/AccountBaseTest.java
@@ -1916,7 +2139,6 @@ src/test/java/com/fireblocks/sdk/model/AccountBasedAccessProviderTest.java
src/test/java/com/fireblocks/sdk/model/AccountConfigTest.java
src/test/java/com/fireblocks/sdk/model/AccountHolderDetailsTest.java
src/test/java/com/fireblocks/sdk/model/AccountIdentifierTest.java
-src/test/java/com/fireblocks/sdk/model/AccountProviderIDTest.java
src/test/java/com/fireblocks/sdk/model/AccountReferenceTest.java
src/test/java/com/fireblocks/sdk/model/AccountTest.java
src/test/java/com/fireblocks/sdk/model/AccountType2Test.java
@@ -1937,6 +2159,8 @@ src/test/java/com/fireblocks/sdk/model/AddExchangeAccountResponseTest.java
src/test/java/com/fireblocks/sdk/model/AdditionalInfoRequestAdditionalInfoTest.java
src/test/java/com/fireblocks/sdk/model/AdditionalInfoRequestTest.java
src/test/java/com/fireblocks/sdk/model/AdditionalInfoTest.java
+src/test/java/com/fireblocks/sdk/model/AddressBalanceItemDtoTest.java
+src/test/java/com/fireblocks/sdk/model/AddressBalancePagedResponseTest.java
src/test/java/com/fireblocks/sdk/model/AddressNotAvailableErrorTest.java
src/test/java/com/fireblocks/sdk/model/AlertExposureTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/AlertLevelEnumTest.java
@@ -1959,6 +2183,7 @@ src/test/java/com/fireblocks/sdk/model/AmountRangeMinMaxTest.java
src/test/java/com/fireblocks/sdk/model/AmountRangeTest.java
src/test/java/com/fireblocks/sdk/model/ApiKeyTest.java
src/test/java/com/fireblocks/sdk/model/ApiKeysPaginatedResponseTest.java
+src/test/java/com/fireblocks/sdk/model/ApprovalRequestTest.java
src/test/java/com/fireblocks/sdk/model/ApproversConfigApprovalGroupsInnerTest.java
src/test/java/com/fireblocks/sdk/model/ApproversConfigTest.java
src/test/java/com/fireblocks/sdk/model/AssetAlreadyExistHttpErrorTest.java
@@ -1987,6 +2212,7 @@ src/test/java/com/fireblocks/sdk/model/AssetPriceResponseTest.java
src/test/java/com/fireblocks/sdk/model/AssetResponseTest.java
src/test/java/com/fireblocks/sdk/model/AssetScopeTest.java
src/test/java/com/fireblocks/sdk/model/AssetTest.java
+src/test/java/com/fireblocks/sdk/model/AssetTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/AssetTypeResponseTest.java
src/test/java/com/fireblocks/sdk/model/AssetTypesConfigInnerTest.java
src/test/java/com/fireblocks/sdk/model/AssetWalletTest.java
@@ -1994,9 +2220,14 @@ src/test/java/com/fireblocks/sdk/model/AuditLogDataTest.java
src/test/java/com/fireblocks/sdk/model/AuditorDataTest.java
src/test/java/com/fireblocks/sdk/model/AuthorizationGroupsTest.java
src/test/java/com/fireblocks/sdk/model/AuthorizationInfoTest.java
+src/test/java/com/fireblocks/sdk/model/BalanceHistoryItemDtoTest.java
+src/test/java/com/fireblocks/sdk/model/BalanceHistoryPagedResponseTest.java
+src/test/java/com/fireblocks/sdk/model/BankAddressTest.java
src/test/java/com/fireblocks/sdk/model/BaseProviderTest.java
src/test/java/com/fireblocks/sdk/model/BasicAddressRequestTest.java
src/test/java/com/fireblocks/sdk/model/BlockInfoTest.java
+src/test/java/com/fireblocks/sdk/model/BlockchainAddressTest.java
+src/test/java/com/fireblocks/sdk/model/BlockchainDestinationTest.java
src/test/java/com/fireblocks/sdk/model/BlockchainExplorerTest.java
src/test/java/com/fireblocks/sdk/model/BlockchainMediaTest.java
src/test/java/com/fireblocks/sdk/model/BlockchainMetadataTest.java
@@ -2005,6 +2236,7 @@ src/test/java/com/fireblocks/sdk/model/BlockchainOnchainTest.java
src/test/java/com/fireblocks/sdk/model/BlockchainResponseTest.java
src/test/java/com/fireblocks/sdk/model/BlockchainTransferTest.java
src/test/java/com/fireblocks/sdk/model/BpsFeeTest.java
+src/test/java/com/fireblocks/sdk/model/BusinessEntityTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/BusinessIdentificationTest.java
src/test/java/com/fireblocks/sdk/model/CallbackHandlerRequestTest.java
src/test/java/com/fireblocks/sdk/model/CallbackHandlerTest.java
@@ -2025,6 +2257,7 @@ src/test/java/com/fireblocks/sdk/model/CollectionOwnershipResponseTest.java
src/test/java/com/fireblocks/sdk/model/CollectionTokenMetadataAttributeDtoTest.java
src/test/java/com/fireblocks/sdk/model/CollectionTokenMetadataDtoTest.java
src/test/java/com/fireblocks/sdk/model/CollectionTypeTest.java
+src/test/java/com/fireblocks/sdk/model/CommittedQuoteEnumTest.java
src/test/java/com/fireblocks/sdk/model/CommittedQuoteTypeTest.java
src/test/java/com/fireblocks/sdk/model/ComplianceResultFullPayloadTest.java
src/test/java/com/fireblocks/sdk/model/ComplianceResultStatusesEnumTest.java
@@ -2043,6 +2276,7 @@ src/test/java/com/fireblocks/sdk/model/ConnectedAccountAssetTypeTest.java
src/test/java/com/fireblocks/sdk/model/ConnectedAccountBalancesResponseTest.java
src/test/java/com/fireblocks/sdk/model/ConnectedAccountBalancesTest.java
src/test/java/com/fireblocks/sdk/model/ConnectedAccountCapabilityTest.java
+src/test/java/com/fireblocks/sdk/model/ConnectedAccountErrorResponseTest.java
src/test/java/com/fireblocks/sdk/model/ConnectedAccountManifestTest.java
src/test/java/com/fireblocks/sdk/model/ConnectedAccountRateResponseTest.java
src/test/java/com/fireblocks/sdk/model/ConnectedAccountTest.java
@@ -2056,6 +2290,7 @@ src/test/java/com/fireblocks/sdk/model/ConnectedSingleAccountTest.java
src/test/java/com/fireblocks/sdk/model/ConsoleUserTest.java
src/test/java/com/fireblocks/sdk/model/ContractAbiResponseDtoAbiInnerTest.java
src/test/java/com/fireblocks/sdk/model/ContractAbiResponseDtoTest.java
+src/test/java/com/fireblocks/sdk/model/ContractAddressResponseTest.java
src/test/java/com/fireblocks/sdk/model/ContractAttributesTest.java
src/test/java/com/fireblocks/sdk/model/ContractDataDecodeDataTypeTest.java
src/test/java/com/fireblocks/sdk/model/ContractDataDecodeErrorTest.java
@@ -2091,7 +2326,6 @@ src/test/java/com/fireblocks/sdk/model/CosignersPaginatedResponseTest.java
src/test/java/com/fireblocks/sdk/model/CreateAPIUserTest.java
src/test/java/com/fireblocks/sdk/model/CreateAddressRequestTest.java
src/test/java/com/fireblocks/sdk/model/CreateAddressResponseTest.java
-src/test/java/com/fireblocks/sdk/model/CreateAssetsBulkRequestTest.java
src/test/java/com/fireblocks/sdk/model/CreateAssetsRequestTest.java
src/test/java/com/fireblocks/sdk/model/CreateConfigOperationRequestTest.java
src/test/java/com/fireblocks/sdk/model/CreateConnectionRequestTest.java
@@ -2132,7 +2366,10 @@ src/test/java/com/fireblocks/sdk/model/CreateWorkflowExecutionRequestParamsInner
src/test/java/com/fireblocks/sdk/model/CustomRoutingDestTest.java
src/test/java/com/fireblocks/sdk/model/DAppAddressConfigTest.java
src/test/java/com/fireblocks/sdk/model/DVPSettlementTest.java
+src/test/java/com/fireblocks/sdk/model/DVPSettlementTypeTest.java
+src/test/java/com/fireblocks/sdk/model/DecodedLogTest.java
src/test/java/com/fireblocks/sdk/model/DefaultNetworkRoutingDestTest.java
+src/test/java/com/fireblocks/sdk/model/DelegationBlockchainPositionInfoTest.java
src/test/java/com/fireblocks/sdk/model/DelegationSummaryTest.java
src/test/java/com/fireblocks/sdk/model/DelegationTest.java
src/test/java/com/fireblocks/sdk/model/DeleteNetworkConnectionResponseTest.java
@@ -2190,16 +2427,23 @@ src/test/java/com/fireblocks/sdk/model/EmbeddedWalletLatestBackupKeyTest.java
src/test/java/com/fireblocks/sdk/model/EmbeddedWalletLatestBackupResponseTest.java
src/test/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedAddressesResponseTest.java
src/test/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedAssetsResponseTest.java
+src/test/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedDevicesResponseTest.java
src/test/java/com/fireblocks/sdk/model/EmbeddedWalletPaginatedWalletsResponseTest.java
+src/test/java/com/fireblocks/sdk/model/EmbeddedWalletRequiredAlgorithmsTest.java
src/test/java/com/fireblocks/sdk/model/EmbeddedWalletSetUpStatusTest.java
+src/test/java/com/fireblocks/sdk/model/EmbeddedWalletSetupStatusResponseTest.java
src/test/java/com/fireblocks/sdk/model/EmbeddedWalletTest.java
-src/test/java/com/fireblocks/sdk/model/ErrorCodesTest.java
+src/test/java/com/fireblocks/sdk/model/EnableDeviceTest.java
+src/test/java/com/fireblocks/sdk/model/EnableWalletTest.java
src/test/java/com/fireblocks/sdk/model/ErrorResponseErrorTest.java
src/test/java/com/fireblocks/sdk/model/ErrorResponseTest.java
src/test/java/com/fireblocks/sdk/model/ErrorSchemaTest.java
src/test/java/com/fireblocks/sdk/model/EstimatedFeeDetailsTest.java
src/test/java/com/fireblocks/sdk/model/EstimatedNetworkFeeResponseTest.java
src/test/java/com/fireblocks/sdk/model/EstimatedTransactionFeeResponseTest.java
+src/test/java/com/fireblocks/sdk/model/EthereumBlockchainDataTest.java
+src/test/java/com/fireblocks/sdk/model/EuropeanSEPAAddressTest.java
+src/test/java/com/fireblocks/sdk/model/EuropeanSEPADestinationTest.java
src/test/java/com/fireblocks/sdk/model/ExchangeAccountTest.java
src/test/java/com/fireblocks/sdk/model/ExchangeAssetTest.java
src/test/java/com/fireblocks/sdk/model/ExchangeSettlementTransactionsResponseTest.java
@@ -2213,14 +2457,21 @@ src/test/java/com/fireblocks/sdk/model/ExecutionRequestDetailsTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionResponseBaseDetailsTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionResponseDetailsTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionScreeningOperationTest.java
-src/test/java/com/fireblocks/sdk/model/ExecutionStepDetailsTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionStepErrorTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionStepStatusEnumTest.java
-src/test/java/com/fireblocks/sdk/model/ExecutionStepTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionStepTypeTest.java
src/test/java/com/fireblocks/sdk/model/ExecutionTransferOperationTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountLocalBankAfricaTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountLocalBankAfricaTypeTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountMobileMoneyProviderTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountMobileMoneyTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountMobileMoneyTypeTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountSenderInformationTest.java
src/test/java/com/fireblocks/sdk/model/ExternalAccountTest.java
+src/test/java/com/fireblocks/sdk/model/ExternalAccountTypeTest.java
src/test/java/com/fireblocks/sdk/model/ExternalWalletAssetTest.java
+src/test/java/com/fireblocks/sdk/model/FailureReasonTest.java
+src/test/java/com/fireblocks/sdk/model/FailureTest.java
src/test/java/com/fireblocks/sdk/model/FeeBreakdownOneOf1Test.java
src/test/java/com/fireblocks/sdk/model/FeeBreakdownOneOfTest.java
src/test/java/com/fireblocks/sdk/model/FeeBreakdownTest.java
@@ -2229,12 +2480,15 @@ src/test/java/com/fireblocks/sdk/model/FeeLevelTest.java
src/test/java/com/fireblocks/sdk/model/FeePayerInfoTest.java
src/test/java/com/fireblocks/sdk/model/FeePropertiesDetailsTest.java
src/test/java/com/fireblocks/sdk/model/FeeTest.java
+src/test/java/com/fireblocks/sdk/model/FeeTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/FetchAbiRequestDtoTest.java
src/test/java/com/fireblocks/sdk/model/FiatAccountTest.java
src/test/java/com/fireblocks/sdk/model/FiatAccountTypeTest.java
src/test/java/com/fireblocks/sdk/model/FiatAssetTest.java
src/test/java/com/fireblocks/sdk/model/FiatDestinationTest.java
+src/test/java/com/fireblocks/sdk/model/FiatPaymentMetadataTest.java
src/test/java/com/fireblocks/sdk/model/FiatTransferTest.java
+src/test/java/com/fireblocks/sdk/model/FixedAmountTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/FixedFeeTest.java
src/test/java/com/fireblocks/sdk/model/FreezeTransactionResponseTest.java
src/test/java/com/fireblocks/sdk/model/FunctionDocTest.java
@@ -2254,6 +2508,7 @@ src/test/java/com/fireblocks/sdk/model/GetFilterParameterTest.java
src/test/java/com/fireblocks/sdk/model/GetLayerZeroDvnConfigResponseTest.java
src/test/java/com/fireblocks/sdk/model/GetLayerZeroPeersResponseTest.java
src/test/java/com/fireblocks/sdk/model/GetLinkedCollectionsPaginatedResponseTest.java
+src/test/java/com/fireblocks/sdk/model/GetMaxBipIndexUsedResponseTest.java
src/test/java/com/fireblocks/sdk/model/GetMaxSpendableAmountResponseTest.java
src/test/java/com/fireblocks/sdk/model/GetMpcKeysResponseTest.java
src/test/java/com/fireblocks/sdk/model/GetNFTsResponseTest.java
@@ -2273,6 +2528,7 @@ src/test/java/com/fireblocks/sdk/model/IbanDestinationTest.java
src/test/java/com/fireblocks/sdk/model/IbanPaymentInfoTest.java
src/test/java/com/fireblocks/sdk/model/IdentificationTest.java
src/test/java/com/fireblocks/sdk/model/IdlTypeTest.java
+src/test/java/com/fireblocks/sdk/model/IndicativeQuoteEnumTest.java
src/test/java/com/fireblocks/sdk/model/IndicativeQuoteTypeTest.java
src/test/java/com/fireblocks/sdk/model/InitiatorConfigPatternTest.java
src/test/java/com/fireblocks/sdk/model/InitiatorConfigTest.java
@@ -2281,7 +2537,6 @@ src/test/java/com/fireblocks/sdk/model/InternalReferenceTest.java
src/test/java/com/fireblocks/sdk/model/InternalTransferResponseTest.java
src/test/java/com/fireblocks/sdk/model/InvalidParamaterValueErrorTest.java
src/test/java/com/fireblocks/sdk/model/JobCreatedTest.java
-src/test/java/com/fireblocks/sdk/model/JobTest.java
src/test/java/com/fireblocks/sdk/model/LayerZeroAdapterCreateParamsTest.java
src/test/java/com/fireblocks/sdk/model/LbtPaymentInfoTest.java
src/test/java/com/fireblocks/sdk/model/LeanAbiFunctionTest.java
@@ -2315,9 +2570,7 @@ src/test/java/com/fireblocks/sdk/model/LegacyPolicyValidationTest.java
src/test/java/com/fireblocks/sdk/model/LegacyPublishDraftRequestTest.java
src/test/java/com/fireblocks/sdk/model/LegacyPublishResultTest.java
src/test/java/com/fireblocks/sdk/model/LegacySrcOrDestAttributesInnerTest.java
-src/test/java/com/fireblocks/sdk/model/LimitExecutionRequestDetailsTest.java
-src/test/java/com/fireblocks/sdk/model/LimitExecutionResponseDetailsTest.java
-src/test/java/com/fireblocks/sdk/model/LimitTypeDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/LinkedTokensCountTest.java
src/test/java/com/fireblocks/sdk/model/ListAssetsResponseTest.java
src/test/java/com/fireblocks/sdk/model/ListBlockchainsResponseTest.java
src/test/java/com/fireblocks/sdk/model/ListOwnedCollectionsResponseTest.java
@@ -2328,7 +2581,9 @@ src/test/java/com/fireblocks/sdk/model/ManifestTest.java
src/test/java/com/fireblocks/sdk/model/MarketExecutionRequestDetailsTest.java
src/test/java/com/fireblocks/sdk/model/MarketExecutionResponseDetailsTest.java
src/test/java/com/fireblocks/sdk/model/MarketRequoteRequestDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/MarketRequoteTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/MarketTypeDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/MarketTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/MediaEntityResponseTest.java
src/test/java/com/fireblocks/sdk/model/MergeStakeAccountsRequestTest.java
src/test/java/com/fireblocks/sdk/model/MergeStakeAccountsResponseTest.java
@@ -2359,11 +2614,15 @@ src/test/java/com/fireblocks/sdk/model/NotificationPaginatedResponseTest.java
src/test/java/com/fireblocks/sdk/model/NotificationStatusTest.java
src/test/java/com/fireblocks/sdk/model/NotificationTest.java
src/test/java/com/fireblocks/sdk/model/NotificationWithDataTest.java
+src/test/java/com/fireblocks/sdk/model/OnchainTransactionTest.java
+src/test/java/com/fireblocks/sdk/model/OnchainTransactionsPagedResponseTest.java
src/test/java/com/fireblocks/sdk/model/OneTimeAddressAccountTest.java
+src/test/java/com/fireblocks/sdk/model/OneTimeAddressPeerTypeTest.java
src/test/java/com/fireblocks/sdk/model/OneTimeAddressReferenceTest.java
src/test/java/com/fireblocks/sdk/model/OneTimeAddressTest.java
src/test/java/com/fireblocks/sdk/model/OperationExecutionFailureTest.java
src/test/java/com/fireblocks/sdk/model/OrderDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/OrderExecutionStepTest.java
src/test/java/com/fireblocks/sdk/model/OrderSideTest.java
src/test/java/com/fireblocks/sdk/model/OrderStatusTest.java
src/test/java/com/fireblocks/sdk/model/OrderSummaryTest.java
@@ -2385,7 +2644,7 @@ src/test/java/com/fireblocks/sdk/model/PayeeAccountTypeTest.java
src/test/java/com/fireblocks/sdk/model/PaymentAccountResponseTest.java
src/test/java/com/fireblocks/sdk/model/PaymentAccountTest.java
src/test/java/com/fireblocks/sdk/model/PaymentAccountTypeTest.java
-src/test/java/com/fireblocks/sdk/model/PaymentInstructionsDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/PaymentInstructionsOneOfTest.java
src/test/java/com/fireblocks/sdk/model/PaymentInstructionsTest.java
src/test/java/com/fireblocks/sdk/model/PayoutInitMethodTest.java
src/test/java/com/fireblocks/sdk/model/PayoutInstructionResponseTest.java
@@ -2396,12 +2655,14 @@ src/test/java/com/fireblocks/sdk/model/PayoutStateTest.java
src/test/java/com/fireblocks/sdk/model/PayoutStatusTest.java
src/test/java/com/fireblocks/sdk/model/PeerAdapterInfoTest.java
src/test/java/com/fireblocks/sdk/model/PeerTypeTest.java
+src/test/java/com/fireblocks/sdk/model/PersonalEntityTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/PersonalIdentificationFullNameTest.java
src/test/java/com/fireblocks/sdk/model/PersonalIdentificationTest.java
src/test/java/com/fireblocks/sdk/model/PixAddressTest.java
src/test/java/com/fireblocks/sdk/model/PixDestinationTest.java
src/test/java/com/fireblocks/sdk/model/PixPaymentInfoTest.java
src/test/java/com/fireblocks/sdk/model/PlatformAccountTest.java
+src/test/java/com/fireblocks/sdk/model/PlatformPeerTypeTest.java
src/test/java/com/fireblocks/sdk/model/PlayersTest.java
src/test/java/com/fireblocks/sdk/model/PolicyAndValidationResponseTest.java
src/test/java/com/fireblocks/sdk/model/PolicyCheckResultTest.java
@@ -2418,24 +2679,24 @@ src/test/java/com/fireblocks/sdk/model/PolicyTypeTest.java
src/test/java/com/fireblocks/sdk/model/PolicyValidationTest.java
src/test/java/com/fireblocks/sdk/model/PolicyVerdictActionEnum2Test.java
src/test/java/com/fireblocks/sdk/model/PolicyVerdictActionEnumTest.java
-src/test/java/com/fireblocks/sdk/model/PostOrderSettlementTest.java
src/test/java/com/fireblocks/sdk/model/PostalAddressTest.java
src/test/java/com/fireblocks/sdk/model/PreScreeningTest.java
src/test/java/com/fireblocks/sdk/model/PrefundedSettlementTest.java
+src/test/java/com/fireblocks/sdk/model/PrefundedSettlementTypeTest.java
src/test/java/com/fireblocks/sdk/model/ProgramCallConfigTest.java
-src/test/java/com/fireblocks/sdk/model/ProviderIDTest.java
src/test/java/com/fireblocks/sdk/model/ProviderTest.java
src/test/java/com/fireblocks/sdk/model/ProvidersListResponseTest.java
src/test/java/com/fireblocks/sdk/model/PublicKeyInformationTest.java
src/test/java/com/fireblocks/sdk/model/PublishDraftRequestTest.java
src/test/java/com/fireblocks/sdk/model/PublishResultTest.java
src/test/java/com/fireblocks/sdk/model/QuoteExecutionRequestDetailsTest.java
-src/test/java/com/fireblocks/sdk/model/QuoteExecutionResponseDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/QuoteExecutionStepTest.java
src/test/java/com/fireblocks/sdk/model/QuoteExecutionTypeDetailsTest.java
src/test/java/com/fireblocks/sdk/model/QuoteExecutionWithRequoteRequestDetailsTest.java
src/test/java/com/fireblocks/sdk/model/QuoteExecutionWithRequoteResponseDetailsTest.java
src/test/java/com/fireblocks/sdk/model/QuotePropertiesDetailsTest.java
src/test/java/com/fireblocks/sdk/model/QuoteTest.java
+src/test/java/com/fireblocks/sdk/model/QuoteTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/QuotesResponseTest.java
src/test/java/com/fireblocks/sdk/model/ReQuoteDetailsReQuoteTest.java
src/test/java/com/fireblocks/sdk/model/ReQuoteDetailsTest.java
@@ -2453,9 +2714,10 @@ src/test/java/com/fireblocks/sdk/model/RemoveLayerZeroAdaptersRequestTest.java
src/test/java/com/fireblocks/sdk/model/RemoveLayerZeroAdaptersResponseTest.java
src/test/java/com/fireblocks/sdk/model/RemoveLayerZeroPeersRequestTest.java
src/test/java/com/fireblocks/sdk/model/RemoveLayerZeroPeersResponseTest.java
+src/test/java/com/fireblocks/sdk/model/RenameConnectedAccountRequestTest.java
+src/test/java/com/fireblocks/sdk/model/RenameConnectedAccountResponseTest.java
src/test/java/com/fireblocks/sdk/model/RenameCosignerTest.java
src/test/java/com/fireblocks/sdk/model/RenameVaultAccountResponseTest.java
-src/test/java/com/fireblocks/sdk/model/RescanTransactionTest.java
src/test/java/com/fireblocks/sdk/model/ResendFailedNotificationsJobStatusResponseTest.java
src/test/java/com/fireblocks/sdk/model/ResendFailedNotificationsRequestTest.java
src/test/java/com/fireblocks/sdk/model/ResendFailedNotificationsResponseTest.java
@@ -2465,12 +2727,16 @@ src/test/java/com/fireblocks/sdk/model/ResendWebhooksByTransactionIdResponseTest
src/test/java/com/fireblocks/sdk/model/ResendWebhooksResponseTest.java
src/test/java/com/fireblocks/sdk/model/RespondToConnectionRequestTest.java
src/test/java/com/fireblocks/sdk/model/RetryRequoteRequestDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/RetryRequoteTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/RewardInfoTest.java
src/test/java/com/fireblocks/sdk/model/RewardsInfoTest.java
+src/test/java/com/fireblocks/sdk/model/RoleDetailsTest.java
+src/test/java/com/fireblocks/sdk/model/RoleGranteeTest.java
src/test/java/com/fireblocks/sdk/model/SEPAAddressTest.java
src/test/java/com/fireblocks/sdk/model/SEPADestinationTest.java
src/test/java/com/fireblocks/sdk/model/SOLAccountTest.java
src/test/java/com/fireblocks/sdk/model/SOLAccountWithValueTest.java
+src/test/java/com/fireblocks/sdk/model/ScopeItemTest.java
src/test/java/com/fireblocks/sdk/model/ScreeningAlertExposureTypeEnumTest.java
src/test/java/com/fireblocks/sdk/model/ScreeningAmlAlertTest.java
src/test/java/com/fireblocks/sdk/model/ScreeningAmlMatchedRuleTest.java
@@ -2527,6 +2793,7 @@ src/test/java/com/fireblocks/sdk/model/SettlementRequestBodyTest.java
src/test/java/com/fireblocks/sdk/model/SettlementResponseTest.java
src/test/java/com/fireblocks/sdk/model/SettlementSourceAccountTest.java
src/test/java/com/fireblocks/sdk/model/SettlementTest.java
+src/test/java/com/fireblocks/sdk/model/SideTest.java
src/test/java/com/fireblocks/sdk/model/SignedMessageSignatureTest.java
src/test/java/com/fireblocks/sdk/model/SignedMessageTest.java
src/test/java/com/fireblocks/sdk/model/SigningKeyDtoTest.java
@@ -2573,26 +2840,69 @@ src/test/java/com/fireblocks/sdk/model/SpeiBasicPaymentInfoTest.java
src/test/java/com/fireblocks/sdk/model/SpeiDestinationTest.java
src/test/java/com/fireblocks/sdk/model/SplitRequestTest.java
src/test/java/com/fireblocks/sdk/model/SplitResponseTest.java
+src/test/java/com/fireblocks/sdk/model/StEthBlockchainDataTest.java
src/test/java/com/fireblocks/sdk/model/StakeRequestTest.java
src/test/java/com/fireblocks/sdk/model/StakeResponseTest.java
src/test/java/com/fireblocks/sdk/model/StakingProviderTest.java
src/test/java/com/fireblocks/sdk/model/StatusTest.java
src/test/java/com/fireblocks/sdk/model/StellarRippleCreateParamsDtoTest.java
+src/test/java/com/fireblocks/sdk/model/SupportedBlockChainsResponseTest.java
+src/test/java/com/fireblocks/sdk/model/SupportedBlockchainTest.java
src/test/java/com/fireblocks/sdk/model/SwiftAddressTest.java
src/test/java/com/fireblocks/sdk/model/SwiftDestinationTest.java
src/test/java/com/fireblocks/sdk/model/SystemMessageInfoTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAPIPagedResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAmount2Test.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAmountRangeTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkAmountTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssessTravelRuleRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssessTravelRuleResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssessmentDecisionTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssetDataTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssetFormatTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssetTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkAssetsListPagedResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCancelTrmRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkConnectIntegrationRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCreateCustomerRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCreateIntegrationRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCreateTrmRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCurrencyTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCustomerIntegrationResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkCustomerResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkDestinationTransferPeerPathTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkDiscoverableStatusTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkFiatValueTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkGeographicAddressRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkGetSupportedAssetResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkIvmsResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkIvmsTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkJwkPublicKeyTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmAction2Test.java
src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmActionEnumTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmActionTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmDecisionTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmRule2Test.java
src/test/java/com/fireblocks/sdk/model/TRLinkMissingTrmRuleTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkOneTimeAddressTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPagingTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPartnerResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPolicyResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPostScreeningActionTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPostScreeningRule2Test.java
src/test/java/com/fireblocks/sdk/model/TRLinkPostScreeningRuleTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPreScreeningAction2Test.java
src/test/java/com/fireblocks/sdk/model/TRLinkPreScreeningActionEnumTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkPreScreeningActionTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPreScreeningRule2Test.java
src/test/java/com/fireblocks/sdk/model/TRLinkPreScreeningRuleTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkProviderDataTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkProviderResultTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkProviderResultWithRule2Test.java
src/test/java/com/fireblocks/sdk/model/TRLinkProviderResultWithRuleTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPublicAssetInfoTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkPublicKeyResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkRedirectTrmRequestTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationResultFullPayloadTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationResultTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationStatusEnumTest.java
@@ -2600,22 +2910,39 @@ src/test/java/com/fireblocks/sdk/model/TRLinkRegistrationStatusTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkResultFullPayloadTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkResultTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkRuleBaseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkSetDestinationTravelRuleMessageIdRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkSetDestinationTravelRuleMessageIdResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkSetTransactionTravelRuleMessageIdRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkSetTransactionTravelRuleMessageIdResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkSourceTransferPeerPathTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTestConnectionResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkThresholdsTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTransactionDirectionTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTransferPeerPathTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTrmDirectionTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTrmInfoResponseTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkTrmScreeningStatusEnumTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkTrmScreeningStatusTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTrmStatusTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkTxnInfoTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkUpdateCustomerRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkVaspDtoTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkVaspGeographicAddressTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkVaspListDtoTest.java
+src/test/java/com/fireblocks/sdk/model/TRLinkVaspNationalIdentificationTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkVerdictEnumTest.java
src/test/java/com/fireblocks/sdk/model/TRLinkVerdictTest.java
src/test/java/com/fireblocks/sdk/model/TagAttachmentOperationActionTest.java
src/test/java/com/fireblocks/sdk/model/TagTest.java
src/test/java/com/fireblocks/sdk/model/TagsPagedResponseTest.java
-src/test/java/com/fireblocks/sdk/model/TaskTest.java
src/test/java/com/fireblocks/sdk/model/TemplatesPaginatedResponseTest.java
src/test/java/com/fireblocks/sdk/model/ThirdPartyRoutingTest.java
-src/test/java/com/fireblocks/sdk/model/TimeInForceTest.java
src/test/java/com/fireblocks/sdk/model/TimePeriodConfigTest.java
src/test/java/com/fireblocks/sdk/model/TimePeriodMatchTypeTest.java
src/test/java/com/fireblocks/sdk/model/ToCollateralTransactionTest.java
src/test/java/com/fireblocks/sdk/model/ToExchangeTransactionTest.java
src/test/java/com/fireblocks/sdk/model/TokenCollectionResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TokenContractSummaryResponseTest.java
src/test/java/com/fireblocks/sdk/model/TokenInfoNotFoundErrorResponseTest.java
src/test/java/com/fireblocks/sdk/model/TokenLinkDtoTest.java
src/test/java/com/fireblocks/sdk/model/TokenLinkDtoTokenMetadataTest.java
@@ -2627,9 +2954,10 @@ src/test/java/com/fireblocks/sdk/model/TokenOwnershipSpamUpdatePayloadTest.java
src/test/java/com/fireblocks/sdk/model/TokenOwnershipStatusUpdatePayloadTest.java
src/test/java/com/fireblocks/sdk/model/TokenResponseTest.java
src/test/java/com/fireblocks/sdk/model/TokensPaginatedResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TotalSupplyItemDtoTest.java
+src/test/java/com/fireblocks/sdk/model/TotalSupplyPagedResponseTest.java
src/test/java/com/fireblocks/sdk/model/TradingAccountTypeTest.java
-src/test/java/com/fireblocks/sdk/model/TradingErrorResponseErrorTest.java
-src/test/java/com/fireblocks/sdk/model/TradingErrorResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TradingErrorSchemaTest.java
src/test/java/com/fireblocks/sdk/model/TradingProviderTest.java
src/test/java/com/fireblocks/sdk/model/TransactionDirectionTest.java
src/test/java/com/fireblocks/sdk/model/TransactionFeeTest.java
@@ -2708,7 +3036,11 @@ src/test/java/com/fireblocks/sdk/model/TravelRuleValidateTransactionRequestTest.
src/test/java/com/fireblocks/sdk/model/TravelRuleValidateTransactionResponseTest.java
src/test/java/com/fireblocks/sdk/model/TravelRuleVaspForVaultTest.java
src/test/java/com/fireblocks/sdk/model/TravelRuleVerdictEnumTest.java
+src/test/java/com/fireblocks/sdk/model/TrustProofOfAddressCreateResponseTest.java
+src/test/java/com/fireblocks/sdk/model/TrustProofOfAddressRequestTest.java
+src/test/java/com/fireblocks/sdk/model/TrustProofOfAddressResponseTest.java
src/test/java/com/fireblocks/sdk/model/TxLogTest.java
+src/test/java/com/fireblocks/sdk/model/TypedMessageTransactionStatusEnumTest.java
src/test/java/com/fireblocks/sdk/model/USWireAddressTest.java
src/test/java/com/fireblocks/sdk/model/USWireDestinationTest.java
src/test/java/com/fireblocks/sdk/model/UnfreezeTransactionResponseTest.java
@@ -2736,7 +3068,6 @@ src/test/java/com/fireblocks/sdk/model/UserStatusTest.java
src/test/java/com/fireblocks/sdk/model/UserTypeTest.java
src/test/java/com/fireblocks/sdk/model/ValidateAddressResponseTest.java
src/test/java/com/fireblocks/sdk/model/ValidateLayerZeroChannelResponseTest.java
-src/test/java/com/fireblocks/sdk/model/ValidatedTransactionsForRescanTest.java
src/test/java/com/fireblocks/sdk/model/ValidationKeyDtoTest.java
src/test/java/com/fireblocks/sdk/model/ValidatorTest.java
src/test/java/com/fireblocks/sdk/model/VaultAccountTagAttachmentOperationTest.java
@@ -2747,13 +3078,12 @@ src/test/java/com/fireblocks/sdk/model/VaultAccountsPagedResponsePagingTest.java
src/test/java/com/fireblocks/sdk/model/VaultAccountsPagedResponseTest.java
src/test/java/com/fireblocks/sdk/model/VaultAccountsTagAttachmentOperationsRequestTest.java
src/test/java/com/fireblocks/sdk/model/VaultAccountsTagAttachmentOperationsResponseTest.java
-src/test/java/com/fireblocks/sdk/model/VaultAccountsTagAttachmentsRequestTest.java
src/test/java/com/fireblocks/sdk/model/VaultActionStatusTest.java
src/test/java/com/fireblocks/sdk/model/VaultAssetTest.java
src/test/java/com/fireblocks/sdk/model/VaultWalletAddressTest.java
src/test/java/com/fireblocks/sdk/model/VendorDtoTest.java
src/test/java/com/fireblocks/sdk/model/VerdictConfigTest.java
-src/test/java/com/fireblocks/sdk/model/VersionTest.java
+src/test/java/com/fireblocks/sdk/model/VersionSummaryTest.java
src/test/java/com/fireblocks/sdk/model/WalletAssetAdditionalInfoTest.java
src/test/java/com/fireblocks/sdk/model/WalletAssetTest.java
src/test/java/com/fireblocks/sdk/model/WebhookEventTest.java
diff --git a/README.md b/README.md
index 8734461f..0e3c025b 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Add this dependency to your project's POM:
com.fireblocks.sdk
fireblocks-sdk
- 13.0.0
+ 0.0.0
compile
```
@@ -42,7 +42,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:
```groovy
-compile "com.fireblocks.sdk:fireblocks-sdk:13.0.0"
+compile "com.fireblocks.sdk:fireblocks-sdk:0.0.0"
```
### Others
@@ -55,7 +55,7 @@ mvn clean package
Then manually install the following JARs:
-- `target/fireblocks-sdk-13.0.0.jar`
+- `target/fireblocks-sdk-0.0.0.jar`
- `target/lib/*.jar`
@@ -141,13 +141,12 @@ All URIs are relative to *https://api.fireblocks.io/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
-*ApiUserApi* | [**createApiUser**](docs/ApiUserApi.md#createApiUser) | **POST** /management/api_users | Create Api user
-*ApiUserApi* | [**getApiUsers**](docs/ApiUserApi.md#getApiUsers) | **GET** /management/api_users | Get Api users
-*AssetsApi* | [**createAssetsBulk**](docs/AssetsApi.md#createAssetsBulk) | **POST** /vault/assets/bulk | Bulk creation of wallets
+*ApiUserApi* | [**createApiUser**](docs/ApiUserApi.md#createApiUser) | **POST** /management/api_users | Create API Key
+*ApiUserApi* | [**getApiUsers**](docs/ApiUserApi.md#getApiUsers) | **GET** /management/api_users | Get API Keys
*AuditLogsApi* | [**getAuditLogs**](docs/AuditLogsApi.md#getAuditLogs) | **GET** /management/audit_logs | Get audit logs
*BlockchainsAssetsApi* | [**getAsset**](docs/BlockchainsAssetsApi.md#getAsset) | **GET** /assets/{id} | Get an asset
-*BlockchainsAssetsApi* | [**getBlockchain**](docs/BlockchainsAssetsApi.md#getBlockchain) | **GET** /blockchains/{id} | Get an blockchain
-*BlockchainsAssetsApi* | [**getSupportedAssets**](docs/BlockchainsAssetsApi.md#getSupportedAssets) | **GET** /supported_assets | List all asset types supported by Fireblocks - legacy endpoint
+*BlockchainsAssetsApi* | [**getBlockchain**](docs/BlockchainsAssetsApi.md#getBlockchain) | **GET** /blockchains/{id} | Get a Blockchain by ID
+*BlockchainsAssetsApi* | [**getSupportedAssets**](docs/BlockchainsAssetsApi.md#getSupportedAssets) | **GET** /supported_assets | List assets (Legacy)
*BlockchainsAssetsApi* | [**listAssets**](docs/BlockchainsAssetsApi.md#listAssets) | **GET** /assets | List assets
*BlockchainsAssetsApi* | [**listBlockchains**](docs/BlockchainsAssetsApi.md#listBlockchains) | **GET** /blockchains | List blockchains
*BlockchainsAssetsApi* | [**registerNewAsset**](docs/BlockchainsAssetsApi.md#registerNewAsset) | **POST** /assets | Register an asset
@@ -165,14 +164,17 @@ Class | Method | HTTP request | Description
*ComplianceApi* | [**updateTravelRuleConfig**](docs/ComplianceApi.md#updateTravelRuleConfig) | **PUT** /screening/travel_rule/policy_configuration | Update Travel Rule Configuration
*ComplianceScreeningConfigurationApi* | [**getAmlScreeningConfiguration**](docs/ComplianceScreeningConfigurationApi.md#getAmlScreeningConfiguration) | **GET** /screening/aml/policy_configuration | Get AML Screening Policy Configuration
*ComplianceScreeningConfigurationApi* | [**getScreeningConfiguration**](docs/ComplianceScreeningConfigurationApi.md#getScreeningConfiguration) | **GET** /screening/travel_rule/policy_configuration | Get Travel Rule Screening Policy Configuration
+*ConnectedAccountsBetaApi* | [**disconnectConnectedAccount**](docs/ConnectedAccountsBetaApi.md#disconnectConnectedAccount) | **DELETE** /connected_accounts/{accountId} | Disconnect connected account
*ConnectedAccountsBetaApi* | [**getConnectedAccount**](docs/ConnectedAccountsBetaApi.md#getConnectedAccount) | **GET** /connected_accounts/{accountId} | Get connected account
*ConnectedAccountsBetaApi* | [**getConnectedAccountBalances**](docs/ConnectedAccountsBetaApi.md#getConnectedAccountBalances) | **GET** /connected_accounts/{accountId}/balances | Get balances for an account
*ConnectedAccountsBetaApi* | [**getConnectedAccountRates**](docs/ConnectedAccountsBetaApi.md#getConnectedAccountRates) | **GET** /connected_accounts/{accountId}/rates | Get exchange rates for an account
*ConnectedAccountsBetaApi* | [**getConnectedAccountTradingPairs**](docs/ConnectedAccountsBetaApi.md#getConnectedAccountTradingPairs) | **GET** /connected_accounts/{accountId}/manifest/capabilities/trading/pairs | Get supported trading pairs for an account
*ConnectedAccountsBetaApi* | [**getConnectedAccounts**](docs/ConnectedAccountsBetaApi.md#getConnectedAccounts) | **GET** /connected_accounts | Get connected accounts
+*ConnectedAccountsBetaApi* | [**renameConnectedAccount**](docs/ConnectedAccountsBetaApi.md#renameConnectedAccount) | **POST** /connected_accounts/{accountId}/rename | Rename Connected Account
*ConsoleUserApi* | [**createConsoleUser**](docs/ConsoleUserApi.md#createConsoleUser) | **POST** /management/users | Create console user
*ConsoleUserApi* | [**getConsoleUsers**](docs/ConsoleUserApi.md#getConsoleUsers) | **GET** /management/users | Get console users
*ContractInteractionsApi* | [**decodeContractData**](docs/ContractInteractionsApi.md#decodeContractData) | **POST** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decode | Decode a function call data, error, or event log
+*ContractInteractionsApi* | [**getContractAddress**](docs/ContractInteractionsApi.md#getContractAddress) | **GET** /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash} | Get contract address by transaction hash
*ContractInteractionsApi* | [**getDeployedContractAbi**](docs/ContractInteractionsApi.md#getDeployedContractAbi) | **GET** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions | Return deployed contract's ABI
*ContractInteractionsApi* | [**getTransactionReceipt**](docs/ContractInteractionsApi.md#getTransactionReceipt) | **GET** /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt | Get transaction receipt
*ContractInteractionsApi* | [**readCallFunction**](docs/ContractInteractionsApi.md#readCallFunction) | **POST** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read | Call a read function on a deployed contract
@@ -183,14 +185,15 @@ Class | Method | HTTP request | Description
*ContractTemplatesApi* | [**getContractTemplateById**](docs/ContractTemplatesApi.md#getContractTemplateById) | **GET** /tokenization/templates/{contractTemplateId} | Return contract template by id
*ContractTemplatesApi* | [**getContractTemplates**](docs/ContractTemplatesApi.md#getContractTemplates) | **GET** /tokenization/templates | List all contract templates
*ContractTemplatesApi* | [**getFunctionAbiByContractTemplateId**](docs/ContractTemplatesApi.md#getFunctionAbiByContractTemplateId) | **GET** /tokenization/templates/{contractTemplateId}/function | Return contract template's function
+*ContractTemplatesApi* | [**getSupportedBlockchainsByTemplateId**](docs/ContractTemplatesApi.md#getSupportedBlockchainsByTemplateId) | **GET** /tokenization/templates/{contractTemplateId}/supported_blockchains | Get supported blockchains for the template
*ContractTemplatesApi* | [**uploadContractTemplate**](docs/ContractTemplatesApi.md#uploadContractTemplate) | **POST** /tokenization/templates | Upload contract template
-*ContractsApi* | [**addContractAsset**](docs/ContractsApi.md#addContractAsset) | **POST** /contracts/{contractId}/{assetId} | Add an asset to a contract
-*ContractsApi* | [**createContract**](docs/ContractsApi.md#createContract) | **POST** /contracts | Create a contract
+*ContractsApi* | [**addContractAsset**](docs/ContractsApi.md#addContractAsset) | **POST** /contracts/{contractId}/{assetId} | Add an asset to a whitelisted contract
+*ContractsApi* | [**createContract**](docs/ContractsApi.md#createContract) | **POST** /contracts | Add a contract
*ContractsApi* | [**deleteContract**](docs/ContractsApi.md#deleteContract) | **DELETE** /contracts/{contractId} | Delete a contract
-*ContractsApi* | [**deleteContractAsset**](docs/ContractsApi.md#deleteContractAsset) | **DELETE** /contracts/{contractId}/{assetId} | Delete a contract asset
-*ContractsApi* | [**getContract**](docs/ContractsApi.md#getContract) | **GET** /contracts/{contractId} | Find a specific contract
-*ContractsApi* | [**getContractAsset**](docs/ContractsApi.md#getContractAsset) | **GET** /contracts/{contractId}/{assetId} | Find a contract asset
-*ContractsApi* | [**getContracts**](docs/ContractsApi.md#getContracts) | **GET** /contracts | List contracts
+*ContractsApi* | [**deleteContractAsset**](docs/ContractsApi.md#deleteContractAsset) | **DELETE** /contracts/{contractId}/{assetId} | Delete an asset from a whitelisted contract
+*ContractsApi* | [**getContract**](docs/ContractsApi.md#getContract) | **GET** /contracts/{contractId} | Find a Specific Whitelisted Contract
+*ContractsApi* | [**getContractAsset**](docs/ContractsApi.md#getContractAsset) | **GET** /contracts/{contractId}/{assetId} | Find a whitelisted contract's asset
+*ContractsApi* | [**getContracts**](docs/ContractsApi.md#getContracts) | **GET** /contracts | List Whitelisted Contracts
*CosignersBetaApi* | [**addCosigner**](docs/CosignersBetaApi.md#addCosigner) | **POST** /cosigners | Add cosigner
*CosignersBetaApi* | [**getApiKey**](docs/CosignersBetaApi.md#getApiKey) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key
*CosignersBetaApi* | [**getApiKeys**](docs/CosignersBetaApi.md#getApiKeys) | **GET** /cosigners/{cosignerId}/api_keys | Get all API keys
@@ -207,6 +210,7 @@ Class | Method | HTTP request | Description
*DeployedContractsApi* | [**getDeployedContractById**](docs/DeployedContractsApi.md#getDeployedContractById) | **GET** /tokenization/contracts/{id} | Return deployed contract data by id
*DeployedContractsApi* | [**getDeployedContracts**](docs/DeployedContractsApi.md#getDeployedContracts) | **GET** /tokenization/contracts | List deployed contracts data
*EmbeddedWalletsApi* | [**addEmbeddedWalletAsset**](docs/EmbeddedWalletsApi.md#addEmbeddedWalletAsset) | **POST** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} | Add asset to account
+*EmbeddedWalletsApi* | [**assignEmbeddedWallet**](docs/EmbeddedWalletsApi.md#assignEmbeddedWallet) | **POST** /ncw/wallets/{walletId}/assign | Assign a wallet
*EmbeddedWalletsApi* | [**createEmbeddedWallet**](docs/EmbeddedWalletsApi.md#createEmbeddedWallet) | **POST** /ncw/wallets | Create a new wallet
*EmbeddedWalletsApi* | [**createEmbeddedWalletAccount**](docs/EmbeddedWalletsApi.md#createEmbeddedWalletAccount) | **POST** /ncw/wallets/{walletId}/accounts | Create a new account
*EmbeddedWalletsApi* | [**getEmbeddedWallet**](docs/EmbeddedWalletsApi.md#getEmbeddedWallet) | **GET** /ncw/wallets/{walletId} | Get a wallet
@@ -214,20 +218,25 @@ Class | Method | HTTP request | Description
*EmbeddedWalletsApi* | [**getEmbeddedWalletAddresses**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletAddresses) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses | Retrieve asset addresses
*EmbeddedWalletsApi* | [**getEmbeddedWalletAsset**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletAsset) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} | Retrieve asset
*EmbeddedWalletsApi* | [**getEmbeddedWalletAssetBalance**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletAssetBalance) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance | Retrieve asset balance
+*EmbeddedWalletsApi* | [**getEmbeddedWalletAssets**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletAssets) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets | Retrieve assets
*EmbeddedWalletsApi* | [**getEmbeddedWalletDevice**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletDevice) | **GET** /ncw/wallets/{walletId}/devices/{deviceId} | Get Embedded Wallet Device
*EmbeddedWalletsApi* | [**getEmbeddedWalletDeviceSetupState**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletDeviceSetupState) | **GET** /ncw/wallets/{walletId}/devices/{deviceId}/setup_status | Get device key setup state
+*EmbeddedWalletsApi* | [**getEmbeddedWalletDevicesPaginated**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletDevicesPaginated) | **GET** /ncw/wallets/{walletId}/devices_paginated | Get registered devices - paginated
*EmbeddedWalletsApi* | [**getEmbeddedWalletLatestBackup**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletLatestBackup) | **GET** /ncw/wallets/{walletId}/backup/latest | Get wallet Latest Backup details
*EmbeddedWalletsApi* | [**getEmbeddedWalletPublicKeyInfoForAddress**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletPublicKeyInfoForAddress) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_info | Get the public key of an asset
+*EmbeddedWalletsApi* | [**getEmbeddedWalletSetupStatus**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletSetupStatus) | **GET** /ncw/wallets/{walletId}/setup_status | Get wallet key setup state
*EmbeddedWalletsApi* | [**getEmbeddedWalletSupportedAssets**](docs/EmbeddedWalletsApi.md#getEmbeddedWalletSupportedAssets) | **GET** /ncw/wallets/supported_assets | Retrieve supported assets
*EmbeddedWalletsApi* | [**getEmbeddedWallets**](docs/EmbeddedWalletsApi.md#getEmbeddedWallets) | **GET** /ncw/wallets | List wallets
*EmbeddedWalletsApi* | [**getPublicKeyInfoNcw**](docs/EmbeddedWalletsApi.md#getPublicKeyInfoNcw) | **GET** /ncw/wallets/{walletId}/public_key_info | Get the public key for a derivation path
*EmbeddedWalletsApi* | [**refreshEmbeddedWalletAssetBalance**](docs/EmbeddedWalletsApi.md#refreshEmbeddedWalletAssetBalance) | **PUT** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance | Refresh asset balance
+*EmbeddedWalletsApi* | [**updateEmbeddedWalletDeviceStatus**](docs/EmbeddedWalletsApi.md#updateEmbeddedWalletDeviceStatus) | **PATCH** /ncw/wallets/{walletId}/devices/{deviceId}/status | Update device status
+*EmbeddedWalletsApi* | [**updateEmbeddedWalletStatus**](docs/EmbeddedWalletsApi.md#updateEmbeddedWalletStatus) | **PATCH** /ncw/wallets/{walletId}/status | Update wallet status
*ExchangeAccountsApi* | [**addExchangeAccount**](docs/ExchangeAccountsApi.md#addExchangeAccount) | **POST** /exchange_accounts | Add an exchange account
-*ExchangeAccountsApi* | [**convertAssets**](docs/ExchangeAccountsApi.md#convertAssets) | **POST** /exchange_accounts/{exchangeAccountId}/convert | Convert exchange account funds from the source asset to the destination asset.
-*ExchangeAccountsApi* | [**getExchangeAccount**](docs/ExchangeAccountsApi.md#getExchangeAccount) | **GET** /exchange_accounts/{exchangeAccountId} | Find a specific exchange account
-*ExchangeAccountsApi* | [**getExchangeAccountAsset**](docs/ExchangeAccountsApi.md#getExchangeAccountAsset) | **GET** /exchange_accounts/{exchangeAccountId}/{assetId} | Find an asset for an exchange account
+*ExchangeAccountsApi* | [**convertAssets**](docs/ExchangeAccountsApi.md#convertAssets) | **POST** /exchange_accounts/{exchangeAccountId}/convert | Convert exchange account funds
+*ExchangeAccountsApi* | [**getExchangeAccount**](docs/ExchangeAccountsApi.md#getExchangeAccount) | **GET** /exchange_accounts/{exchangeAccountId} | Get a specific exchange account
+*ExchangeAccountsApi* | [**getExchangeAccountAsset**](docs/ExchangeAccountsApi.md#getExchangeAccountAsset) | **GET** /exchange_accounts/{exchangeAccountId}/{assetId} | Get an asset for an exchange account
*ExchangeAccountsApi* | [**getExchangeAccountsCredentialsPublicKey**](docs/ExchangeAccountsApi.md#getExchangeAccountsCredentialsPublicKey) | **GET** /exchange_accounts/credentials_public_key | Get public key to encrypt exchange credentials
-*ExchangeAccountsApi* | [**getPagedExchangeAccounts**](docs/ExchangeAccountsApi.md#getPagedExchangeAccounts) | **GET** /exchange_accounts/paged | Pagination list exchange accounts
+*ExchangeAccountsApi* | [**getPagedExchangeAccounts**](docs/ExchangeAccountsApi.md#getPagedExchangeAccounts) | **GET** /exchange_accounts/paged | List connected exchange accounts
*ExchangeAccountsApi* | [**internalTransfer**](docs/ExchangeAccountsApi.md#internalTransfer) | **POST** /exchange_accounts/{exchangeAccountId}/internal_transfer | Internal transfer for exchange accounts
*ExternalWalletsApi* | [**addAssetToExternalWallet**](docs/ExternalWalletsApi.md#addAssetToExternalWallet) | **POST** /external_wallets/{walletId}/{assetId} | Add an asset to an external wallet.
*ExternalWalletsApi* | [**createExternalWallet**](docs/ExternalWalletsApi.md#createExternalWallet) | **POST** /external_wallets | Create an external wallet
@@ -249,17 +258,11 @@ Class | Method | HTTP request | Description
*InternalWalletsApi* | [**createInternalWalletAsset**](docs/InternalWalletsApi.md#createInternalWalletAsset) | **POST** /internal_wallets/{walletId}/{assetId} | Add an asset to an internal wallet
*InternalWalletsApi* | [**deleteInternalWallet**](docs/InternalWalletsApi.md#deleteInternalWallet) | **DELETE** /internal_wallets/{walletId} | Delete an internal wallet
*InternalWalletsApi* | [**deleteInternalWalletAsset**](docs/InternalWalletsApi.md#deleteInternalWalletAsset) | **DELETE** /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address
-*InternalWalletsApi* | [**getInternalWallet**](docs/InternalWalletsApi.md#getInternalWallet) | **GET** /internal_wallets/{walletId} | Get an asset from an internal wallet
+*InternalWalletsApi* | [**getInternalWallet**](docs/InternalWalletsApi.md#getInternalWallet) | **GET** /internal_wallets/{walletId} | Get assets for internal wallet
*InternalWalletsApi* | [**getInternalWalletAsset**](docs/InternalWalletsApi.md#getInternalWalletAsset) | **GET** /internal_wallets/{walletId}/{assetId} | Get an asset from an internal wallet
*InternalWalletsApi* | [**getInternalWalletAssetsPaginated**](docs/InternalWalletsApi.md#getInternalWalletAssetsPaginated) | **GET** /internal_wallets/{walletId}/assets | List assets in an internal wallet (Paginated)
*InternalWalletsApi* | [**getInternalWallets**](docs/InternalWalletsApi.md#getInternalWallets) | **GET** /internal_wallets | List internal wallets
-*InternalWalletsApi* | [**setCustomerRefIdForInternalWallet**](docs/InternalWalletsApi.md#setCustomerRefIdForInternalWallet) | **POST** /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for an internal wallet
-*JobManagementApi* | [**cancelJob**](docs/JobManagementApi.md#cancelJob) | **POST** /batch/{jobId}/cancel | Cancel a running job
-*JobManagementApi* | [**continueJob**](docs/JobManagementApi.md#continueJob) | **POST** /batch/{jobId}/continue | Continue a paused job
-*JobManagementApi* | [**getJob**](docs/JobManagementApi.md#getJob) | **GET** /batch/{jobId} | Get job details
-*JobManagementApi* | [**getJobTasks**](docs/JobManagementApi.md#getJobTasks) | **GET** /batch/{jobId}/tasks | Return a list of tasks for given job
-*JobManagementApi* | [**getJobs**](docs/JobManagementApi.md#getJobs) | **GET** /batch/jobs | Return a list of jobs belonging to tenant
-*JobManagementApi* | [**pauseJob**](docs/JobManagementApi.md#pauseJob) | **POST** /batch/{jobId}/pause | Pause a job
+*InternalWalletsApi* | [**setCustomerRefIdForInternalWallet**](docs/InternalWalletsApi.md#setCustomerRefIdForInternalWallet) | **POST** /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for internal wallet
*KeyLinkBetaApi* | [**createSigningKey**](docs/KeyLinkBetaApi.md#createSigningKey) | **POST** /key_link/signing_keys | Add a new signing key
*KeyLinkBetaApi* | [**createValidationKey**](docs/KeyLinkBetaApi.md#createValidationKey) | **POST** /key_link/validation_keys | Add a new validation key
*KeyLinkBetaApi* | [**disableValidationKey**](docs/KeyLinkBetaApi.md#disableValidationKey) | **PATCH** /key_link/validation_keys/{keyId} | Disables a validation key
@@ -267,21 +270,21 @@ Class | Method | HTTP request | Description
*KeyLinkBetaApi* | [**getSigningKeysList**](docs/KeyLinkBetaApi.md#getSigningKeysList) | **GET** /key_link/signing_keys | Get list of signing keys
*KeyLinkBetaApi* | [**getValidationKey**](docs/KeyLinkBetaApi.md#getValidationKey) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by `keyId`
*KeyLinkBetaApi* | [**getValidationKeysList**](docs/KeyLinkBetaApi.md#getValidationKeysList) | **GET** /key_link/validation_keys | Get list of registered validation keys
-*KeyLinkBetaApi* | [**setAgentId**](docs/KeyLinkBetaApi.md#setAgentId) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id that can sign with the signing key identified by the Fireblocks provided `keyId`
-*KeyLinkBetaApi* | [**updateSigningKey**](docs/KeyLinkBetaApi.md#updateSigningKey) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing by Fireblocks provided `keyId`
+*KeyLinkBetaApi* | [**setAgentId**](docs/KeyLinkBetaApi.md#setAgentId) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id
+*KeyLinkBetaApi* | [**updateSigningKey**](docs/KeyLinkBetaApi.md#updateSigningKey) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing keyId
*KeysBetaApi* | [**getMpcKeysList**](docs/KeysBetaApi.md#getMpcKeysList) | **GET** /keys/mpc/list | Get list of mpc keys
*KeysBetaApi* | [**getMpcKeysListByUser**](docs/KeysBetaApi.md#getMpcKeysListByUser) | **GET** /keys/mpc/list/{userId} | Get list of mpc keys by `userId`
-*NetworkConnectionsApi* | [**checkThirdPartyRouting**](docs/NetworkConnectionsApi.md#checkThirdPartyRouting) | **GET** /network_connections/{connectionId}/is_third_party_routing/{assetType} | Retrieve third-party network routing validation by asset type.
-*NetworkConnectionsApi* | [**createNetworkConnection**](docs/NetworkConnectionsApi.md#createNetworkConnection) | **POST** /network_connections | Creates a new network connection
+*NetworkConnectionsApi* | [**checkThirdPartyRouting**](docs/NetworkConnectionsApi.md#checkThirdPartyRouting) | **GET** /network_connections/{connectionId}/is_third_party_routing/{assetType} | Retrieve third-party network routing validation
+*NetworkConnectionsApi* | [**createNetworkConnection**](docs/NetworkConnectionsApi.md#createNetworkConnection) | **POST** /network_connections | Create a new network connection
*NetworkConnectionsApi* | [**createNetworkId**](docs/NetworkConnectionsApi.md#createNetworkId) | **POST** /network_ids | Creates a new Network ID
*NetworkConnectionsApi* | [**deleteNetworkConnection**](docs/NetworkConnectionsApi.md#deleteNetworkConnection) | **DELETE** /network_connections/{connectionId} | Deletes a network connection by ID
*NetworkConnectionsApi* | [**deleteNetworkId**](docs/NetworkConnectionsApi.md#deleteNetworkId) | **DELETE** /network_ids/{networkId} | Deletes specific network ID.
*NetworkConnectionsApi* | [**getNetwork**](docs/NetworkConnectionsApi.md#getNetwork) | **GET** /network_connections/{connectionId} | Get a network connection
*NetworkConnectionsApi* | [**getNetworkConnections**](docs/NetworkConnectionsApi.md#getNetworkConnections) | **GET** /network_connections | List network connections
*NetworkConnectionsApi* | [**getNetworkId**](docs/NetworkConnectionsApi.md#getNetworkId) | **GET** /network_ids/{networkId} | Returns specific network ID.
-*NetworkConnectionsApi* | [**getNetworkIds**](docs/NetworkConnectionsApi.md#getNetworkIds) | **GET** /network_ids | Returns all network IDs, both local IDs and discoverable remote IDs
+*NetworkConnectionsApi* | [**getNetworkIds**](docs/NetworkConnectionsApi.md#getNetworkIds) | **GET** /network_ids | Get all network IDs
*NetworkConnectionsApi* | [**getRoutingPolicyAssetGroups**](docs/NetworkConnectionsApi.md#getRoutingPolicyAssetGroups) | **GET** /network_ids/routing_policy_asset_groups | Returns all enabled routing policy asset groups
-*NetworkConnectionsApi* | [**searchNetworkIds**](docs/NetworkConnectionsApi.md#searchNetworkIds) | **GET** /network_ids/search | Search network IDs, both local IDs and discoverable remote IDs
+*NetworkConnectionsApi* | [**searchNetworkIds**](docs/NetworkConnectionsApi.md#searchNetworkIds) | **GET** /network_ids/search | Get both local IDs and discoverable remote IDs
*NetworkConnectionsApi* | [**setNetworkIdDiscoverability**](docs/NetworkConnectionsApi.md#setNetworkIdDiscoverability) | **PATCH** /network_ids/{networkId}/set_discoverability | Update network ID's discoverability.
*NetworkConnectionsApi* | [**setNetworkIdName**](docs/NetworkConnectionsApi.md#setNetworkIdName) | **PATCH** /network_ids/{networkId}/set_name | Update network ID's name.
*NetworkConnectionsApi* | [**setNetworkIdRoutingPolicy**](docs/NetworkConnectionsApi.md#setNetworkIdRoutingPolicy) | **PATCH** /network_ids/{networkId}/set_routing_policy | Update network id routing policy.
@@ -296,11 +299,19 @@ Class | Method | HTTP request | Description
*NftsApi* | [**updateTokenOwnershipStatus**](docs/NftsApi.md#updateTokenOwnershipStatus) | **PUT** /nfts/ownership/tokens/{id}/status | Update token ownership status
*NftsApi* | [**updateTokensOwnershipSpam**](docs/NftsApi.md#updateTokensOwnershipSpam) | **PUT** /nfts/ownership/tokens/spam | Update tokens ownership spam property
*NftsApi* | [**updateTokensOwnershipStatus**](docs/NftsApi.md#updateTokensOwnershipStatus) | **PUT** /nfts/ownership/tokens/status | Update tokens ownership status
-*OffExchangesApi* | [**addOffExchange**](docs/OffExchangesApi.md#addOffExchange) | **POST** /off_exchange/add | add collateral
+*OffExchangesApi* | [**addOffExchange**](docs/OffExchangesApi.md#addOffExchange) | **POST** /off_exchange/add | Add Collateral
*OffExchangesApi* | [**getOffExchangeCollateralAccounts**](docs/OffExchangesApi.md#getOffExchangeCollateralAccounts) | **GET** /off_exchange/collateral_accounts/{mainExchangeAccountId} | Find a specific collateral exchange account
-*OffExchangesApi* | [**getOffExchangeSettlementTransactions**](docs/OffExchangesApi.md#getOffExchangeSettlementTransactions) | **GET** /off_exchange/settlements/transactions | get settlements transactions from exchange
-*OffExchangesApi* | [**removeOffExchange**](docs/OffExchangesApi.md#removeOffExchange) | **POST** /off_exchange/remove | remove collateral
-*OffExchangesApi* | [**settleOffExchangeTrades**](docs/OffExchangesApi.md#settleOffExchangeTrades) | **POST** /off_exchange/settlements/trader | create settlement for a trader
+*OffExchangesApi* | [**getOffExchangeSettlementTransactions**](docs/OffExchangesApi.md#getOffExchangeSettlementTransactions) | **GET** /off_exchange/settlements/transactions | Get Settlements Transactions
+*OffExchangesApi* | [**removeOffExchange**](docs/OffExchangesApi.md#removeOffExchange) | **POST** /off_exchange/remove | Remove Collateral
+*OffExchangesApi* | [**settleOffExchangeTrades**](docs/OffExchangesApi.md#settleOffExchangeTrades) | **POST** /off_exchange/settlements/trader | Create Settlement for a Trader
+*OnchainDataApi* | [**getAccessRegistryCurrentState**](docs/OnchainDataApi.md#getAccessRegistryCurrentState) | **GET** /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/list | Get the current state of addresses in an access registry
+*OnchainDataApi* | [**getAccessRegistrySummary**](docs/OnchainDataApi.md#getAccessRegistrySummary) | **GET** /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/summary | Summary of access registry state
+*OnchainDataApi* | [**getActiveRolesForContract**](docs/OnchainDataApi.md#getActiveRolesForContract) | **GET** /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/roles | List of active roles for a given contract address and base asset ID
+*OnchainDataApi* | [**getContractBalanceHistory**](docs/OnchainDataApi.md#getContractBalanceHistory) | **GET** /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/account_address/{accountAddress}/balance_history | Get historical balance data for a specific account in a contract
+*OnchainDataApi* | [**getContractBalancesSummary**](docs/OnchainDataApi.md#getContractBalancesSummary) | **GET** /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/summary | Get summary for the token contract
+*OnchainDataApi* | [**getContractTotalSupply**](docs/OnchainDataApi.md#getContractTotalSupply) | **GET** /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/total_supply | Get historical total supply data for a contract
+*OnchainDataApi* | [**getLatestBalancesForContract**](docs/OnchainDataApi.md#getLatestBalancesForContract) | **GET** /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/balances | Get latest balances for all addresses holding tokens from a contract
+*OnchainDataApi* | [**getOnchainTransactions**](docs/OnchainDataApi.md#getOnchainTransactions) | **GET** /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/transactions | Fetch onchain transactions for a contract
*OtaBetaApi* | [**getOtaStatus**](docs/OtaBetaApi.md#getOtaStatus) | **GET** /management/ota | Returns current OTA status
*OtaBetaApi* | [**setOtaStatus**](docs/OtaBetaApi.md#setOtaStatus) | **PUT** /management/ota | Enable or disable transactions to OTA
*PaymentsPayoutApi* | [**createPayout**](docs/PaymentsPayoutApi.md#createPayout) | **POST** /payments/payout | Create a payout instruction set
@@ -316,12 +327,12 @@ Class | Method | HTTP request | Description
*PolicyEditorV2BetaApi* | [**publishDraft**](docs/PolicyEditorV2BetaApi.md#publishDraft) | **POST** /policy/draft | Send publish request for a certain draft id
*PolicyEditorV2BetaApi* | [**updateDraft**](docs/PolicyEditorV2BetaApi.md#updateDraft) | **PUT** /policy/draft | Update the draft with a new set of rules by policy types
*ResetDeviceApi* | [**resetDevice**](docs/ResetDeviceApi.md#resetDevice) | **POST** /management/users/{id}/reset_device | Resets device
-*SmartTransferApi* | [**approveDvPTicketTerm**](docs/SmartTransferApi.md#approveDvPTicketTerm) | **PUT** /smart_transfers/{ticketId}/terms/{termId}/dvp/approve | Define funding source and give approve to contract to transfer asset
+*SmartTransferApi* | [**approveDvPTicketTerm**](docs/SmartTransferApi.md#approveDvPTicketTerm) | **PUT** /smart_transfers/{ticketId}/terms/{termId}/dvp/approve | Set funding source and approval
*SmartTransferApi* | [**cancelTicket**](docs/SmartTransferApi.md#cancelTicket) | **PUT** /smart-transfers/{ticketId}/cancel | Cancel Ticket
*SmartTransferApi* | [**createTicket**](docs/SmartTransferApi.md#createTicket) | **POST** /smart-transfers | Create Ticket
*SmartTransferApi* | [**createTicketTerm**](docs/SmartTransferApi.md#createTicketTerm) | **POST** /smart-transfers/{ticketId}/terms | Create leg (term)
-*SmartTransferApi* | [**findTicketById**](docs/SmartTransferApi.md#findTicketById) | **GET** /smart-transfers/{ticketId} | Search Tickets by ID
-*SmartTransferApi* | [**findTicketTermById**](docs/SmartTransferApi.md#findTicketTermById) | **GET** /smart-transfers/{ticketId}/terms/{termId} | Search ticket by leg (term) ID
+*SmartTransferApi* | [**findTicketById**](docs/SmartTransferApi.md#findTicketById) | **GET** /smart-transfers/{ticketId} | Search Ticket by ID
+*SmartTransferApi* | [**findTicketTermById**](docs/SmartTransferApi.md#findTicketTermById) | **GET** /smart-transfers/{ticketId}/terms/{termId} | Get Smart Transfer ticket term
*SmartTransferApi* | [**fulfillTicket**](docs/SmartTransferApi.md#fulfillTicket) | **PUT** /smart-transfers/{ticketId}/fulfill | Fund ticket manually
*SmartTransferApi* | [**fundDvpTicket**](docs/SmartTransferApi.md#fundDvpTicket) | **PUT** /smart_transfers/{ticketId}/dvp/fund | Fund dvp ticket
*SmartTransferApi* | [**fundTicketTerm**](docs/SmartTransferApi.md#fundTicketTerm) | **PUT** /smart-transfers/{ticketId}/terms/{termId}/fund | Define funding source
@@ -335,22 +346,24 @@ Class | Method | HTTP request | Description
*SmartTransferApi* | [**setUserGroups**](docs/SmartTransferApi.md#setUserGroups) | **POST** /smart-transfers/settings/user-groups | Set user group
*SmartTransferApi* | [**submitTicket**](docs/SmartTransferApi.md#submitTicket) | **PUT** /smart-transfers/{ticketId}/submit | Submit ticket
*SmartTransferApi* | [**updateTicketTerm**](docs/SmartTransferApi.md#updateTicketTerm) | **PUT** /smart-transfers/{ticketId}/terms/{termId} | Update ticket leg (term)
-*StakingApi* | [**approveTermsOfServiceByProviderId**](docs/StakingApi.md#approveTermsOfServiceByProviderId) | **POST** /staking/providers/{providerId}/approveTermsOfService | Approve staking terms of service
-*StakingApi* | [**claimRewards**](docs/StakingApi.md#claimRewards) | **POST** /staking/chains/{chainDescriptor}/claim_rewards | Execute a Claim Rewards operation
-*StakingApi* | [**getAllDelegations**](docs/StakingApi.md#getAllDelegations) | **GET** /staking/positions | List staking positions details
-*StakingApi* | [**getChainInfo**](docs/StakingApi.md#getChainInfo) | **GET** /staking/chains/{chainDescriptor}/chainInfo | Get chain-specific staking summary
-*StakingApi* | [**getChains**](docs/StakingApi.md#getChains) | **GET** /staking/chains | List staking supported chains
-*StakingApi* | [**getDelegationById**](docs/StakingApi.md#getDelegationById) | **GET** /staking/positions/{id} | Get staking position details
-*StakingApi* | [**getProviders**](docs/StakingApi.md#getProviders) | **GET** /staking/providers | List staking providers details
-*StakingApi* | [**getSummary**](docs/StakingApi.md#getSummary) | **GET** /staking/positions/summary | Get staking summary details
-*StakingApi* | [**getSummaryByVault**](docs/StakingApi.md#getSummaryByVault) | **GET** /staking/positions/summary/vaults | Get staking summary details by vault
-*StakingApi* | [**mergeStakeAccounts**](docs/StakingApi.md#mergeStakeAccounts) | **POST** /staking/chains/{chainDescriptor}/merge | Merge Solana on stake accounts
-*StakingApi* | [**split**](docs/StakingApi.md#split) | **POST** /staking/chains/{chainDescriptor}/split | Execute a Split operation on SOL/SOL_TEST stake account
-*StakingApi* | [**stake**](docs/StakingApi.md#stake) | **POST** /staking/chains/{chainDescriptor}/stake | Initiate Stake Operation
-*StakingApi* | [**unstake**](docs/StakingApi.md#unstake) | **POST** /staking/chains/{chainDescriptor}/unstake | Execute an Unstake operation
-*StakingApi* | [**withdraw**](docs/StakingApi.md#withdraw) | **POST** /staking/chains/{chainDescriptor}/withdraw | Execute a Withdraw operation
-*TagsApi* | [**createTag**](docs/TagsApi.md#createTag) | **POST** /tags | Create a tag
+*StakingApi* | [**approveTermsOfServiceByProviderId**](docs/StakingApi.md#approveTermsOfServiceByProviderId) | **POST** /staking/providers/{providerId}/approveTermsOfService | Approve provider terms of service
+*StakingApi* | [**claimRewards**](docs/StakingApi.md#claimRewards) | **POST** /staking/chains/{chainDescriptor}/claim_rewards | Claim accrued rewards
+*StakingApi* | [**getAllDelegations**](docs/StakingApi.md#getAllDelegations) | **GET** /staking/positions | List staking positions
+*StakingApi* | [**getChainInfo**](docs/StakingApi.md#getChainInfo) | **GET** /staking/chains/{chainDescriptor}/chainInfo | Get chain-level staking parameters
+*StakingApi* | [**getChains**](docs/StakingApi.md#getChains) | **GET** /staking/chains | List supported staking chains
+*StakingApi* | [**getDelegationById**](docs/StakingApi.md#getDelegationById) | **GET** /staking/positions/{id} | Get position details
+*StakingApi* | [**getProviders**](docs/StakingApi.md#getProviders) | **GET** /staking/providers | List staking providers
+*StakingApi* | [**getSummary**](docs/StakingApi.md#getSummary) | **GET** /staking/positions/summary | Get positions summary
+*StakingApi* | [**getSummaryByVault**](docs/StakingApi.md#getSummaryByVault) | **GET** /staking/positions/summary/vaults | Get positions summary by vault
+*StakingApi* | [**mergeStakeAccounts**](docs/StakingApi.md#mergeStakeAccounts) | **POST** /staking/chains/{chainDescriptor}/merge | Merge staking positions
+*StakingApi* | [**split**](docs/StakingApi.md#split) | **POST** /staking/chains/{chainDescriptor}/split | Split a staking position
+*StakingApi* | [**stake**](docs/StakingApi.md#stake) | **POST** /staking/chains/{chainDescriptor}/stake | Initiate or add to existing stake
+*StakingApi* | [**unstake**](docs/StakingApi.md#unstake) | **POST** /staking/chains/{chainDescriptor}/unstake | Initiate unstake
+*StakingApi* | [**withdraw**](docs/StakingApi.md#withdraw) | **POST** /staking/chains/{chainDescriptor}/withdraw | Withdraw staked funds
+*TagsApi* | [**cancelApprovalRequest**](docs/TagsApi.md#cancelApprovalRequest) | **POST** /tags/approval_requests/{id}/cancel | Cancel an approval request by id
+*TagsApi* | [**createTag**](docs/TagsApi.md#createTag) | **POST** /tags | Create a new tag
*TagsApi* | [**deleteTag**](docs/TagsApi.md#deleteTag) | **DELETE** /tags/{tagId} | Delete a tag
+*TagsApi* | [**getApprovalRequest**](docs/TagsApi.md#getApprovalRequest) | **GET** /tags/approval_requests/{id} | Get an approval request by id
*TagsApi* | [**getTag**](docs/TagsApi.md#getTag) | **GET** /tags/{tagId} | Get a tag
*TagsApi* | [**getTags**](docs/TagsApi.md#getTags) | **GET** /tags | Get list of tags
*TagsApi* | [**updateTag**](docs/TagsApi.md#updateTag) | **PATCH** /tags/{tagId} | Update a tag
@@ -366,6 +379,7 @@ Class | Method | HTTP request | Description
*TokenizationApi* | [**getLinkedCollections**](docs/TokenizationApi.md#getLinkedCollections) | **GET** /tokenization/collections | Get collections
*TokenizationApi* | [**getLinkedToken**](docs/TokenizationApi.md#getLinkedToken) | **GET** /tokenization/tokens/{id} | Return a linked token
*TokenizationApi* | [**getLinkedTokens**](docs/TokenizationApi.md#getLinkedTokens) | **GET** /tokenization/tokens | List all linked tokens
+*TokenizationApi* | [**getLinkedTokensCount**](docs/TokenizationApi.md#getLinkedTokensCount) | **GET** /tokenization/tokens/count | Get the total count of linked tokens
*TokenizationApi* | [**issueNewToken**](docs/TokenizationApi.md#issueNewToken) | **POST** /tokenization/tokens | Issue a new token
*TokenizationApi* | [**issueTokenMultiChain**](docs/TokenizationApi.md#issueTokenMultiChain) | **POST** /tokenization/multichain/tokens | Issue a token on one or more blockchains
*TokenizationApi* | [**link**](docs/TokenizationApi.md#link) | **POST** /tokenization/tokens/link | Link a contract
@@ -377,6 +391,31 @@ Class | Method | HTTP request | Description
*TokenizationApi* | [**unlink**](docs/TokenizationApi.md#unlink) | **DELETE** /tokenization/tokens/{id} | Unlink a token
*TokenizationApi* | [**unlinkCollection**](docs/TokenizationApi.md#unlinkCollection) | **DELETE** /tokenization/collections/{id} | Delete a collection link
*TokenizationApi* | [**validateLayerZeroChannelConfig**](docs/TokenizationApi.md#validateLayerZeroChannelConfig) | **GET** /tokenization/multichain/bridge/layerzero/validate | Validate LayerZero channel configuration
+*TrLinkApi* | [**assessTRLinkTravelRuleRequirement**](docs/TrLinkApi.md#assessTRLinkTravelRuleRequirement) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/assess | Assess Travel Rule requirement
+*TrLinkApi* | [**cancelTRLinkTrm**](docs/TrLinkApi.md#cancelTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancel | Cancel Travel Rule Message
+*TrLinkApi* | [**connectTRLinkIntegration**](docs/TrLinkApi.md#connectTRLinkIntegration) | **PUT** /screening/trlink/customers/integration/{customerIntegrationId} | Connect customer integration
+*TrLinkApi* | [**createTRLinkCustomer**](docs/TrLinkApi.md#createTRLinkCustomer) | **POST** /screening/trlink/customers | Create customer
+*TrLinkApi* | [**createTRLinkIntegration**](docs/TrLinkApi.md#createTRLinkIntegration) | **POST** /screening/trlink/customers/integration | Create customer integration
+*TrLinkApi* | [**createTRLinkTrm**](docs/TrLinkApi.md#createTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm | Create Travel Rule Message
+*TrLinkApi* | [**deleteTRLinkCustomer**](docs/TrLinkApi.md#deleteTRLinkCustomer) | **DELETE** /screening/trlink/customers/{customerId} | Delete customer
+*TrLinkApi* | [**disconnectTRLinkIntegration**](docs/TrLinkApi.md#disconnectTRLinkIntegration) | **DELETE** /screening/trlink/customers/integration/{customerIntegrationId} | Disconnect customer integration
+*TrLinkApi* | [**getTRLinkCustomerById**](docs/TrLinkApi.md#getTRLinkCustomerById) | **GET** /screening/trlink/customers/{customerId} | Get customer by ID
+*TrLinkApi* | [**getTRLinkCustomerIntegrationById**](docs/TrLinkApi.md#getTRLinkCustomerIntegrationById) | **GET** /screening/trlink/customers/{customerId}/integrations/{customerIntegrationId} | Get customer integration by ID
+*TrLinkApi* | [**getTRLinkCustomerIntegrations**](docs/TrLinkApi.md#getTRLinkCustomerIntegrations) | **GET** /screening/trlink/customers/{customerId}/integrations | Get customer integrations
+*TrLinkApi* | [**getTRLinkCustomers**](docs/TrLinkApi.md#getTRLinkCustomers) | **GET** /screening/trlink/customers | Get all customers
+*TrLinkApi* | [**getTRLinkIntegrationPublicKey**](docs/TrLinkApi.md#getTRLinkIntegrationPublicKey) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/public_key | Get public key for PII encryption
+*TrLinkApi* | [**getTRLinkPartners**](docs/TrLinkApi.md#getTRLinkPartners) | **GET** /screening/trlink/partners | List available TRLink partners
+*TrLinkApi* | [**getTRLinkPolicy**](docs/TrLinkApi.md#getTRLinkPolicy) | **GET** /screening/trlink/policy | Get TRLink policy
+*TrLinkApi* | [**getTRLinkSupportedAsset**](docs/TrLinkApi.md#getTRLinkSupportedAsset) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} | Get supported asset by ID
+*TrLinkApi* | [**getTRLinkTrmById**](docs/TrLinkApi.md#getTRLinkTrmById) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId} | Get TRM by ID
+*TrLinkApi* | [**getTRLinkVaspById**](docs/TrLinkApi.md#getTRLinkVaspById) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId} | Get VASP by ID
+*TrLinkApi* | [**listTRLinkSupportedAssets**](docs/TrLinkApi.md#listTRLinkSupportedAssets) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/assets | List supported assets
+*TrLinkApi* | [**listTRLinkVasps**](docs/TrLinkApi.md#listTRLinkVasps) | **GET** /screening/trlink/customers/integration/{customerIntegrationId}/vasps | List VASPs
+*TrLinkApi* | [**redirectTRLinkTrm**](docs/TrLinkApi.md#redirectTRLinkTrm) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect | Redirect Travel Rule Message
+*TrLinkApi* | [**setTRLinkDestinationTravelRuleMessageId**](docs/TrLinkApi.md#setTRLinkDestinationTravelRuleMessageId) | **POST** /screening/trlink/transaction/{txId}/destination/travel_rule_message_id | Set destination travel rule message ID
+*TrLinkApi* | [**setTRLinkTransactionTravelRuleMessageId**](docs/TrLinkApi.md#setTRLinkTransactionTravelRuleMessageId) | **POST** /screening/trlink/transaction/{txId}/travel_rule_message_id | Set transaction travel rule message ID
+*TrLinkApi* | [**testTRLinkIntegrationConnection**](docs/TrLinkApi.md#testTRLinkIntegrationConnection) | **POST** /screening/trlink/customers/integration/{customerIntegrationId}/test_connection | Test connection
+*TrLinkApi* | [**updateTRLinkCustomer**](docs/TrLinkApi.md#updateTRLinkCustomer) | **PUT** /screening/trlink/customers/{customerId} | Update customer
*TradingBetaApi* | [**createOrder**](docs/TradingBetaApi.md#createOrder) | **POST** /trading/orders | Create an order
*TradingBetaApi* | [**createQuote**](docs/TradingBetaApi.md#createQuote) | **POST** /trading/quotes | Create a quote
*TradingBetaApi* | [**getOrder**](docs/TradingBetaApi.md#getOrder) | **GET** /trading/orders/{orderId} | Get order details
@@ -384,18 +423,19 @@ Class | Method | HTTP request | Description
*TradingBetaApi* | [**getTradingProviders**](docs/TradingBetaApi.md#getTradingProviders) | **GET** /trading/providers | Get providers
*TransactionsApi* | [**cancelTransaction**](docs/TransactionsApi.md#cancelTransaction) | **POST** /transactions/{txId}/cancel | Cancel a transaction
*TransactionsApi* | [**createTransaction**](docs/TransactionsApi.md#createTransaction) | **POST** /transactions | Create a new transaction
-*TransactionsApi* | [**dropTransaction**](docs/TransactionsApi.md#dropTransaction) | **POST** /transactions/{txId}/drop | Drop ETH transaction by ID
+*TransactionsApi* | [**dropTransaction**](docs/TransactionsApi.md#dropTransaction) | **POST** /transactions/{txId}/drop | Drop ETH (EVM) transaction by ID
*TransactionsApi* | [**estimateNetworkFee**](docs/TransactionsApi.md#estimateNetworkFee) | **GET** /estimate_network_fee | Estimate the required fee for an asset
*TransactionsApi* | [**estimateTransactionFee**](docs/TransactionsApi.md#estimateTransactionFee) | **POST** /transactions/estimate_fee | Estimate transaction fee
*TransactionsApi* | [**freezeTransaction**](docs/TransactionsApi.md#freezeTransaction) | **POST** /transactions/{txId}/freeze | Freeze a transaction
-*TransactionsApi* | [**getTransaction**](docs/TransactionsApi.md#getTransaction) | **GET** /transactions/{txId} | Find a specific transaction by Fireblocks transaction ID
-*TransactionsApi* | [**getTransactionByExternalId**](docs/TransactionsApi.md#getTransactionByExternalId) | **GET** /transactions/external_tx_id/{externalTxId} | Find a specific transaction by external transaction ID
-*TransactionsApi* | [**getTransactions**](docs/TransactionsApi.md#getTransactions) | **GET** /transactions | List transaction history
-*TransactionsApi* | [**rescanTransactionsBeta**](docs/TransactionsApi.md#rescanTransactionsBeta) | **POST** /transactions/rescan | rescan array of transactions
+*TransactionsApi* | [**getTransaction**](docs/TransactionsApi.md#getTransaction) | **GET** /transactions/{txId} | Get a specific transaction by Fireblocks transaction ID
+*TransactionsApi* | [**getTransactionByExternalId**](docs/TransactionsApi.md#getTransactionByExternalId) | **GET** /transactions/external_tx_id/{externalTxId} | Get a specific transaction by external transaction ID
+*TransactionsApi* | [**getTransactions**](docs/TransactionsApi.md#getTransactions) | **GET** /transactions | Get transaction history
*TransactionsApi* | [**setConfirmationThresholdByTransactionHash**](docs/TransactionsApi.md#setConfirmationThresholdByTransactionHash) | **POST** /txHash/{txHash}/set_confirmation_threshold | Set confirmation threshold by transaction hash
-*TransactionsApi* | [**setTransactionConfirmationThreshold**](docs/TransactionsApi.md#setTransactionConfirmationThreshold) | **POST** /transactions/{txId}/set_confirmation_threshold | Set confirmation threshold by transaction ID
+*TransactionsApi* | [**setTransactionConfirmationThreshold**](docs/TransactionsApi.md#setTransactionConfirmationThreshold) | **POST** /transactions/{txId}/set_confirmation_threshold | Set confirmation threshold by Fireblocks Transaction ID
*TransactionsApi* | [**unfreezeTransaction**](docs/TransactionsApi.md#unfreezeTransaction) | **POST** /transactions/{txId}/unfreeze | Unfreeze a transaction
*TransactionsApi* | [**validateAddress**](docs/TransactionsApi.md#validateAddress) | **GET** /transactions/validate_address/{assetId}/{address} | Validate destination address
+*TravelRuleApi* | [**createTrustProofOfAddress**](docs/TravelRuleApi.md#createTrustProofOfAddress) | **POST** /screening/travel_rule/providers/trust/proof_of_address | Create Trust Network Proof of Address
+*TravelRuleApi* | [**getTrustProofOfAddress**](docs/TravelRuleApi.md#getTrustProofOfAddress) | **GET** /screening/travel_rule/providers/trust/proof_of_address/{transactionId} | Retrieve Trust Network Proof of Address Signature
*TravelRuleApi* | [**getVASPByDID**](docs/TravelRuleApi.md#getVASPByDID) | **GET** /screening/travel_rule/vasp/{did} | Get VASP details
*TravelRuleApi* | [**getVASPs**](docs/TravelRuleApi.md#getVASPs) | **GET** /screening/travel_rule/vasp | Get All VASPs
*TravelRuleApi* | [**getVaspForVault**](docs/TravelRuleApi.md#getVaspForVault) | **GET** /screening/travel_rule/vault/{vaultAccountId}/vasp | Get assigned VASP to vault
@@ -409,32 +449,31 @@ Class | Method | HTTP request | Description
*UserGroupsBetaApi* | [**updateUserGroup**](docs/UserGroupsBetaApi.md#updateUserGroup) | **PUT** /management/user_groups/{groupId} | Update user group
*UsersApi* | [**getUsers**](docs/UsersApi.md#getUsers) | **GET** /users | List users
*VaultsApi* | [**activateAssetForVaultAccount**](docs/VaultsApi.md#activateAssetForVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/activate | Activate a wallet in a vault account
-*VaultsApi* | [**attachOrDetachTagsFromVaultAccounts**](docs/VaultsApi.md#attachOrDetachTagsFromVaultAccounts) | **POST** /vault/accounts/attached_tags | Attach or detach tags from a vault accounts
-*VaultsApi* | [**attachTagsToVaultAccounts**](docs/VaultsApi.md#attachTagsToVaultAccounts) | **POST** /vault/accounts/attached_tags/attach | Attach tags to a vault accounts (deprecated)
+*VaultsApi* | [**attachOrDetachTagsFromVaultAccounts**](docs/VaultsApi.md#attachOrDetachTagsFromVaultAccounts) | **POST** /vault/accounts/attached_tags | Attach or detach tags from vault accounts
*VaultsApi* | [**createLegacyAddress**](docs/VaultsApi.md#createLegacyAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy | Convert a segwit address to legacy format
*VaultsApi* | [**createMultipleAccounts**](docs/VaultsApi.md#createMultipleAccounts) | **POST** /vault/accounts/bulk | Bulk creation of new vault accounts
*VaultsApi* | [**createMultipleDepositAddresses**](docs/VaultsApi.md#createMultipleDepositAddresses) | **POST** /vault/accounts/addresses/bulk | Bulk creation of new deposit addresses
*VaultsApi* | [**createVaultAccount**](docs/VaultsApi.md#createVaultAccount) | **POST** /vault/accounts | Create a new vault account
-*VaultsApi* | [**createVaultAccountAsset**](docs/VaultsApi.md#createVaultAccountAsset) | **POST** /vault/accounts/{vaultAccountId}/{assetId} | Create a new wallet
+*VaultsApi* | [**createVaultAccountAsset**](docs/VaultsApi.md#createVaultAccountAsset) | **POST** /vault/accounts/{vaultAccountId}/{assetId} | Create a new vault wallet
*VaultsApi* | [**createVaultAccountAssetAddress**](docs/VaultsApi.md#createVaultAccountAssetAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses | Create new asset deposit address
-*VaultsApi* | [**detachTagsFromVaultAccounts**](docs/VaultsApi.md#detachTagsFromVaultAccounts) | **POST** /vault/accounts/attached_tags/detach | Detach tags from a vault accounts (deprecated)
-*VaultsApi* | [**getAssetWallets**](docs/VaultsApi.md#getAssetWallets) | **GET** /vault/asset_wallets | List asset wallets (Paginated)
-*VaultsApi* | [**getCreateMultipleDepositAddressesJobStatus**](docs/VaultsApi.md#getCreateMultipleDepositAddressesJobStatus) | **GET** /vault/accounts/addresses/bulk/{jobId} | Get job status of bulk creation of new deposit addresses
+*VaultsApi* | [**getAssetWallets**](docs/VaultsApi.md#getAssetWallets) | **GET** /vault/asset_wallets | Get vault wallets (Paginated)
+*VaultsApi* | [**getCreateMultipleDepositAddressesJobStatus**](docs/VaultsApi.md#getCreateMultipleDepositAddressesJobStatus) | **GET** /vault/accounts/addresses/bulk/{jobId} | Get the job status of the bulk deposit address creation
*VaultsApi* | [**getCreateMultipleVaultAccountsJobStatus**](docs/VaultsApi.md#getCreateMultipleVaultAccountsJobStatus) | **GET** /vault/accounts/bulk/{jobId} | Get job status of bulk creation of new vault accounts
-*VaultsApi* | [**getMaxSpendableAmount**](docs/VaultsApi.md#getMaxSpendableAmount) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount | Get the maximum spendable amount in a single transaction.
-*VaultsApi* | [**getPagedVaultAccounts**](docs/VaultsApi.md#getPagedVaultAccounts) | **GET** /vault/accounts_paged | List vault accounts (Paginated)
-*VaultsApi* | [**getPublicKeyInfo**](docs/VaultsApi.md#getPublicKeyInfo) | **GET** /vault/public_key_info | Get the public key information
-*VaultsApi* | [**getPublicKeyInfoForAddress**](docs/VaultsApi.md#getPublicKeyInfoForAddress) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info | Get the public key for a vault account
+*VaultsApi* | [**getMaxBipIndexUsed**](docs/VaultsApi.md#getMaxBipIndexUsed) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/max_bip_index_used | Get maximum BIP44 index used
+*VaultsApi* | [**getMaxSpendableAmount**](docs/VaultsApi.md#getMaxSpendableAmount) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount | Get max spendable amount in a transaction
+*VaultsApi* | [**getPagedVaultAccounts**](docs/VaultsApi.md#getPagedVaultAccounts) | **GET** /vault/accounts_paged | Get vault accounts (Paginated)
+*VaultsApi* | [**getPublicKeyInfo**](docs/VaultsApi.md#getPublicKeyInfo) | **GET** /vault/public_key_info | Get the public key for a derivation path
+*VaultsApi* | [**getPublicKeyInfoForAddress**](docs/VaultsApi.md#getPublicKeyInfoForAddress) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info | Get an asset's public key
*VaultsApi* | [**getUnspentInputs**](docs/VaultsApi.md#getUnspentInputs) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs | Get UTXO unspent inputs information
-*VaultsApi* | [**getVaultAccount**](docs/VaultsApi.md#getVaultAccount) | **GET** /vault/accounts/{vaultAccountId} | Find a vault account by ID
+*VaultsApi* | [**getVaultAccount**](docs/VaultsApi.md#getVaultAccount) | **GET** /vault/accounts/{vaultAccountId} | Get a vault account by ID
*VaultsApi* | [**getVaultAccountAsset**](docs/VaultsApi.md#getVaultAccountAsset) | **GET** /vault/accounts/{vaultAccountId}/{assetId} | Get the asset balance for a vault account
-*VaultsApi* | [**getVaultAccountAssetAddressesPaginated**](docs/VaultsApi.md#getVaultAccountAssetAddressesPaginated) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated | List addresses (Paginated)
+*VaultsApi* | [**getVaultAccountAssetAddressesPaginated**](docs/VaultsApi.md#getVaultAccountAssetAddressesPaginated) | **GET** /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated | Get addresses (Paginated)
*VaultsApi* | [**getVaultAssets**](docs/VaultsApi.md#getVaultAssets) | **GET** /vault/assets | Get asset balance for chosen assets
-*VaultsApi* | [**getVaultBalanceByAsset**](docs/VaultsApi.md#getVaultBalanceByAsset) | **GET** /vault/assets/{assetId} | Get vault balance by asset
+*VaultsApi* | [**getVaultBalanceByAsset**](docs/VaultsApi.md#getVaultBalanceByAsset) | **GET** /vault/assets/{assetId} | Get vault balance by an asset
*VaultsApi* | [**hideVaultAccount**](docs/VaultsApi.md#hideVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/hide | Hide a vault account in the console
*VaultsApi* | [**setCustomerRefIdForAddress**](docs/VaultsApi.md#setCustomerRefIdForAddress) | **POST** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id | Assign AML customer reference ID
-*VaultsApi* | [**setVaultAccountAutoFuel**](docs/VaultsApi.md#setVaultAccountAutoFuel) | **POST** /vault/accounts/{vaultAccountId}/set_auto_fuel | Turn autofueling on or off
-*VaultsApi* | [**setVaultAccountCustomerRefId**](docs/VaultsApi.md#setVaultAccountCustomerRefId) | **POST** /vault/accounts/{vaultAccountId}/set_customer_ref_id | Set an AML/KYT customer reference ID for a vault account
+*VaultsApi* | [**setVaultAccountAutoFuel**](docs/VaultsApi.md#setVaultAccountAutoFuel) | **POST** /vault/accounts/{vaultAccountId}/set_auto_fuel | Set auto fueling to on or off
+*VaultsApi* | [**setVaultAccountCustomerRefId**](docs/VaultsApi.md#setVaultAccountCustomerRefId) | **POST** /vault/accounts/{vaultAccountId}/set_customer_ref_id | Set an AML/KYT ID for a vault account
*VaultsApi* | [**unhideVaultAccount**](docs/VaultsApi.md#unhideVaultAccount) | **POST** /vault/accounts/{vaultAccountId}/unhide | Unhide a vault account in the console
*VaultsApi* | [**updateVaultAccount**](docs/VaultsApi.md#updateVaultAccount) | **PUT** /vault/accounts/{vaultAccountId} | Rename a vault account
*VaultsApi* | [**updateVaultAccountAssetAddress**](docs/VaultsApi.md#updateVaultAccountAssetAddress) | **PUT** /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} | Update address description
@@ -443,9 +482,9 @@ Class | Method | HTTP request | Description
*Web3ConnectionsApi* | [**get**](docs/Web3ConnectionsApi.md#get) | **GET** /connections | List all open Web3 connections.
*Web3ConnectionsApi* | [**remove**](docs/Web3ConnectionsApi.md#remove) | **DELETE** /connections/wc/{id} | Remove an existing Web3 connection.
*Web3ConnectionsApi* | [**submit**](docs/Web3ConnectionsApi.md#submit) | **PUT** /connections/wc/{id} | Respond to a pending Web3 connection request.
-*WebhooksApi* | [**resendTransactionWebhooks**](docs/WebhooksApi.md#resendTransactionWebhooks) | **POST** /webhooks/resend/{txId} | Resend failed webhooks for a transaction by ID
+*WebhooksApi* | [**resendTransactionWebhooks**](docs/WebhooksApi.md#resendTransactionWebhooks) | **POST** /webhooks/resend/{txId} | Resend webhooks for a transaction by ID
*WebhooksApi* | [**resendWebhooks**](docs/WebhooksApi.md#resendWebhooks) | **POST** /webhooks/resend | Resend failed webhooks
-*WebhooksV2Api* | [**createWebhook**](docs/WebhooksV2Api.md#createWebhook) | **POST** /webhooks | Create new webhook
+*WebhooksV2Api* | [**createWebhook**](docs/WebhooksV2Api.md#createWebhook) | **POST** /webhooks | Create a new webhook
*WebhooksV2Api* | [**deleteWebhook**](docs/WebhooksV2Api.md#deleteWebhook) | **DELETE** /webhooks/{webhookId} | Delete webhook
*WebhooksV2Api* | [**getMetrics**](docs/WebhooksV2Api.md#getMetrics) | **GET** /webhooks/{webhookId}/metrics/{metricName} | Get webhook metrics
*WebhooksV2Api* | [**getNotification**](docs/WebhooksV2Api.md#getNotification) | **GET** /webhooks/{webhookId}/notifications/{notificationId} | Get notification by id
@@ -458,7 +497,7 @@ Class | Method | HTTP request | Description
*WebhooksV2Api* | [**resendNotificationById**](docs/WebhooksV2Api.md#resendNotificationById) | **POST** /webhooks/{webhookId}/notifications/{notificationId}/resend | Resend notification by id
*WebhooksV2Api* | [**resendNotificationsByResourceId**](docs/WebhooksV2Api.md#resendNotificationsByResourceId) | **POST** /webhooks/{webhookId}/notifications/resend_by_resource | Resend notifications by resource Id
*WebhooksV2Api* | [**updateWebhook**](docs/WebhooksV2Api.md#updateWebhook) | **PATCH** /webhooks/{webhookId} | Update webhook
-*WhitelistIpAddressesApi* | [**getWhitelistIpAddresses**](docs/WhitelistIpAddressesApi.md#getWhitelistIpAddresses) | **GET** /management/api_users/{userId}/whitelist_ip_addresses | Gets whitelisted ip addresses
+*WhitelistIpAddressesApi* | [**getWhitelistIpAddresses**](docs/WhitelistIpAddressesApi.md#getWhitelistIpAddresses) | **GET** /management/api_users/{userId}/whitelist_ip_addresses | Get whitelisted ip addresses for an API Key
*WorkspaceStatusBetaApi* | [**getWorkspaceStatus**](docs/WorkspaceStatusBetaApi.md#getWorkspaceStatus) | **GET** /management/workspace_status | Returns current workspace status
@@ -467,6 +506,9 @@ Class | Method | HTTP request | Description
- [APIUser](docs/APIUser.md)
- [AbaPaymentInfo](docs/AbaPaymentInfo.md)
- [AbiFunction](docs/AbiFunction.md)
+ - [AccessRegistryAddressItem](docs/AccessRegistryAddressItem.md)
+ - [AccessRegistryCurrentStateResponse](docs/AccessRegistryCurrentStateResponse.md)
+ - [AccessRegistrySummaryResponse](docs/AccessRegistrySummaryResponse.md)
- [AccessType](docs/AccessType.md)
- [Account](docs/Account.md)
- [AccountAccess](docs/AccountAccess.md)
@@ -476,7 +518,6 @@ Class | Method | HTTP request | Description
- [AccountConfig](docs/AccountConfig.md)
- [AccountHolderDetails](docs/AccountHolderDetails.md)
- [AccountIdentifier](docs/AccountIdentifier.md)
- - [AccountProviderID](docs/AccountProviderID.md)
- [AccountReference](docs/AccountReference.md)
- [AccountType](docs/AccountType.md)
- [AccountType2](docs/AccountType2.md)
@@ -496,6 +537,8 @@ Class | Method | HTTP request | Description
- [AdditionalInfo](docs/AdditionalInfo.md)
- [AdditionalInfoRequest](docs/AdditionalInfoRequest.md)
- [AdditionalInfoRequestAdditionalInfo](docs/AdditionalInfoRequestAdditionalInfo.md)
+ - [AddressBalanceItemDto](docs/AddressBalanceItemDto.md)
+ - [AddressBalancePagedResponse](docs/AddressBalancePagedResponse.md)
- [AddressNotAvailableError](docs/AddressNotAvailableError.md)
- [AlertExposureTypeEnum](docs/AlertExposureTypeEnum.md)
- [AlertLevelEnum](docs/AlertLevelEnum.md)
@@ -518,6 +561,7 @@ Class | Method | HTTP request | Description
- [AmountRangeMinMax2](docs/AmountRangeMinMax2.md)
- [ApiKey](docs/ApiKey.md)
- [ApiKeysPaginatedResponse](docs/ApiKeysPaginatedResponse.md)
+ - [ApprovalRequest](docs/ApprovalRequest.md)
- [ApproversConfig](docs/ApproversConfig.md)
- [ApproversConfigApprovalGroupsInner](docs/ApproversConfigApprovalGroupsInner.md)
- [Asset](docs/Asset.md)
@@ -546,6 +590,7 @@ Class | Method | HTTP request | Description
- [AssetPriceResponse](docs/AssetPriceResponse.md)
- [AssetResponse](docs/AssetResponse.md)
- [AssetScope](docs/AssetScope.md)
+ - [AssetTypeEnum](docs/AssetTypeEnum.md)
- [AssetTypeResponse](docs/AssetTypeResponse.md)
- [AssetTypesConfigInner](docs/AssetTypesConfigInner.md)
- [AssetWallet](docs/AssetWallet.md)
@@ -553,9 +598,14 @@ Class | Method | HTTP request | Description
- [AuditorData](docs/AuditorData.md)
- [AuthorizationGroups](docs/AuthorizationGroups.md)
- [AuthorizationInfo](docs/AuthorizationInfo.md)
+ - [BalanceHistoryItemDto](docs/BalanceHistoryItemDto.md)
+ - [BalanceHistoryPagedResponse](docs/BalanceHistoryPagedResponse.md)
+ - [BankAddress](docs/BankAddress.md)
- [BaseProvider](docs/BaseProvider.md)
- [BasicAddressRequest](docs/BasicAddressRequest.md)
- [BlockInfo](docs/BlockInfo.md)
+ - [BlockchainAddress](docs/BlockchainAddress.md)
+ - [BlockchainDestination](docs/BlockchainDestination.md)
- [BlockchainExplorer](docs/BlockchainExplorer.md)
- [BlockchainMedia](docs/BlockchainMedia.md)
- [BlockchainMetadata](docs/BlockchainMetadata.md)
@@ -564,6 +614,7 @@ Class | Method | HTTP request | Description
- [BlockchainResponse](docs/BlockchainResponse.md)
- [BlockchainTransfer](docs/BlockchainTransfer.md)
- [BpsFee](docs/BpsFee.md)
+ - [BusinessEntityTypeEnum](docs/BusinessEntityTypeEnum.md)
- [BusinessIdentification](docs/BusinessIdentification.md)
- [CallbackHandler](docs/CallbackHandler.md)
- [CallbackHandlerRequest](docs/CallbackHandlerRequest.md)
@@ -584,6 +635,7 @@ Class | Method | HTTP request | Description
- [CollectionTokenMetadataAttributeDto](docs/CollectionTokenMetadataAttributeDto.md)
- [CollectionTokenMetadataDto](docs/CollectionTokenMetadataDto.md)
- [CollectionType](docs/CollectionType.md)
+ - [CommittedQuoteEnum](docs/CommittedQuoteEnum.md)
- [CommittedQuoteType](docs/CommittedQuoteType.md)
- [ComplianceResultFullPayload](docs/ComplianceResultFullPayload.md)
- [ComplianceResultStatusesEnum](docs/ComplianceResultStatusesEnum.md)
@@ -603,6 +655,7 @@ Class | Method | HTTP request | Description
- [ConnectedAccountBalances](docs/ConnectedAccountBalances.md)
- [ConnectedAccountBalancesResponse](docs/ConnectedAccountBalancesResponse.md)
- [ConnectedAccountCapability](docs/ConnectedAccountCapability.md)
+ - [ConnectedAccountErrorResponse](docs/ConnectedAccountErrorResponse.md)
- [ConnectedAccountManifest](docs/ConnectedAccountManifest.md)
- [ConnectedAccountRateResponse](docs/ConnectedAccountRateResponse.md)
- [ConnectedAccountTotalBalance](docs/ConnectedAccountTotalBalance.md)
@@ -615,6 +668,7 @@ Class | Method | HTTP request | Description
- [ConsoleUser](docs/ConsoleUser.md)
- [ContractAbiResponseDto](docs/ContractAbiResponseDto.md)
- [ContractAbiResponseDtoAbiInner](docs/ContractAbiResponseDtoAbiInner.md)
+ - [ContractAddressResponse](docs/ContractAddressResponse.md)
- [ContractAttributes](docs/ContractAttributes.md)
- [ContractDataDecodeDataType](docs/ContractDataDecodeDataType.md)
- [ContractDataDecodeError](docs/ContractDataDecodeError.md)
@@ -650,7 +704,6 @@ Class | Method | HTTP request | Description
- [CreateAPIUser](docs/CreateAPIUser.md)
- [CreateAddressRequest](docs/CreateAddressRequest.md)
- [CreateAddressResponse](docs/CreateAddressResponse.md)
- - [CreateAssetsBulkRequest](docs/CreateAssetsBulkRequest.md)
- [CreateAssetsRequest](docs/CreateAssetsRequest.md)
- [CreateConfigOperationRequest](docs/CreateConfigOperationRequest.md)
- [CreateConnectionRequest](docs/CreateConnectionRequest.md)
@@ -691,8 +744,11 @@ Class | Method | HTTP request | Description
- [CustomRoutingDest](docs/CustomRoutingDest.md)
- [DAppAddressConfig](docs/DAppAddressConfig.md)
- [DVPSettlement](docs/DVPSettlement.md)
+ - [DVPSettlementType](docs/DVPSettlementType.md)
+ - [DecodedLog](docs/DecodedLog.md)
- [DefaultNetworkRoutingDest](docs/DefaultNetworkRoutingDest.md)
- [Delegation](docs/Delegation.md)
+ - [DelegationBlockchainPositionInfo](docs/DelegationBlockchainPositionInfo.md)
- [DelegationSummary](docs/DelegationSummary.md)
- [DeleteNetworkConnectionResponse](docs/DeleteNetworkConnectionResponse.md)
- [DeleteNetworkIdResponse](docs/DeleteNetworkIdResponse.md)
@@ -750,15 +806,22 @@ Class | Method | HTTP request | Description
- [EmbeddedWalletLatestBackupResponse](docs/EmbeddedWalletLatestBackupResponse.md)
- [EmbeddedWalletPaginatedAddressesResponse](docs/EmbeddedWalletPaginatedAddressesResponse.md)
- [EmbeddedWalletPaginatedAssetsResponse](docs/EmbeddedWalletPaginatedAssetsResponse.md)
+ - [EmbeddedWalletPaginatedDevicesResponse](docs/EmbeddedWalletPaginatedDevicesResponse.md)
- [EmbeddedWalletPaginatedWalletsResponse](docs/EmbeddedWalletPaginatedWalletsResponse.md)
+ - [EmbeddedWalletRequiredAlgorithms](docs/EmbeddedWalletRequiredAlgorithms.md)
- [EmbeddedWalletSetUpStatus](docs/EmbeddedWalletSetUpStatus.md)
- - [ErrorCodes](docs/ErrorCodes.md)
+ - [EmbeddedWalletSetupStatusResponse](docs/EmbeddedWalletSetupStatusResponse.md)
+ - [EnableDevice](docs/EnableDevice.md)
+ - [EnableWallet](docs/EnableWallet.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [ErrorResponseError](docs/ErrorResponseError.md)
- [ErrorSchema](docs/ErrorSchema.md)
- [EstimatedFeeDetails](docs/EstimatedFeeDetails.md)
- [EstimatedNetworkFeeResponse](docs/EstimatedNetworkFeeResponse.md)
- [EstimatedTransactionFeeResponse](docs/EstimatedTransactionFeeResponse.md)
+ - [EthereumBlockchainData](docs/EthereumBlockchainData.md)
+ - [EuropeanSEPAAddress](docs/EuropeanSEPAAddress.md)
+ - [EuropeanSEPADestination](docs/EuropeanSEPADestination.md)
- [ExchangeAccount](docs/ExchangeAccount.md)
- [ExchangeAsset](docs/ExchangeAsset.md)
- [ExchangeSettlementTransactionsResponse](docs/ExchangeSettlementTransactionsResponse.md)
@@ -772,14 +835,21 @@ Class | Method | HTTP request | Description
- [ExecutionResponseBaseDetails](docs/ExecutionResponseBaseDetails.md)
- [ExecutionResponseDetails](docs/ExecutionResponseDetails.md)
- [ExecutionScreeningOperation](docs/ExecutionScreeningOperation.md)
- - [ExecutionStep](docs/ExecutionStep.md)
- - [ExecutionStepDetails](docs/ExecutionStepDetails.md)
- [ExecutionStepError](docs/ExecutionStepError.md)
- [ExecutionStepStatusEnum](docs/ExecutionStepStatusEnum.md)
- [ExecutionStepType](docs/ExecutionStepType.md)
- [ExecutionTransferOperation](docs/ExecutionTransferOperation.md)
- [ExternalAccount](docs/ExternalAccount.md)
+ - [ExternalAccountLocalBankAfrica](docs/ExternalAccountLocalBankAfrica.md)
+ - [ExternalAccountLocalBankAfricaType](docs/ExternalAccountLocalBankAfricaType.md)
+ - [ExternalAccountMobileMoney](docs/ExternalAccountMobileMoney.md)
+ - [ExternalAccountMobileMoneyProvider](docs/ExternalAccountMobileMoneyProvider.md)
+ - [ExternalAccountMobileMoneyType](docs/ExternalAccountMobileMoneyType.md)
+ - [ExternalAccountSenderInformation](docs/ExternalAccountSenderInformation.md)
+ - [ExternalAccountType](docs/ExternalAccountType.md)
- [ExternalWalletAsset](docs/ExternalWalletAsset.md)
+ - [Failure](docs/Failure.md)
+ - [FailureReason](docs/FailureReason.md)
- [Fee](docs/Fee.md)
- [FeeBreakdown](docs/FeeBreakdown.md)
- [FeeBreakdownOneOf](docs/FeeBreakdownOneOf.md)
@@ -788,12 +858,15 @@ Class | Method | HTTP request | Description
- [FeeLevel](docs/FeeLevel.md)
- [FeePayerInfo](docs/FeePayerInfo.md)
- [FeePropertiesDetails](docs/FeePropertiesDetails.md)
+ - [FeeTypeEnum](docs/FeeTypeEnum.md)
- [FetchAbiRequestDto](docs/FetchAbiRequestDto.md)
- [FiatAccount](docs/FiatAccount.md)
- [FiatAccountType](docs/FiatAccountType.md)
- [FiatAsset](docs/FiatAsset.md)
- [FiatDestination](docs/FiatDestination.md)
+ - [FiatPaymentMetadata](docs/FiatPaymentMetadata.md)
- [FiatTransfer](docs/FiatTransfer.md)
+ - [FixedAmountTypeEnum](docs/FixedAmountTypeEnum.md)
- [FixedFee](docs/FixedFee.md)
- [FreezeTransactionResponse](docs/FreezeTransactionResponse.md)
- [FunctionDoc](docs/FunctionDoc.md)
@@ -813,6 +886,7 @@ Class | Method | HTTP request | Description
- [GetLayerZeroDvnConfigResponse](docs/GetLayerZeroDvnConfigResponse.md)
- [GetLayerZeroPeersResponse](docs/GetLayerZeroPeersResponse.md)
- [GetLinkedCollectionsPaginatedResponse](docs/GetLinkedCollectionsPaginatedResponse.md)
+ - [GetMaxBipIndexUsedResponse](docs/GetMaxBipIndexUsedResponse.md)
- [GetMaxSpendableAmountResponse](docs/GetMaxSpendableAmountResponse.md)
- [GetMpcKeysResponse](docs/GetMpcKeysResponse.md)
- [GetNFTsResponse](docs/GetNFTsResponse.md)
@@ -832,6 +906,7 @@ Class | Method | HTTP request | Description
- [IbanPaymentInfo](docs/IbanPaymentInfo.md)
- [Identification](docs/Identification.md)
- [IdlType](docs/IdlType.md)
+ - [IndicativeQuoteEnum](docs/IndicativeQuoteEnum.md)
- [IndicativeQuoteType](docs/IndicativeQuoteType.md)
- [InitiatorConfig](docs/InitiatorConfig.md)
- [InitiatorConfigPattern](docs/InitiatorConfigPattern.md)
@@ -839,7 +914,6 @@ Class | Method | HTTP request | Description
- [InternalReference](docs/InternalReference.md)
- [InternalTransferResponse](docs/InternalTransferResponse.md)
- [InvalidParamaterValueError](docs/InvalidParamaterValueError.md)
- - [Job](docs/Job.md)
- [JobCreated](docs/JobCreated.md)
- [LayerZeroAdapterCreateParams](docs/LayerZeroAdapterCreateParams.md)
- [LbtPaymentInfo](docs/LbtPaymentInfo.md)
@@ -874,9 +948,7 @@ Class | Method | HTTP request | Description
- [LegacyPublishDraftRequest](docs/LegacyPublishDraftRequest.md)
- [LegacyPublishResult](docs/LegacyPublishResult.md)
- [LegacySrcOrDestAttributesInner](docs/LegacySrcOrDestAttributesInner.md)
- - [LimitExecutionRequestDetails](docs/LimitExecutionRequestDetails.md)
- - [LimitExecutionResponseDetails](docs/LimitExecutionResponseDetails.md)
- - [LimitTypeDetails](docs/LimitTypeDetails.md)
+ - [LinkedTokensCount](docs/LinkedTokensCount.md)
- [ListAssetsResponse](docs/ListAssetsResponse.md)
- [ListBlockchainsResponse](docs/ListBlockchainsResponse.md)
- [ListOwnedCollectionsResponse](docs/ListOwnedCollectionsResponse.md)
@@ -887,7 +959,9 @@ Class | Method | HTTP request | Description
- [MarketExecutionRequestDetails](docs/MarketExecutionRequestDetails.md)
- [MarketExecutionResponseDetails](docs/MarketExecutionResponseDetails.md)
- [MarketRequoteRequestDetails](docs/MarketRequoteRequestDetails.md)
+ - [MarketRequoteTypeEnum](docs/MarketRequoteTypeEnum.md)
- [MarketTypeDetails](docs/MarketTypeDetails.md)
+ - [MarketTypeEnum](docs/MarketTypeEnum.md)
- [MediaEntityResponse](docs/MediaEntityResponse.md)
- [MergeStakeAccountsRequest](docs/MergeStakeAccountsRequest.md)
- [MergeStakeAccountsResponse](docs/MergeStakeAccountsResponse.md)
@@ -918,11 +992,15 @@ Class | Method | HTTP request | Description
- [NotificationPaginatedResponse](docs/NotificationPaginatedResponse.md)
- [NotificationStatus](docs/NotificationStatus.md)
- [NotificationWithData](docs/NotificationWithData.md)
+ - [OnchainTransaction](docs/OnchainTransaction.md)
+ - [OnchainTransactionsPagedResponse](docs/OnchainTransactionsPagedResponse.md)
- [OneTimeAddress](docs/OneTimeAddress.md)
- [OneTimeAddressAccount](docs/OneTimeAddressAccount.md)
+ - [OneTimeAddressPeerType](docs/OneTimeAddressPeerType.md)
- [OneTimeAddressReference](docs/OneTimeAddressReference.md)
- [OperationExecutionFailure](docs/OperationExecutionFailure.md)
- [OrderDetails](docs/OrderDetails.md)
+ - [OrderExecutionStep](docs/OrderExecutionStep.md)
- [OrderSide](docs/OrderSide.md)
- [OrderStatus](docs/OrderStatus.md)
- [OrderSummary](docs/OrderSummary.md)
@@ -945,7 +1023,7 @@ Class | Method | HTTP request | Description
- [PaymentAccountResponse](docs/PaymentAccountResponse.md)
- [PaymentAccountType](docs/PaymentAccountType.md)
- [PaymentInstructions](docs/PaymentInstructions.md)
- - [PaymentInstructionsDetails](docs/PaymentInstructionsDetails.md)
+ - [PaymentInstructionsOneOf](docs/PaymentInstructionsOneOf.md)
- [PayoutInitMethod](docs/PayoutInitMethod.md)
- [PayoutInstruction](docs/PayoutInstruction.md)
- [PayoutInstructionResponse](docs/PayoutInstructionResponse.md)
@@ -955,12 +1033,14 @@ Class | Method | HTTP request | Description
- [PayoutStatus](docs/PayoutStatus.md)
- [PeerAdapterInfo](docs/PeerAdapterInfo.md)
- [PeerType](docs/PeerType.md)
+ - [PersonalEntityTypeEnum](docs/PersonalEntityTypeEnum.md)
- [PersonalIdentification](docs/PersonalIdentification.md)
- [PersonalIdentificationFullName](docs/PersonalIdentificationFullName.md)
- [PixAddress](docs/PixAddress.md)
- [PixDestination](docs/PixDestination.md)
- [PixPaymentInfo](docs/PixPaymentInfo.md)
- [PlatformAccount](docs/PlatformAccount.md)
+ - [PlatformPeerType](docs/PlatformPeerType.md)
- [Players](docs/Players.md)
- [PolicyAndValidationResponse](docs/PolicyAndValidationResponse.md)
- [PolicyCheckResult](docs/PolicyCheckResult.md)
@@ -977,24 +1057,24 @@ Class | Method | HTTP request | Description
- [PolicyValidation](docs/PolicyValidation.md)
- [PolicyVerdictActionEnum](docs/PolicyVerdictActionEnum.md)
- [PolicyVerdictActionEnum2](docs/PolicyVerdictActionEnum2.md)
- - [PostOrderSettlement](docs/PostOrderSettlement.md)
- [PostalAddress](docs/PostalAddress.md)
- [PreScreening](docs/PreScreening.md)
- [PrefundedSettlement](docs/PrefundedSettlement.md)
+ - [PrefundedSettlementType](docs/PrefundedSettlementType.md)
- [ProgramCallConfig](docs/ProgramCallConfig.md)
- [Provider](docs/Provider.md)
- - [ProviderID](docs/ProviderID.md)
- [ProvidersListResponse](docs/ProvidersListResponse.md)
- [PublicKeyInformation](docs/PublicKeyInformation.md)
- [PublishDraftRequest](docs/PublishDraftRequest.md)
- [PublishResult](docs/PublishResult.md)
- [Quote](docs/Quote.md)
- [QuoteExecutionRequestDetails](docs/QuoteExecutionRequestDetails.md)
- - [QuoteExecutionResponseDetails](docs/QuoteExecutionResponseDetails.md)
+ - [QuoteExecutionStep](docs/QuoteExecutionStep.md)
- [QuoteExecutionTypeDetails](docs/QuoteExecutionTypeDetails.md)
- [QuoteExecutionWithRequoteRequestDetails](docs/QuoteExecutionWithRequoteRequestDetails.md)
- [QuoteExecutionWithRequoteResponseDetails](docs/QuoteExecutionWithRequoteResponseDetails.md)
- [QuotePropertiesDetails](docs/QuotePropertiesDetails.md)
+ - [QuoteTypeEnum](docs/QuoteTypeEnum.md)
- [QuotesResponse](docs/QuotesResponse.md)
- [ReQuoteDetails](docs/ReQuoteDetails.md)
- [ReQuoteDetailsReQuote](docs/ReQuoteDetailsReQuote.md)
@@ -1012,9 +1092,10 @@ Class | Method | HTTP request | Description
- [RemoveLayerZeroAdaptersResponse](docs/RemoveLayerZeroAdaptersResponse.md)
- [RemoveLayerZeroPeersRequest](docs/RemoveLayerZeroPeersRequest.md)
- [RemoveLayerZeroPeersResponse](docs/RemoveLayerZeroPeersResponse.md)
+ - [RenameConnectedAccountRequest](docs/RenameConnectedAccountRequest.md)
+ - [RenameConnectedAccountResponse](docs/RenameConnectedAccountResponse.md)
- [RenameCosigner](docs/RenameCosigner.md)
- [RenameVaultAccountResponse](docs/RenameVaultAccountResponse.md)
- - [RescanTransaction](docs/RescanTransaction.md)
- [ResendFailedNotificationsJobStatusResponse](docs/ResendFailedNotificationsJobStatusResponse.md)
- [ResendFailedNotificationsRequest](docs/ResendFailedNotificationsRequest.md)
- [ResendFailedNotificationsResponse](docs/ResendFailedNotificationsResponse.md)
@@ -1024,12 +1105,16 @@ Class | Method | HTTP request | Description
- [ResendWebhooksResponse](docs/ResendWebhooksResponse.md)
- [RespondToConnectionRequest](docs/RespondToConnectionRequest.md)
- [RetryRequoteRequestDetails](docs/RetryRequoteRequestDetails.md)
+ - [RetryRequoteTypeEnum](docs/RetryRequoteTypeEnum.md)
- [RewardInfo](docs/RewardInfo.md)
- [RewardsInfo](docs/RewardsInfo.md)
+ - [RoleDetails](docs/RoleDetails.md)
+ - [RoleGrantee](docs/RoleGrantee.md)
- [SEPAAddress](docs/SEPAAddress.md)
- [SEPADestination](docs/SEPADestination.md)
- [SOLAccount](docs/SOLAccount.md)
- [SOLAccountWithValue](docs/SOLAccountWithValue.md)
+ - [ScopeItem](docs/ScopeItem.md)
- [ScreeningAlertExposureTypeEnum](docs/ScreeningAlertExposureTypeEnum.md)
- [ScreeningAmlAlert](docs/ScreeningAmlAlert.md)
- [ScreeningAmlMatchedRule](docs/ScreeningAmlMatchedRule.md)
@@ -1086,6 +1171,7 @@ Class | Method | HTTP request | Description
- [SettlementRequestBody](docs/SettlementRequestBody.md)
- [SettlementResponse](docs/SettlementResponse.md)
- [SettlementSourceAccount](docs/SettlementSourceAccount.md)
+ - [Side](docs/Side.md)
- [SignedMessage](docs/SignedMessage.md)
- [SignedMessageSignature](docs/SignedMessageSignature.md)
- [SigningKeyDto](docs/SigningKeyDto.md)
@@ -1132,26 +1218,69 @@ Class | Method | HTTP request | Description
- [SpeiDestination](docs/SpeiDestination.md)
- [SplitRequest](docs/SplitRequest.md)
- [SplitResponse](docs/SplitResponse.md)
+ - [StEthBlockchainData](docs/StEthBlockchainData.md)
- [StakeRequest](docs/StakeRequest.md)
- [StakeResponse](docs/StakeResponse.md)
- [StakingProvider](docs/StakingProvider.md)
- [Status](docs/Status.md)
- [StellarRippleCreateParamsDto](docs/StellarRippleCreateParamsDto.md)
+ - [SupportedBlockChainsResponse](docs/SupportedBlockChainsResponse.md)
+ - [SupportedBlockchain](docs/SupportedBlockchain.md)
- [SwiftAddress](docs/SwiftAddress.md)
- [SwiftDestination](docs/SwiftDestination.md)
- [SystemMessageInfo](docs/SystemMessageInfo.md)
+ - [TRLinkAPIPagedResponse](docs/TRLinkAPIPagedResponse.md)
- [TRLinkAmount](docs/TRLinkAmount.md)
+ - [TRLinkAmount2](docs/TRLinkAmount2.md)
+ - [TRLinkAmountRange](docs/TRLinkAmountRange.md)
+ - [TRLinkAssessTravelRuleRequest](docs/TRLinkAssessTravelRuleRequest.md)
+ - [TRLinkAssessTravelRuleResponse](docs/TRLinkAssessTravelRuleResponse.md)
+ - [TRLinkAssessmentDecision](docs/TRLinkAssessmentDecision.md)
+ - [TRLinkAsset](docs/TRLinkAsset.md)
+ - [TRLinkAssetData](docs/TRLinkAssetData.md)
+ - [TRLinkAssetFormat](docs/TRLinkAssetFormat.md)
+ - [TRLinkAssetsListPagedResponse](docs/TRLinkAssetsListPagedResponse.md)
+ - [TRLinkCancelTrmRequest](docs/TRLinkCancelTrmRequest.md)
+ - [TRLinkConnectIntegrationRequest](docs/TRLinkConnectIntegrationRequest.md)
+ - [TRLinkCreateCustomerRequest](docs/TRLinkCreateCustomerRequest.md)
+ - [TRLinkCreateIntegrationRequest](docs/TRLinkCreateIntegrationRequest.md)
+ - [TRLinkCreateTrmRequest](docs/TRLinkCreateTrmRequest.md)
+ - [TRLinkCurrency](docs/TRLinkCurrency.md)
+ - [TRLinkCustomerIntegrationResponse](docs/TRLinkCustomerIntegrationResponse.md)
+ - [TRLinkCustomerResponse](docs/TRLinkCustomerResponse.md)
+ - [TRLinkDestinationTransferPeerPath](docs/TRLinkDestinationTransferPeerPath.md)
+ - [TRLinkDiscoverableStatus](docs/TRLinkDiscoverableStatus.md)
+ - [TRLinkFiatValue](docs/TRLinkFiatValue.md)
+ - [TRLinkGeographicAddressRequest](docs/TRLinkGeographicAddressRequest.md)
+ - [TRLinkGetSupportedAssetResponse](docs/TRLinkGetSupportedAssetResponse.md)
+ - [TRLinkIvms](docs/TRLinkIvms.md)
+ - [TRLinkIvmsResponse](docs/TRLinkIvmsResponse.md)
+ - [TRLinkJwkPublicKey](docs/TRLinkJwkPublicKey.md)
- [TRLinkMissingTrmAction](docs/TRLinkMissingTrmAction.md)
+ - [TRLinkMissingTrmAction2](docs/TRLinkMissingTrmAction2.md)
- [TRLinkMissingTrmActionEnum](docs/TRLinkMissingTrmActionEnum.md)
- [TRLinkMissingTrmDecision](docs/TRLinkMissingTrmDecision.md)
- [TRLinkMissingTrmRule](docs/TRLinkMissingTrmRule.md)
+ - [TRLinkMissingTrmRule2](docs/TRLinkMissingTrmRule2.md)
+ - [TRLinkOneTimeAddress](docs/TRLinkOneTimeAddress.md)
+ - [TRLinkPaging](docs/TRLinkPaging.md)
+ - [TRLinkPartnerResponse](docs/TRLinkPartnerResponse.md)
+ - [TRLinkPolicyResponse](docs/TRLinkPolicyResponse.md)
+ - [TRLinkPostScreeningAction](docs/TRLinkPostScreeningAction.md)
- [TRLinkPostScreeningRule](docs/TRLinkPostScreeningRule.md)
+ - [TRLinkPostScreeningRule2](docs/TRLinkPostScreeningRule2.md)
- [TRLinkPreScreeningAction](docs/TRLinkPreScreeningAction.md)
+ - [TRLinkPreScreeningAction2](docs/TRLinkPreScreeningAction2.md)
- [TRLinkPreScreeningActionEnum](docs/TRLinkPreScreeningActionEnum.md)
- [TRLinkPreScreeningRule](docs/TRLinkPreScreeningRule.md)
+ - [TRLinkPreScreeningRule2](docs/TRLinkPreScreeningRule2.md)
+ - [TRLinkProviderData](docs/TRLinkProviderData.md)
- [TRLinkProviderResult](docs/TRLinkProviderResult.md)
- [TRLinkProviderResultWithRule](docs/TRLinkProviderResultWithRule.md)
- [TRLinkProviderResultWithRule2](docs/TRLinkProviderResultWithRule2.md)
+ - [TRLinkPublicAssetInfo](docs/TRLinkPublicAssetInfo.md)
+ - [TRLinkPublicKeyResponse](docs/TRLinkPublicKeyResponse.md)
+ - [TRLinkRedirectTrmRequest](docs/TRLinkRedirectTrmRequest.md)
- [TRLinkRegistrationResult](docs/TRLinkRegistrationResult.md)
- [TRLinkRegistrationResultFullPayload](docs/TRLinkRegistrationResultFullPayload.md)
- [TRLinkRegistrationStatus](docs/TRLinkRegistrationStatus.md)
@@ -1159,22 +1288,39 @@ Class | Method | HTTP request | Description
- [TRLinkResult](docs/TRLinkResult.md)
- [TRLinkResultFullPayload](docs/TRLinkResultFullPayload.md)
- [TRLinkRuleBase](docs/TRLinkRuleBase.md)
+ - [TRLinkSetDestinationTravelRuleMessageIdRequest](docs/TRLinkSetDestinationTravelRuleMessageIdRequest.md)
+ - [TRLinkSetDestinationTravelRuleMessageIdResponse](docs/TRLinkSetDestinationTravelRuleMessageIdResponse.md)
+ - [TRLinkSetTransactionTravelRuleMessageIdRequest](docs/TRLinkSetTransactionTravelRuleMessageIdRequest.md)
+ - [TRLinkSetTransactionTravelRuleMessageIdResponse](docs/TRLinkSetTransactionTravelRuleMessageIdResponse.md)
+ - [TRLinkSourceTransferPeerPath](docs/TRLinkSourceTransferPeerPath.md)
+ - [TRLinkTestConnectionResponse](docs/TRLinkTestConnectionResponse.md)
+ - [TRLinkThresholds](docs/TRLinkThresholds.md)
+ - [TRLinkTransactionDirection](docs/TRLinkTransactionDirection.md)
+ - [TRLinkTransferPeerPath](docs/TRLinkTransferPeerPath.md)
+ - [TRLinkTrmDirection](docs/TRLinkTrmDirection.md)
+ - [TRLinkTrmInfoResponse](docs/TRLinkTrmInfoResponse.md)
- [TRLinkTrmScreeningStatus](docs/TRLinkTrmScreeningStatus.md)
- [TRLinkTrmScreeningStatusEnum](docs/TRLinkTrmScreeningStatusEnum.md)
+ - [TRLinkTrmStatus](docs/TRLinkTrmStatus.md)
+ - [TRLinkTxnInfo](docs/TRLinkTxnInfo.md)
+ - [TRLinkUpdateCustomerRequest](docs/TRLinkUpdateCustomerRequest.md)
+ - [TRLinkVaspDto](docs/TRLinkVaspDto.md)
+ - [TRLinkVaspGeographicAddress](docs/TRLinkVaspGeographicAddress.md)
+ - [TRLinkVaspListDto](docs/TRLinkVaspListDto.md)
+ - [TRLinkVaspNationalIdentification](docs/TRLinkVaspNationalIdentification.md)
- [TRLinkVerdict](docs/TRLinkVerdict.md)
- [TRLinkVerdictEnum](docs/TRLinkVerdictEnum.md)
- [Tag](docs/Tag.md)
- [TagAttachmentOperationAction](docs/TagAttachmentOperationAction.md)
- [TagsPagedResponse](docs/TagsPagedResponse.md)
- - [Task](docs/Task.md)
- [TemplatesPaginatedResponse](docs/TemplatesPaginatedResponse.md)
- [ThirdPartyRouting](docs/ThirdPartyRouting.md)
- - [TimeInForce](docs/TimeInForce.md)
- [TimePeriodConfig](docs/TimePeriodConfig.md)
- [TimePeriodMatchType](docs/TimePeriodMatchType.md)
- [ToCollateralTransaction](docs/ToCollateralTransaction.md)
- [ToExchangeTransaction](docs/ToExchangeTransaction.md)
- [TokenCollectionResponse](docs/TokenCollectionResponse.md)
+ - [TokenContractSummaryResponse](docs/TokenContractSummaryResponse.md)
- [TokenInfoNotFoundErrorResponse](docs/TokenInfoNotFoundErrorResponse.md)
- [TokenLinkDto](docs/TokenLinkDto.md)
- [TokenLinkDtoTokenMetadata](docs/TokenLinkDtoTokenMetadata.md)
@@ -1186,9 +1332,10 @@ Class | Method | HTTP request | Description
- [TokenOwnershipStatusUpdatePayload](docs/TokenOwnershipStatusUpdatePayload.md)
- [TokenResponse](docs/TokenResponse.md)
- [TokensPaginatedResponse](docs/TokensPaginatedResponse.md)
+ - [TotalSupplyItemDto](docs/TotalSupplyItemDto.md)
+ - [TotalSupplyPagedResponse](docs/TotalSupplyPagedResponse.md)
- [TradingAccountType](docs/TradingAccountType.md)
- - [TradingErrorResponse](docs/TradingErrorResponse.md)
- - [TradingErrorResponseError](docs/TradingErrorResponseError.md)
+ - [TradingErrorSchema](docs/TradingErrorSchema.md)
- [TradingProvider](docs/TradingProvider.md)
- [Transaction](docs/Transaction.md)
- [TransactionDirection](docs/TransactionDirection.md)
@@ -1267,7 +1414,11 @@ Class | Method | HTTP request | Description
- [TravelRuleValidateTransactionResponse](docs/TravelRuleValidateTransactionResponse.md)
- [TravelRuleVaspForVault](docs/TravelRuleVaspForVault.md)
- [TravelRuleVerdictEnum](docs/TravelRuleVerdictEnum.md)
+ - [TrustProofOfAddressCreateResponse](docs/TrustProofOfAddressCreateResponse.md)
+ - [TrustProofOfAddressRequest](docs/TrustProofOfAddressRequest.md)
+ - [TrustProofOfAddressResponse](docs/TrustProofOfAddressResponse.md)
- [TxLog](docs/TxLog.md)
+ - [TypedMessageTransactionStatusEnum](docs/TypedMessageTransactionStatusEnum.md)
- [USWireAddress](docs/USWireAddress.md)
- [USWireDestination](docs/USWireDestination.md)
- [UnfreezeTransactionResponse](docs/UnfreezeTransactionResponse.md)
@@ -1295,7 +1446,6 @@ Class | Method | HTTP request | Description
- [UserType](docs/UserType.md)
- [ValidateAddressResponse](docs/ValidateAddressResponse.md)
- [ValidateLayerZeroChannelResponse](docs/ValidateLayerZeroChannelResponse.md)
- - [ValidatedTransactionsForRescan](docs/ValidatedTransactionsForRescan.md)
- [ValidationKeyDto](docs/ValidationKeyDto.md)
- [Validator](docs/Validator.md)
- [VaultAccount](docs/VaultAccount.md)
@@ -1306,13 +1456,12 @@ Class | Method | HTTP request | Description
- [VaultAccountsPagedResponsePaging](docs/VaultAccountsPagedResponsePaging.md)
- [VaultAccountsTagAttachmentOperationsRequest](docs/VaultAccountsTagAttachmentOperationsRequest.md)
- [VaultAccountsTagAttachmentOperationsResponse](docs/VaultAccountsTagAttachmentOperationsResponse.md)
- - [VaultAccountsTagAttachmentsRequest](docs/VaultAccountsTagAttachmentsRequest.md)
- [VaultActionStatus](docs/VaultActionStatus.md)
- [VaultAsset](docs/VaultAsset.md)
- [VaultWalletAddress](docs/VaultWalletAddress.md)
- [VendorDto](docs/VendorDto.md)
- [VerdictConfig](docs/VerdictConfig.md)
- - [Version](docs/Version.md)
+ - [VersionSummary](docs/VersionSummary.md)
- [WalletAsset](docs/WalletAsset.md)
- [WalletAssetAdditionalInfo](docs/WalletAssetAdditionalInfo.md)
- [Webhook](docs/Webhook.md)
@@ -1331,5 +1480,5 @@ Class | Method | HTTP request | Description
## Author
-support@fireblocks.com
+developers@fireblocks.com
diff --git a/api/openapi.yaml b/api/openapi.yaml
index 4c8edf89..d4759e09 100644
--- a/api/openapi.yaml
+++ b/api/openapi.yaml
@@ -1,15 +1,26 @@
openapi: 3.0.0
info:
contact:
- email: support@fireblocks.com
+ email: developers@fireblocks.com
+ description: |
+ Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain.
+
+ - Visit our website for more information: [Fireblocks Website](https://fireblocks.com)
+ - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com)
title: Fireblocks API
version: 1.6.2
servers:
-- url: https://api.fireblocks.io/v1
+- description: Fireblocks Production Environment Base URL
+ url: https://api.fireblocks.io/v1
+- description: Fireblocks Sandbox Environment Base URL
+ url: https://sandbox-api.fireblocks.io/v1
paths:
/vault/accounts:
get:
- description: Gets all vault accounts in your workspace.
+ deprecated: true
+ description: |-
+ DEPRECATED - Please use `/vault/accounts_paged` endpoint instead.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getVaultAccounts
parameters:
- explode: true
@@ -53,7 +64,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: List vault accounts
+ summary: Get vault accounts
tags:
- Vaults
x-internal: true
@@ -69,7 +80,11 @@ paths:
x-accepts:
- application/json
post:
- description: Creates a new vault account with the requested name.
+ description: |-
+ Creates a new vault account with the requested name.
+ **Note: ** Vault account names should consist of ASCII characters only.
+ Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: createVaultAccount
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -140,8 +155,9 @@ paths:
- application/json
/vault/accounts_paged:
get:
- description: Gets all vault accounts in your workspace. This endpoint returns
- a limited amount of results with a quick response time.
+ description: |-
+ Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getPagedVaultAccounts
parameters:
- explode: true
@@ -159,12 +175,14 @@ paths:
type: string
style: form
- description: "Specifying minAmountThreshold will filter accounts with balances\
- \ greater than this value, otherwise, it will return all accounts."
+ \ greater than this value, otherwise, it will return all accounts. The amount\
+ \ set in this parameter is the native asset amount and not its USD value."
explode: true
in: query
name: minAmountThreshold
required: false
schema:
+ example: 10
type: number
style: form
- explode: true
@@ -210,7 +228,8 @@ paths:
minimum: 1
type: number
style: form
- - description: List of tag IDs to filter vault accounts.
+ - deprecated: true
+ description: DEPRECATED - use includeTagIds instead
explode: true
in: query
name: tagIds
@@ -219,7 +238,33 @@ paths:
items:
format: uuid
type: string
- maxItems: 100
+ maxItems: 50
+ type: array
+ style: form
+ - description: List of tag IDs to include. Vault accounts with any of these
+ tags will be included
+ explode: true
+ in: query
+ name: includeTagIds
+ required: false
+ schema:
+ items:
+ format: uuid
+ type: string
+ maxItems: 50
+ type: array
+ style: form
+ - description: List of tag IDs to exclude. Vault accounts with any of these
+ tags will be filtered out
+ explode: true
+ in: query
+ name: excludeTagIds
+ required: false
+ schema:
+ items:
+ format: uuid
+ type: string
+ maxItems: 50
type: array
style: form
responses:
@@ -232,7 +277,7 @@ paths:
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List vault accounts (Paginated)
+ summary: Get vault accounts (Paginated)
tags:
- Vaults
x-rate-limit-category: external_query
@@ -251,12 +296,13 @@ paths:
- language: java
code: "CompletableFuture> response\
\ = fireblocks.vaults().getPagedVaultAccounts(namePrefix, nameSuffix,\
- \ minAmountThreshold, assetId, orderBy, before, after, limit, tagIds);"
+ \ minAmountThreshold, assetId, orderBy, before, after, limit, tagIds,\
+ \ includeTagIds, excludeTagIds);"
name: Fireblocks SDK Java example
- language: python
code: "response = fireblocks.vaults.get_paged_vault_accounts(name_prefix,\
\ name_suffix, min_amount_threshold, asset_id, order_by, before, after,\
- \ limit, tag_ids);"
+ \ limit, tag_ids, include_tag_ids, exclude_tag_ids);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
@@ -265,19 +311,21 @@ paths:
- lang: Java
source: "CompletableFuture> response\
\ = fireblocks.vaults().getPagedVaultAccounts(namePrefix, nameSuffix, minAmountThreshold,\
- \ assetId, orderBy, before, after, limit, tagIds);"
+ \ assetId, orderBy, before, after, limit, tagIds, includeTagIds, excludeTagIds);"
- lang: Python
source: "response = fireblocks.vaults.get_paged_vault_accounts(name_prefix,\
\ name_suffix, min_amount_threshold, asset_id, order_by, before, after,\
- \ limit, tag_ids);"
+ \ limit, tag_ids, include_tag_ids, exclude_tag_ids);"
x-accepts:
- application/json
/vault/accounts/{vaultAccountId}:
get:
- description: Returns the requested vault account.
+ description: |-
+ Get a vault account by its unique ID.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getVaultAccount
parameters:
- - description: "The ID of the vault account to return type: string"
+ - description: The ID of the vault account
explode: false
in: path
name: vaultAccountId
@@ -299,7 +347,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Find a vault account by ID
+ summary: Get a vault account by ID
tags:
- Vaults
x-rate-limit-category: external_query
@@ -330,7 +378,9 @@ paths:
x-accepts:
- application/json
put:
- description: Renames the requested vault account.
+ description: |-
+ Renames the requested vault account.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver.
operationId: updateVaultAccount
parameters:
- description: The ID of the vault account to edit
@@ -415,11 +465,13 @@ paths:
- application/json
/vault/asset_wallets:
get:
- description: |
- Gets all asset wallets at all of the vault accounts in your workspace. An asset wallet is an asset at a vault account. This method allows fast traversal of all account balances.
+ description: "Get all vault wallets of the vault accounts in your workspace.\
+ \ \nA vault wallet is an asset in a vault account. \n\nThis method allows\
+ \ fast traversal of all account balances.\nEndpoint Permission: Admin,\
+ \ Non-Signing Admin, Signer, Approver, Editor, Viewer."
operationId: getAssetWallets
parameters:
- - description: "When specified, only asset wallets with total balance larger\
+ - description: "When specified, only vault wallets with total balance greater\
\ than this amount are returned."
explode: true
in: query
@@ -428,8 +480,8 @@ paths:
schema:
type: number
style: form
- - description: "When specified, only asset wallets cross vault accounts that\
- \ have this asset ID are returned."
+ - description: "When specified, only vault wallets with the specified ID are\
+ \ returned."
explode: true
in: query
name: assetId
@@ -449,8 +501,9 @@ paths:
- DESC
type: string
style: form
- - description: Fetches the next paginated response before this element. This
- element is a cursor and is returned at the response of the previous page.
+ - description: "Fetches the next paginated response before this element. \n\
+ This element is a cursor and is returned at the response of the previous\
+ \ page.\n"
explode: true
in: query
name: before
@@ -467,8 +520,8 @@ paths:
schema:
type: string
style: form
- - description: The maximum number of asset wallets in a single response. The
- default is 200 and the maximum is 1000.
+ - description: "The maximum number of vault wallets in a single response. \n\
+ \nThe default is 200 and the maximum is 1000.\n"
explode: true
in: query
name: limit
@@ -489,7 +542,7 @@ paths:
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List asset wallets (Paginated)
+ summary: Get vault wallets (Paginated)
tags:
- Vaults
x-rate-limit-category: query
@@ -529,7 +582,13 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/hide:
post:
- description: Hides the requested vault account from the web console view.
+ description: |-
+ Hides the requested vault account from the web console view.
+ This operation is required when creating thousands of vault accounts to serve your end-users.
+ Used for preventing the web console to be swamped with too much vault accounts.
+ Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts).
+ NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: hideVaultAccount
parameters:
- description: The vault account to hide
@@ -603,7 +662,9 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/unhide:
post:
- description: Makes a hidden vault account visible in web console view.
+ description: |-
+ Makes a hidden vault account visible in web console view.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: unhideVaultAccount
parameters:
- description: The vault account to unhide
@@ -677,7 +738,10 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/activate:
post:
- description: Initiates activation for a wallet in a vault account.
+ description: "Initiates activation for a wallet in a vault account. \nActivation\
+ \ is required for tokens that need an on-chain transaction for creation (XLM\
+ \ tokens, SOL tokens etc).\nEndpoint Permission: Admin, Non-Signing Admin,\
+ \ Signer, Approver, Editor."
operationId: activateAssetForVaultAccount
parameters:
- description: "The ID of the vault account to return, or 'default' for the\
@@ -757,7 +821,9 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/set_customer_ref_id:
post:
- description: Assigns an AML/KYT customer reference ID for the vault account.
+ description: "Assigns an AML/KYT customer reference ID for the vault account.\
+ \ Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies).\
+ \ Endpoint Permission: Admin, Non-Signing Admin."
operationId: setVaultAccountCustomerRefId
parameters:
- description: The vault account ID
@@ -799,7 +865,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Set an AML/KYT customer reference ID for a vault account
+ summary: Set an AML/KYT ID for a vault account
tags:
- Vaults
x-rate-limit-category: write
@@ -840,8 +906,11 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/set_auto_fuel:
post:
- description: Sets the autofueling property of the vault account to enabled or
- disabled.
+ description: |-
+ Toggles the auto fueling property of the vault account to enabled or disabled.
+ Vault Accounts with 'autoFuel=true' are monitored and auto fueled by the Fireblocks Gas Station.
+ Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: setVaultAccountAutoFuel
parameters:
- description: The vault account ID
@@ -883,7 +952,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Turn autofueling on or off
+ summary: Set auto fueling to on or off
tags:
- Vaults
x-rate-limit-category: write
@@ -916,7 +985,11 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}:
get:
- description: Returns a wallet for a specific asset of a vault account.
+ description: |-
+ Returns a specific vault wallet balance information for a specific asset.
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,
+ Viewer.
operationId: getVaultAccountAsset
parameters:
- description: The ID of the vault account to return
@@ -984,7 +1057,10 @@ paths:
x-accepts:
- application/json
post:
- description: Creates a wallet for a specific asset in a vault account.
+ description: |-
+ Creates a wallet for a specific asset in a vault account.
+ Learn more about Fireblocks Vault Wallets in the following [guide](https://developers.fireblocks.com/reference/create-vault-wallet).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: createVaultAccountAsset
parameters:
- description: "The ID of the vault account to return, or 'default' for the\
@@ -1036,7 +1112,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Create a new wallet
+ summary: Create a new vault wallet
tags:
- Vaults
x-rate-limit-category: write
@@ -1078,7 +1154,13 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/balance:
post:
- description: Updates the balance of a specific asset in a vault account.
+ description: |-
+ Updates the balance of a specific asset in a vault account.
+
+ This API endpoint is subject to a strict rate limit.
+ Should be used by clients in very specific scenarios.
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: updateVaultAccountAssetBalance
parameters:
- description: The ID of the vault account to return
@@ -1161,13 +1243,15 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/addresses:
get:
+ deprecated: true
description: |-
- Lists all addresses for specific asset of vault account.
- - This endpoint will be deprecated on Mar 31,2024.
+ DEPRECATED!
+
- If your application logic or scripts rely on the deprecated endpoint, you should update to account for GET/V1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated before Mar 31,2024.
- All workspaces created after Mar 31,2024. will have it disabled. If it is disabled for your workspace and you attempt to use it, you will receive the following error message: "This endpoint is unavailable.
- - Please use the GET/V1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated endpoint to return all the wallet addresses associated with the specified vault account and asset in a paginated list.
- - This API call is subject to rate limits.
+ - Please use the GET /v1/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated endpoint to return all the wallet addresses associated with the specified vault account and asset in a paginated list.
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getVaultAccountAssetAddresses
parameters:
- description: The ID of the vault account to return
@@ -1219,7 +1303,13 @@ paths:
x-accepts:
- application/json
post:
- description: Creates a new deposit address for an asset of a vault account.
+ description: |-
+ Creates a new deposit address for an asset of a vault account.
+ Should be used for UTXO or Tag/Memo based assets ONLY.
+
+ Requests with account based assets will fail.
+
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: createVaultAccountAssetAddress
parameters:
- description: The ID of the vault account to return
@@ -1313,8 +1403,9 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated:
get:
- description: Returns a paginated response of the addresses for a given vault
- account and asset.
+ description: |-
+ Returns a paginated response of the addresses for a given vault account and asset.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getVaultAccountAssetAddressesPaginated
parameters:
- description: The ID of the vault account to return
@@ -1369,7 +1460,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: List addresses (Paginated)
+ summary: Get addresses (Paginated)
tags:
- Vaults
x-rate-limit-category: query
@@ -1411,10 +1502,12 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount:
get:
- description: "Get the maximum amount of a particular asset that can be spent\
- \ in a single transaction from a specified vault account (UTXO assets only,\
- \ with a limitation on number of inputs embedded). Send several transactions\
- \ if you want to spend more than the maximum spendable amount."
+ description: |
+ **UTXO assets only.**
+
+ Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account.
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getMaxSpendableAmount
parameters:
- description: "The ID of the vault account, or 'default' for the default vault\
@@ -1459,7 +1552,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get the maximum spendable amount in a single transaction.
+ summary: Get max spendable amount in a transaction
tags:
- Vaults
x-rate-limit-category: read
@@ -1498,10 +1591,78 @@ paths:
\ asset_id, manual_signging);"
x-accepts:
- application/json
+ /vault/accounts/{vaultAccountId}/{assetId}/max_bip_index_used:
+ get:
+ description: Retrieves the maximum BIP44 address index and change address index
+ used for a specific asset in a vault account (BIP44 standard).
+ operationId: getMaxBipIndexUsed
+ parameters:
+ - description: The ID of the vault account
+ explode: false
+ in: path
+ name: vaultAccountId
+ required: true
+ schema:
+ format: numeric
+ type: string
+ x-fb-entity: vault_account
+ style: simple
+ - description: The ID of the asset
+ explode: false
+ in: path
+ name: assetId
+ required: true
+ schema:
+ type: string
+ x-fb-entity: asset
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/GetMaxBipIndexUsedResponse"
+ description: OK
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get maximum BIP44 index used
+ tags:
+ - Vaults
+ x-rate-limit-category: read
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.vaults.getMaxBipIndexUsed(vaultsApiGetMaxBipIndexUsedRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture> response\
+ \ = fireblocks.vaults().getMaxBipIndexUsed(vaultAccountId, assetId);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.vaults.get_max_bip_index_used(vault_account_id,\
+ \ asset_id);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.vaults.getMaxBipIndexUsed(vaultsApiGetMaxBipIndexUsedRequest);"
+ - lang: Java
+ source: "CompletableFuture> response\
+ \ = fireblocks.vaults().getMaxBipIndexUsed(vaultAccountId, assetId);"
+ - lang: Python
+ source: "response = fireblocks.vaults.get_max_bip_index_used(vault_account_id,\
+ \ asset_id);"
+ x-accepts:
+ - application/json
/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}:
put:
- description: Updates the description of an existing address of an asset in a
- vault account.
+ description: |-
+ Updates the description of an existing address of an asset in a vault account.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: updateVaultAccountAssetAddress
parameters:
- description: The ID of the vault account
@@ -1602,7 +1763,9 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id:
post:
- description: Sets an AML/KYT customer reference ID for a specific address.
+ description: |-
+ Sets an AML/KYT customer reference ID for a specific address.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: setCustomerRefIdForAddress
parameters:
- description: The ID of the vault account
@@ -1703,7 +1866,9 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy:
post:
- description: Converts an existing segwit address to the legacy format.
+ description: |-
+ Converts an existing segwit address to the legacy format.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: createLegacyAddress
parameters:
- description: The ID of the vault account
@@ -1790,7 +1955,10 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs:
get:
- description: Returns unspent inputs information of an asset in a vault account.
+ description: |-
+ Returns unspent inputs information of an UTXO asset in a vault account.
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getUnspentInputs
parameters:
- description: The ID of the vault account
@@ -1863,12 +2031,10 @@ paths:
- application/json
/vault/accounts/bulk:
post:
- description: |
- Create multiple vault accounts by running an async job.
- **Note**:
- - These endpoints are currently in beta and might be subject to changes.
- - We limit accounts to 10k per operation and 200k per customer during beta testing.
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ description: "Create multiple vault accounts by running an async job. \n\
+ - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported.\n\
+ - Limited to a maximum of 10,000 accounts per operation.\n\n**Endpoint Permissions:**\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor.\n"
operationId: createMultipleAccounts
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -1932,8 +2098,9 @@ paths:
/vault/accounts/bulk/{jobId}:
get:
description: |
- Returns the status of bulk creation of new vault accounts job and the result or error
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
+ Returns the current status of (or error for) the specified vault account bulk creation job.
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getCreateMultipleVaultAccountsJobStatus
parameters:
- description: The ID of the job to create addresses
@@ -1988,10 +2155,13 @@ paths:
/vault/accounts/addresses/bulk:
post:
description: |
- Create multiple deposit address by running an async job.
- **Note**:
- - We limit accounts to 10k per operation.
- Endpoint Permission: Admin, Non-Signing Admin.
+ **For UTXO blockchains only.**
+
+ Create multiple deposit addresses by running an async job.
+ - The target Vault account should already have a UTXO asset wallet with a permanent address.
+ - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed.
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin.
operationId: createMultipleDepositAddresses
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -2054,7 +2224,9 @@ paths:
- application/json
/vault/accounts/attached_tags:
post:
- description: Attach or detach one or more tags from the requested vault accounts.
+ description: |-
+ Attach or detach one or more tags from the requested vault accounts.
+ Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver.
operationId: attachOrDetachTagsFromVaultAccounts
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -2107,7 +2279,7 @@ paths:
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: Attach or detach tags from a vault accounts
+ summary: Attach or detach tags from vault accounts
tags:
- Vaults
x-rate-limit-category: write
@@ -2140,121 +2312,12 @@ paths:
x-content-type: application/json
x-accepts:
- application/json
- /vault/accounts/attached_tags/attach:
- post:
- description: Attach one or more tags to the requested vault accounts. This endpoint
- is deprecated. Please use /vault/accounts/attached_tags instead.
- operationId: attachTagsToVaultAccounts
- parameters:
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
- explode: false
- in: header
- name: Idempotency-Key
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VaultAccountsTagAttachmentsRequest"
- required: true
- responses:
- "204":
- description: Tags were attached successfully
- summary: Attach tags to a vault accounts (deprecated)
- tags:
- - Vaults
- x-rate-limit-category: write
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.vaults.attachTagsToVaultAccounts(vaultsApiAttachTagsToVaultAccountsRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: "CompletableFuture> response = fireblocks.vaults().attachTagsToVaultAccounts(vaultAccountsTagAttachmentsRequest,\
- \ idempotencyKey);"
- name: Fireblocks SDK Java example
- - language: python
- code: "response = fireblocks.vaults.attach_tags_to_vault_accounts(vault_accounts_tag_attachments_request,\
- \ idempotency_key);"
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.vaults.attachTagsToVaultAccounts(vaultsApiAttachTagsToVaultAccountsRequest);"
- - lang: Java
- source: "CompletableFuture> response = fireblocks.vaults().attachTagsToVaultAccounts(vaultAccountsTagAttachmentsRequest,\
- \ idempotencyKey);"
- - lang: Python
- source: "response = fireblocks.vaults.attach_tags_to_vault_accounts(vault_accounts_tag_attachments_request,\
- \ idempotency_key);"
- x-content-type: application/json
- x-accepts:
- - application/json
- /vault/accounts/attached_tags/detach:
- post:
- description: Detach one or more tags from the requested vault account. This
- endpoint is deprecated. Please use /vault/accounts/attached_tags instead.
- operationId: detachTagsFromVaultAccounts
- parameters:
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
- explode: false
- in: header
- name: Idempotency-Key
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/VaultAccountsTagAttachmentsRequest"
- required: true
- responses:
- "204":
- description: Tags were detached successfully
- summary: Detach tags from a vault accounts (deprecated)
- tags:
- - Vaults
- x-rate-limit-category: write
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.vaults.detachTagsFromVaultAccounts(vaultsApiDetachTagsFromVaultAccountsRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: "CompletableFuture> response = fireblocks.vaults().detachTagsFromVaultAccounts(vaultAccountsTagAttachmentsRequest,\
- \ idempotencyKey);"
- name: Fireblocks SDK Java example
- - language: python
- code: "response = fireblocks.vaults.detach_tags_from_vault_accounts(vault_accounts_tag_attachments_request,\
- \ idempotency_key);"
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.vaults.detachTagsFromVaultAccounts(vaultsApiDetachTagsFromVaultAccountsRequest);"
- - lang: Java
- source: "CompletableFuture> response = fireblocks.vaults().detachTagsFromVaultAccounts(vaultAccountsTagAttachmentsRequest,\
- \ idempotencyKey);"
- - lang: Python
- source: "response = fireblocks.vaults.detach_tags_from_vault_accounts(vault_accounts_tag_attachments_request,\
- \ idempotency_key);"
- x-content-type: application/json
- x-accepts:
- - application/json
/vault/accounts/addresses/bulk/{jobId}:
get:
description: |
- Returns the status of bulk creation of new deposit addresses job and the result or error
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
+ Returns the current status of (or an error for) the specified deposit addresss bulk creation job.
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer.
operationId: getCreateMultipleDepositAddressesJobStatus
parameters:
- description: The ID of the job to create addresses
@@ -2278,7 +2341,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get job status of bulk creation of new deposit addresses
+ summary: Get the job status of the bulk deposit address creation
tags:
- Vaults
x-rate-limit-category: read
@@ -2308,8 +2371,9 @@ paths:
- application/json
/vault/public_key_info:
get:
- description: Gets the public key information based on derivation path and signing
- algorithm.
+ description: |-
+ Gets the public key information based on derivation path and signing algorithm.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getPublicKeyInfo
parameters:
- explode: true
@@ -2345,7 +2409,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get the public key information
+ summary: Get the public key for a derivation path
tags:
- Vaults
x-rate-limit-category: read
@@ -2385,7 +2449,9 @@ paths:
- application/json
/vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info:
get:
- description: Gets the public key information for the vault account.
+ description: |-
+ Get the public key information for a specific asset in a vault account.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getPublicKeyInfoForAddress
parameters:
- explode: false
@@ -2438,7 +2504,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get the public key for a vault account
+ summary: Get an asset's public key
tags:
- Vaults
x-rate-limit-category: read
@@ -2478,7 +2544,10 @@ paths:
- application/json
/vault/assets:
get:
- description: Gets the assets amount summary for all accounts or filtered accounts.
+ description: |-
+ Gets the assets amount summary for all accounts or filtered accounts.
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getVaultAssets
parameters:
- explode: true
@@ -2545,77 +2614,12 @@ paths:
\ account_name_suffix);"
x-accepts:
- application/json
- /vault/assets/bulk:
- post:
- description: |
- Create multiple wallets for a given vault account by running an async job.
- **Note**:
- - These endpoints are currently in beta and might be subject to changes.
- - We limit accounts to 10k per operation and 200k per customer during beta testing.
- - Currently, we are only supporting EVM wallets.
- operationId: createAssetsBulk
- parameters:
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
- explode: false
- in: header
- name: Idempotency-Key
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/CreateAssetsBulkRequest"
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/JobCreated"
- description: A JobCreated object
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
- default:
- $ref: "#/components/responses/Error"
- summary: Bulk creation of wallets
- tags:
- - Assets
- x-rate-limit-category: write
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.assets.createAssetsBulk(assetsApiCreateAssetsBulkRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: "CompletableFuture> response = fireblocks.assets().createAssetsBulk(createAssetsBulkRequest,\
- \ idempotencyKey);"
- name: Fireblocks SDK Java example
- - language: python
- code: "response = fireblocks.assets.create_assets_bulk(create_assets_bulk_request,\
- \ idempotency_key);"
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.assets.createAssetsBulk(assetsApiCreateAssetsBulkRequest);"
- - lang: Java
- source: "CompletableFuture> response = fireblocks.assets().createAssetsBulk(createAssetsBulkRequest,\
- \ idempotencyKey);"
- - lang: Python
- source: "response = fireblocks.assets.create_assets_bulk(create_assets_bulk_request,\
- \ idempotency_key);"
- x-content-type: application/json
- x-accepts:
- - application/json
/vault/assets/{assetId}:
get:
- description: Gets the vault balance summary for an asset.
+ description: |-
+ Get the total balance of an asset across all the vault accounts.
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getVaultBalanceByAsset
parameters:
- explode: false
@@ -2638,7 +2642,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get vault balance by asset
+ summary: Get vault balance by an asset
tags:
- Vaults
x-rate-limit-category: read
@@ -2950,6 +2954,253 @@ paths:
source: response = fireblocks.embedded_wallets.get_embedded_wallet(wallet_id);
x-accepts:
- application/json
+ /ncw/wallets/{walletId}/status:
+ patch:
+ description: Update the enabled/disabled status of a specific Non Custodial
+ Wallet
+ operationId: updateEmbeddedWalletStatus
+ parameters:
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
+ required: false
+ schema:
+ type: string
+ style: simple
+ - description: Wallet Id
+ example: 550e8400-e29b-41d4-a716-446655440000
+ explode: false
+ in: path
+ name: walletId
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EnableWallet"
+ required: true
+ responses:
+ "204":
+ description: No Content - Wallet status updated successfully
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Update wallet status
+ tags:
+ - Embedded Wallets
+ x-rate-limit-category: write
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise> = fireblocks.embeddedWallets.updateEmbeddedWalletStatus(embeddedWalletsApiUpdateEmbeddedWalletStatusRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture> response = fireblocks.embeddedWallets().updateEmbeddedWalletStatus(enableWallet,\
+ \ walletId, idempotencyKey);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.embedded_wallets.update_embedded_wallet_status(enable_wallet,\
+ \ wallet_id, idempotency_key);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise> = fireblocks.embeddedWallets.updateEmbeddedWalletStatus(embeddedWalletsApiUpdateEmbeddedWalletStatusRequest);"
+ - lang: Java
+ source: "CompletableFuture> response = fireblocks.embeddedWallets().updateEmbeddedWalletStatus(enableWallet,\
+ \ walletId, idempotencyKey);"
+ - lang: Python
+ source: "response = fireblocks.embedded_wallets.update_embedded_wallet_status(enable_wallet,\
+ \ wallet_id, idempotency_key);"
+ x-content-type: application/json
+ x-accepts:
+ - application/json
+ /ncw/wallets/{walletId}/assign:
+ post:
+ description: Assign a specific Non Custodial Wallet to a user
+ operationId: assignEmbeddedWallet
+ parameters:
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
+ required: false
+ schema:
+ type: string
+ style: simple
+ - description: Wallet Id
+ example: 550e8400-e29b-41d4-a716-446655440000
+ explode: false
+ in: path
+ name: walletId
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EmbeddedWallet"
+ description: Wallet Assigned
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Assign a wallet
+ tags:
+ - Embedded Wallets
+ x-rate-limit-category: write
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise> = fireblocks.embeddedWallets.assignEmbeddedWallet(embeddedWalletsApiAssignEmbeddedWalletRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture> response = fireblocks.embeddedWallets().assignEmbeddedWallet(walletId,\
+ \ idempotencyKey);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.embedded_wallets.assign_embedded_wallet(wallet_id,\
+ \ idempotency_key);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise> = fireblocks.embeddedWallets.assignEmbeddedWallet(embeddedWalletsApiAssignEmbeddedWalletRequest);"
+ - lang: Java
+ source: "CompletableFuture> response = fireblocks.embeddedWallets().assignEmbeddedWallet(walletId,\
+ \ idempotencyKey);"
+ - lang: Python
+ source: "response = fireblocks.embedded_wallets.assign_embedded_wallet(wallet_id,\
+ \ idempotency_key);"
+ x-accepts:
+ - application/json
+ /ncw/wallets/{walletId}/accounts/{accountId}/assets:
+ get:
+ description: Retrieve assets for a specific account under a specific Non Custodial
+ Wallet
+ operationId: getEmbeddedWalletAssets
+ parameters:
+ - description: Wallet Id
+ example: 550e8400-e29b-41d4-a716-446655440000
+ explode: false
+ in: path
+ name: walletId
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: The ID of the account
+ example: "0"
+ explode: false
+ in: path
+ name: accountId
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: Sort by fields
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ default:
+ - assetId
+ items:
+ enum:
+ - assetId
+ - createdAt
+ type: string
+ type: array
+ style: form
+ - description: Cursor to the next page
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Amount of results to return in the next page
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ default: 200
+ maximum: 400
+ type: number
+ style: form
+ - description: Is the order ascending or descending
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: ASC
+ enum:
+ - ASC
+ - DESC
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EmbeddedWalletPaginatedAssetsResponse"
+ description: Successful response
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Retrieve assets
+ tags:
+ - Embedded Wallets
+ x-rate-limit-category: query
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.embeddedWallets.getEmbeddedWalletAssets(embeddedWalletsApiGetEmbeddedWalletAssetsRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture>\
+ \ response = fireblocks.embeddedWallets().getEmbeddedWalletAssets(walletId,\
+ \ accountId, sort, pageCursor, pageSize, order);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.embedded_wallets.get_embedded_wallet_assets(wallet_id,\
+ \ account_id, sort, page_cursor, page_size, order);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.embeddedWallets.getEmbeddedWalletAssets(embeddedWalletsApiGetEmbeddedWalletAssetsRequest);"
+ - lang: Java
+ source: "CompletableFuture>\
+ \ response = fireblocks.embeddedWallets().getEmbeddedWalletAssets(walletId,\
+ \ accountId, sort, pageCursor, pageSize, order);"
+ - lang: Python
+ source: "response = fireblocks.embedded_wallets.get_embedded_wallet_assets(wallet_id,\
+ \ account_id, sort, page_cursor, page_size, order);"
+ x-accepts:
+ - application/json
/ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}:
get:
description: "Get asset under a specific account, under a specific Non Custodial\
@@ -3724,6 +3975,251 @@ paths:
\ device_id);"
x-accepts:
- application/json
+ /ncw/wallets/{walletId}/devices/{deviceId}/status:
+ patch:
+ description: Update the enabled/disabled status of a specific device for a Non
+ Custodial Wallet
+ operationId: updateEmbeddedWalletDeviceStatus
+ parameters:
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
+ required: false
+ schema:
+ type: string
+ style: simple
+ - description: Wallet Id
+ example: 550e8400-e29b-41d4-a716-446655440000
+ explode: false
+ in: path
+ name: walletId
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: Device Id
+ example: 9ee1bff0-6dba-4f0c-9b75-03fe90e66fa3
+ explode: false
+ in: path
+ name: deviceId
+ required: true
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EnableDevice"
+ required: true
+ responses:
+ "204":
+ description: No Content - Device status updated successfully
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Update device status
+ tags:
+ - Embedded Wallets
+ x-rate-limit-category: write
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise> = fireblocks.embeddedWallets.updateEmbeddedWalletDeviceStatus(embeddedWalletsApiUpdateEmbeddedWalletDeviceStatusRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture> response = fireblocks.embeddedWallets().updateEmbeddedWalletDeviceStatus(enableDevice,\
+ \ walletId, deviceId, idempotencyKey);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.embedded_wallets.update_embedded_wallet_device_status(enable_device,\
+ \ wallet_id, device_id, idempotency_key);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise> = fireblocks.embeddedWallets.updateEmbeddedWalletDeviceStatus(embeddedWalletsApiUpdateEmbeddedWalletDeviceStatusRequest);"
+ - lang: Java
+ source: "CompletableFuture> response = fireblocks.embeddedWallets().updateEmbeddedWalletDeviceStatus(enableDevice,\
+ \ walletId, deviceId, idempotencyKey);"
+ - lang: Python
+ source: "response = fireblocks.embedded_wallets.update_embedded_wallet_device_status(enable_device,\
+ \ wallet_id, device_id, idempotency_key);"
+ x-content-type: application/json
+ x-accepts:
+ - application/json
+ /ncw/wallets/{walletId}/devices_paginated:
+ get:
+ description: Get a paginated list of registered devices for a specific Non Custodial
+ Wallet
+ operationId: getEmbeddedWalletDevicesPaginated
+ parameters:
+ - description: Wallet Id
+ example: 550e8400-e29b-41d4-a716-446655440000
+ explode: false
+ in: path
+ name: walletId
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: Sort by fields
+ explode: true
+ in: query
+ name: sort
+ required: false
+ schema:
+ default:
+ - createdAt
+ items:
+ enum:
+ - createdAt
+ type: string
+ type: array
+ style: form
+ - description: Cursor to the next page
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: Amount of results to return in the next page
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ default: 200
+ maximum: 400
+ type: number
+ style: form
+ - description: Is the order ascending or descending
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: ASC
+ enum:
+ - ASC
+ - DESC
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EmbeddedWalletPaginatedDevicesResponse"
+ description: Successful response
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Query parameters were invalid
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get registered devices - paginated
+ tags:
+ - Embedded Wallets
+ x-rate-limit-category: query
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.embeddedWallets.getEmbeddedWalletDevicesPaginated(embeddedWalletsApiGetEmbeddedWalletDevicesPaginatedRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture>\
+ \ response = fireblocks.embeddedWallets().getEmbeddedWalletDevicesPaginated(walletId,\
+ \ sort, pageCursor, pageSize, order);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.embedded_wallets.get_embedded_wallet_devices_paginated(wallet_id,\
+ \ sort, page_cursor, page_size, order);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.embeddedWallets.getEmbeddedWalletDevicesPaginated(embeddedWalletsApiGetEmbeddedWalletDevicesPaginatedRequest);"
+ - lang: Java
+ source: "CompletableFuture>\
+ \ response = fireblocks.embeddedWallets().getEmbeddedWalletDevicesPaginated(walletId,\
+ \ sort, pageCursor, pageSize, order);"
+ - lang: Python
+ source: "response = fireblocks.embedded_wallets.get_embedded_wallet_devices_paginated(wallet_id,\
+ \ sort, page_cursor, page_size, order);"
+ x-accepts:
+ - application/json
+ /ncw/wallets/{walletId}/setup_status:
+ get:
+ description: "Get the key setup state for a specific Non Custodial Wallet, including\
+ \ required algorithms and device setup status"
+ operationId: getEmbeddedWalletSetupStatus
+ parameters:
+ - description: Wallet Id
+ example: 550e8400-e29b-41d4-a716-446655440000
+ explode: false
+ in: path
+ name: walletId
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/EmbeddedWalletSetupStatusResponse"
+ description: Successful response
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get wallet key setup state
+ tags:
+ - Embedded Wallets
+ x-rate-limit-category: read
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.embeddedWallets.getEmbeddedWalletSetupStatus(embeddedWalletsApiGetEmbeddedWalletSetupStatusRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: CompletableFuture>
+ response = fireblocks.embeddedWallets().getEmbeddedWalletSetupStatus(walletId);
+ name: Fireblocks SDK Java example
+ - language: python
+ code: response = fireblocks.embedded_wallets.get_embedded_wallet_setup_status(wallet_id);
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.embeddedWallets.getEmbeddedWalletSetupStatus(embeddedWalletsApiGetEmbeddedWalletSetupStatusRequest);"
+ - lang: Java
+ source: CompletableFuture>
+ response = fireblocks.embeddedWallets().getEmbeddedWalletSetupStatus(walletId);
+ - lang: Python
+ source: response = fireblocks.embedded_wallets.get_embedded_wallet_setup_status(wallet_id);
+ x-accepts:
+ - application/json
/ncw/wallets/{walletId}/public_key_info:
get:
description: Gets the public key information based on derivation path and signing
@@ -4060,11 +4556,12 @@ paths:
/workspace/freeze:
post:
description: "Freezes a Workspace so that ALL operations by ANY user are blocked.\n\
- \nYou should only perform this action when the workspace faces imminent risk,\
- \ such as when you have a security breach.\n\nTo unfreeze a workspace, the\
- \ workspace Owner must submit a request to Fireblocks Support.\n\n**NOTE:**\
- \ \n- This operation can only be performed by the workspace Owner\n- Your\
- \ workspace continues to receive incoming transfers during this time.\n"
+ You should only perform this action when the workspace faces imminent risk,\
+ \ such as when you have a security breach.\nTo unfreeze a workspace, the workspace\
+ \ Owner must submit a request to Fireblocks Support.\n**NOTE:** \n- This operation\
+ \ can only be performed by the workspace Admins - Your workspace continues\
+ \ to receive incoming transfers during this time.\nEndpoint Permission:\
+ \ Admin, Non-Signing Admin."
operationId: freezeWorkspace
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -4080,13 +4577,13 @@ paths:
style: simple
responses:
"204":
- description: indicates that the workspace is now frozen
+ description: Indicates that the workspace is now frozen
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Freeze Workspace
+ summary: Freeze
tags:
- Workspace
x-internal: true
@@ -4096,7 +4593,9 @@ paths:
/exchange_accounts:
get:
deprecated: true
- description: Deprecated (use new 'paged' endpoint) - Returns all exchange accounts.
+ description: |-
+ DEPRECATED - Please use the `/exchange_accounts/paged` endpoint.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getExchangeAccounts
responses:
"200":
@@ -4126,7 +4625,11 @@ paths:
x-accepts:
- application/json
post:
- description: Add an exchange account to exchanges.
+ description: "Add an exchange account to exchanges. \n\nNote: This endpoint\
+ \ currently only supports the following exchanges `INDEPENDENT_RESERVE`,`BIT`,\
+ \ `BITHUMB`, `BITSO`, `CRYPTOCOM`, `BYBIT_V2`, `WHITEBIT`, `HITBTC`, `GEMINI`,\
+ \ `HUOBI`, `GATEIO`, `COINHAKO`, `BULLISH`, `BITGET`, and `LUNO`\n\nTo add\
+ \ an exchange account, please use the following [guide](https://developers.fireblocks.com/docs/add-an-exchange-account).\n"
operationId: addExchangeAccount
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -4193,7 +4696,8 @@ paths:
- application/json
/exchange_accounts/paged:
get:
- description: Returns a page include exchange accounts.
+ description: "Returns a list of the connected exchange accounts in your workspace.\
+ \ Endpoint Permission: Admin, Non-Signing Admin."
operationId: getPagedExchangeAccounts
parameters:
- explode: true
@@ -4233,7 +4737,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Pagination list exchange accounts
+ summary: List connected exchange accounts
tags:
- Exchange accounts
x-rate-limit-category: query
@@ -4273,7 +4777,9 @@ paths:
- application/json
/exchange_accounts/{exchangeAccountId}:
get:
- description: Returns an exchange account by ID.
+ description: |-
+ Returns an exchange account by ID.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getExchangeAccount
parameters:
- description: The ID of the exchange account to return
@@ -4296,7 +4802,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Find a specific exchange account
+ summary: Get a specific exchange account
tags:
- Exchange accounts
x-rate-limit-category: external_query
@@ -4328,8 +4834,10 @@ paths:
- application/json
/exchange_accounts/{exchangeAccountId}/internal_transfer:
post:
- description: Transfers funds between trading accounts under the same exchange
- account.
+ description: |-
+ Transfers funds between trading accounts under the same exchange account.
+ Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers).
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: internalTransfer
parameters:
- description: The ID of the exchange account to return
@@ -4403,9 +4911,10 @@ paths:
- application/json
/exchange_accounts/{exchangeAccountId}/convert:
post:
- description: "Convert exchange account funds from the source asset to the destination\
- \ asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported\
- \ conversions."
+ description: |-
+ Convert exchange account funds from the source asset to the destination asset. Coinbase (USD to USDC, USDC to USD) and Bitso (MXN to USD) are supported conversions.
+ Learn more about Fireblocks Exchange Connectivity in the following [guide](https://developers.fireblocks.com/docs/connect-to-exchanges-and-fiat-providers).
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: convertAssets
parameters:
- description: "The ID of the exchange account. Please make sure the exchange\
@@ -4445,8 +4954,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Convert exchange account funds from the source asset to the destination
- asset.
+ summary: Convert exchange account funds
tags:
- Exchange accounts
x-rate-limit-category: write
@@ -4481,7 +4989,9 @@ paths:
- application/json
/exchange_accounts/{exchangeAccountId}/{assetId}:
get:
- description: Returns an asset for an exchange account.
+ description: |-
+ Returns an asset for an exchange account.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getExchangeAccountAsset
parameters:
- description: The ID of the exchange account to return
@@ -4512,7 +5022,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Find an asset for an exchange account
+ summary: Get an asset for an exchange account
tags:
- Exchange accounts
x-rate-limit-category: external_query
@@ -4594,7 +5104,9 @@ paths:
- application/json
/fiat_accounts:
get:
- description: Returns all fiat accounts.
+ description: |-
+ Returns all fiat accounts.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getFiatAccounts
responses:
"200":
@@ -4642,7 +5154,9 @@ paths:
- application/json
/fiat_accounts/{accountId}:
get:
- description: Returns a fiat account by ID.
+ description: |-
+ Returns a fiat account by ID.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getFiatAccount
parameters:
- description: The ID of the fiat account to return
@@ -4859,9 +5373,9 @@ paths:
/connected_accounts:
get:
description: |
- Returns all connected accounts
- **Note**:
- - This endpoint is currently in beta and might be subject to changes.
+ Returns all connected accounts.
+
+ **Note:** This endpoint is currently in beta and might be subject to changes.
operationId: getConnectedAccounts
parameters:
- description: Whether to include only main accounts in the response.
@@ -4936,11 +5450,59 @@ paths:
x-accepts:
- application/json
/connected_accounts/{accountId}:
- get:
+ delete:
description: |
- Retrieve detailed information about a specific connected account by ID.
+ Disconnect a connected account by ID.
**Note**:
- This endpoint is currently in beta and might be subject to changes.
+ operationId: disconnectConnectedAccount
+ parameters:
+ - description: The ID of the account to disconnect.
+ explode: false
+ in: path
+ name: accountId
+ required: true
+ schema:
+ minLength: 1
+ type: string
+ style: simple
+ responses:
+ "204":
+ description: Account disconnected successfully
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Disconnect connected account
+ tags:
+ - Connected Accounts (Beta)
+ x-rate-limit-category: write
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise> = fireblocks.connectedAccountsBeta.disconnectConnectedAccount(connectedAccountsBetaApiDisconnectConnectedAccountRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: CompletableFuture> response = fireblocks.connectedAccountsBeta().disconnectConnectedAccount(accountId);
+ name: Fireblocks SDK Java example
+ - language: python
+ code: response = fireblocks.connected_accounts_beta.disconnect_connected_account(account_id);
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise> = fireblocks.connectedAccountsBeta.disconnectConnectedAccount(connectedAccountsBetaApiDisconnectConnectedAccountRequest);"
+ - lang: Java
+ source: CompletableFuture> response = fireblocks.connectedAccountsBeta().disconnectConnectedAccount(accountId);
+ - lang: Python
+ source: response = fireblocks.connected_accounts_beta.disconnect_connected_account(account_id);
+ x-accepts:
+ - application/json
+ get:
+ description: |
+ Retrieve detailed information about a specific connected account by ID.
+
+ **Note:** This endpoint is currently in beta and might be subject to changes.
operationId: getConnectedAccount
parameters:
- description: The ID of the account to fetch.
@@ -4992,13 +5554,122 @@ paths:
source: response = fireblocks.connected_accounts_beta.get_connected_account(account_id);
x-accepts:
- application/json
+ /connected_accounts/{accountId}/rename:
+ post:
+ description: |
+ Rename a connected account by account ID.
+
+ **Note:** This endpoint is currently in beta and might be subject to changes.
+ operationId: renameConnectedAccount
+ parameters:
+ - description: The unique identifier of the connected account
+ explode: false
+ in: path
+ name: accountId
+ required: true
+ schema:
+ minLength: 1
+ type: string
+ style: simple
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
+ required: false
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RenameConnectedAccountRequest"
+ required: true
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RenameConnectedAccountResponse"
+ description: Successfully renamed connected account.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ConnectedAccountErrorResponse"
+ description: "Bad request. Missing tenantId, accountId, or accountName."
+ "401":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ConnectedAccountErrorResponse"
+ description: Unauthorized. Missing / invalid JWT token in Authorization
+ header.
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ConnectedAccountErrorResponse"
+ description: Failed to rename connected account.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ConnectedAccountErrorResponse"
+ description: Connected account not found
+ "409":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ConnectedAccountErrorResponse"
+ description: Conflict. Account name is already in use by another account.
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Rename Connected Account
+ tags:
+ - Connected Accounts (Beta)
+ x-rate-limit-category: write
+ x-readme:
+ code-samples:
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.connectedAccountsBeta.renameConnectedAccount(connectedAccountsBetaApiRenameConnectedAccountRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture> response\
+ \ = fireblocks.connectedAccountsBeta().renameConnectedAccount(renameConnectedAccountRequest,\
+ \ accountId, idempotencyKey);"
+ name: Fireblocks SDK Java example
+ - language: python
+ code: "response = fireblocks.connected_accounts_beta.rename_connected_account(rename_connected_account_request,\
+ \ account_id, idempotency_key);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.connectedAccountsBeta.renameConnectedAccount(connectedAccountsBetaApiRenameConnectedAccountRequest);"
+ - lang: Java
+ source: "CompletableFuture> response\
+ \ = fireblocks.connectedAccountsBeta().renameConnectedAccount(renameConnectedAccountRequest,\
+ \ accountId, idempotencyKey);"
+ - lang: Python
+ source: "response = fireblocks.connected_accounts_beta.rename_connected_account(rename_connected_account_request,\
+ \ account_id, idempotency_key);"
+ x-content-type: application/json
+ x-accepts:
+ - application/json
/connected_accounts/{accountId}/balances:
get:
description: |
- Retrieve current asset balances for a specific connected account as a flat list (one row per assetId, balanceType)
-
- **Note**:
- - This endpoint is currently in beta and might be subject to changes.
+ Retrieve current asset balances for a specific connected account as a flat list (one row per `assetId`, `balanceType`).
+
+ **Note:** This endpoint is currently in beta and might be subject to changes.
operationId: getConnectedAccountBalances
parameters:
- description: The ID of the account to fetch balances for.
@@ -5074,8 +5745,10 @@ paths:
- application/json
/connected_accounts/{accountId}/rates:
get:
- description: Retrieve current exchange rates for converting between specific
- assets in a connected account.
+ description: |
+ Retrieve current exchange rates for converting between specific assets in a connected account.
+
+ **Note:** This endpoint is currently in beta and might be subject to changes.
operationId: getConnectedAccountRates
parameters:
- description: The ID of the account to fetch rates for.
@@ -5151,8 +5824,10 @@ paths:
- application/json
/connected_accounts/{accountId}/manifest/capabilities/trading/pairs:
get:
- description: "Retrieve all asset trading pairs supported by a specific connected\
- \ account, including the pair type (quote, market, onOffRamp)."
+ description: |
+ Retrieve all asset trading pairs supported by a specific connected account, including the pair type (`quote`, `market`, `onOffRamp`).
+
+ **Note:** This endpoint is currently in beta and might be subject to changes.
operationId: getConnectedAccountTradingPairs
parameters:
- description: The ID of the account to fetch supported pairs for.
@@ -5229,8 +5904,9 @@ paths:
- application/json
/network_connections:
get:
- description: |
+ description: |-
Returns all network connections.
+
**Note:** This API call is subject to Flexible Routing Schemes.
Your routing policy defines how your transactions are routed.
@@ -5244,8 +5920,6 @@ paths:
- Network Profile FIAT → **None**
- Network Connection Crypto → **Default**
- Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
operationId: getNetworkConnections
responses:
"200":
@@ -5343,7 +6017,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Creates a new network connection
+ summary: Create a new network connection
tags:
- Network connections
x-rate-limit-category: write
@@ -5378,26 +6052,7 @@ paths:
- application/json
/network_connections/{connectionId}/set_routing_policy:
patch:
- description: |
- Updates an existing network connection's routing policy.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- Supported asset groups for routing police can be found at `/network_ids/routing_policy_asset_groups`
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Updates an existing network connection's routing policy.
operationId: setRoutingPolicy
parameters:
- description: The ID of the network connection
@@ -5492,7 +6147,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Retrieve third-party network routing validation by asset type.
+ summary: Retrieve third-party network routing validation
tags:
- Network connections
x-rate-limit-category: query
@@ -5524,24 +6179,8 @@ paths:
- application/json
/network_connections/{connectionId}:
delete:
- description: |
- Deletes an existing network connection specified by its connection ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Deletes an existing network connection specified by its connection
+ ID.
operationId: deleteNetworkConnection
parameters:
- description: The ID of the network connection to delete
@@ -5593,24 +6232,7 @@ paths:
x-accepts:
- application/json
get:
- description: |
- Gets a network connection by ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Gets a network connection by ID.
operationId: getNetwork
parameters:
- description: The ID of the connection
@@ -5670,24 +6292,7 @@ paths:
/network_ids:
get:
deprecated: true
- description: |
- Retrieves a list of all local and discoverable remote network IDs.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Retrieves a list of all local and discoverable remote network IDs.
operationId: getNetworkIds
responses:
"200":
@@ -5701,7 +6306,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: "Returns all network IDs, both local IDs and discoverable remote IDs"
+ summary: Get all network IDs
tags:
- Network connections
x-rate-limit-category: query
@@ -5728,26 +6333,7 @@ paths:
x-accepts:
- application/json
post:
- description: |
- Creates a new Network ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- Supported asset groups for routing police can be found at `/network_ids/routing_policy_asset_groups`
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Creates a new Network ID.
operationId: createNetworkId
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -5811,10 +6397,7 @@ paths:
- application/json
/network_ids/routing_policy_asset_groups:
get:
- description: |
- Retrieves a list of all enabled routing policy asset groups.
- Your routing policy defines how your transactions are routed.
- You can use one or more enabled routing policy asset groups to describe connection or network id routing policy.
+ description: Returns all enabled routing policy asset groups
operationId: getRoutingPolicyAssetGroups
responses:
"200":
@@ -5858,22 +6441,6 @@ paths:
get:
description: |
Retrieves a list of all local and discoverable remote network IDs. Can be filtered.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
operationId: searchNetworkIds
parameters:
- description: Search string - displayName networkId. Optional
@@ -5940,7 +6507,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: "Search network IDs, both local IDs and discoverable remote IDs"
+ summary: Get both local IDs and discoverable remote IDs
tags:
- Network connections
x-rate-limit-category: query
@@ -5974,24 +6541,7 @@ paths:
- application/json
/network_ids/{networkId}:
delete:
- description: |
- Deletes a network by its ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Deletes a network by its ID.
operationId: deleteNetworkId
parameters:
- description: The ID of the network
@@ -6040,24 +6590,7 @@ paths:
x-accepts:
- application/json
get:
- description: |
- Retrieves a network by its ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Returns specific network ID.
operationId: getNetworkId
parameters:
- description: The ID of the network
@@ -6108,26 +6641,7 @@ paths:
- application/json
/network_ids/{networkId}/set_routing_policy:
patch:
- description: |
- Updates the routing policy of a specified network ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- Supported asset groups for routing police can be found at `/network_ids/routing_policy_asset_groups`
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Updates the routing policy of a specified network ID.
operationId: setNetworkIdRoutingPolicy
parameters:
- description: The ID of the network
@@ -6188,24 +6702,7 @@ paths:
- application/json
/network_ids/{networkId}/set_discoverability:
patch:
- description: |
- Update whether or not the network ID is discoverable by others.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Update whether or not the network ID is discoverable by others.
operationId: setNetworkIdDiscoverability
parameters:
- description: The ID of the network
@@ -6267,24 +6764,7 @@ paths:
- application/json
/network_ids/{networkId}/set_name:
patch:
- description: |
- Updates name of a specified network ID.
-
- **Note:** This API call is subject to Flexible Routing Schemes.
-
- Your routing policy defines how your transactions are routed.
- You can choose 1 of the 3 different schemes mentioned below for each asset type:
- - **None**; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to `None` will fail.
- - **Custom**; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
- - **Default**; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing"
-
- Default Workspace Presets:
- - Network Profile Crypto → **Custom**
- - Network Profile FIAT → **None**
- - Network Connection Crypto → **Default**
- - Network Connection FIAT → **Default**
-
- - **Note**: By default, Custom routing scheme uses (`dstId` = `0`, `dstType` = `VAULT`).
+ description: Updates name of a specified network ID.
operationId: setNetworkIdName
parameters:
- description: The ID of the network
@@ -6346,24 +6826,8 @@ paths:
- application/json
/internal_wallets:
get:
- description: |-
+ description: |
Gets a list of internal wallets.
-
- **Note**:
- - BTC-based assets belonging to whitelisted addresses cannot be
- retrieved between 00:00 UTC and 00:01 UTC daily due to third-party
- provider, Blockchain, being unavailable for this 60 second period.
- Please wait until the next minute to retrieve BTC-based assets.
- - The list of assets returned will NOT include the balances anymore.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getInternalWallets
responses:
"200":
@@ -6406,10 +6870,7 @@ paths:
post:
description: |-
Creates a new internal wallet with the requested name.
-
Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: createInternalWallet
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -6478,14 +6939,7 @@ paths:
- application/json
/internal_wallets/{walletId}:
delete:
- description: |-
- Deletes an internal wallet by ID.
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ description: Deletes an internal wallet by ID.
operationId: deleteInternalWallet
parameters:
- description: The ID of the wallet to delete
@@ -6535,17 +6989,7 @@ paths:
x-accepts:
- application/json
get:
- description: |-
- Returns information for an asset in an internal wallet.
-
- This endpoint will be deprecated after 6 months. As part of the depreciation process this endpoint will no longer return balances, only addresses. Until it is deprecated, this endpoint will behave the same way.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
+ description: Returns information for an internal wallet.
operationId: getInternalWallet
parameters:
- description: The ID of the wallet to return
@@ -6568,7 +7012,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get an asset from an internal wallet
+ summary: Get assets for internal wallet
tags:
- Internal wallets
x-rate-limit-category: external_query
@@ -6600,19 +7044,7 @@ paths:
- application/json
/internal_wallets/{walletId}/assets:
get:
- description: |-
- Returns a paginated response of assets in an internal wallet.
-
- This is a new paginated endpoint that gets all the assets from the wallet container with balances. This endpoint returns a limited amount of results with a quick response time.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
+ description: Returns a paginated response of assets in an internal wallet.
operationId: getInternalWalletAssetsPaginated
parameters:
- description: The ID of the internal wallet to return assets for
@@ -6697,17 +7129,8 @@ paths:
- application/json
/internal_wallets/{walletId}/set_customer_ref_id:
post:
- description: |-
- Sets an AML/KYT customer reference ID for the specific internal wallet.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ description: Sets an AML/KYT customer reference ID for the specific internal
+ wallet.
operationId: setCustomerRefIdForInternalWallet
parameters:
- description: The wallet ID
@@ -6743,7 +7166,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Set an AML/KYT customer reference ID for an internal wallet
+ summary: Set an AML/KYT customer reference ID for internal wallet
tags:
- Internal wallets
x-rate-limit-category: write
@@ -6782,17 +7205,7 @@ paths:
- application/json
/internal_wallets/{walletId}/{assetId}:
delete:
- description: |-
- Deletes a whitelisted address (for an asset) from an internal wallet.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ description: Deletes a whitelisted address (for an asset) from an internal wallet.
operationId: deleteInternalWalletAsset
parameters:
- description: The ID of the wallet
@@ -6856,17 +7269,7 @@ paths:
x-accepts:
- application/json
get:
- description: |-
- Returns information for an asset in an internal wallet.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Learn more about Whitelisted Internal Addresses [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
+ description: Returns information for an asset in an internal wallet.
operationId: getInternalWalletAsset
parameters:
- description: The ID of the wallet
@@ -6935,18 +7338,7 @@ paths:
x-accepts:
- application/json
post:
- description: |-
- Adds an asset to an existing internal wallet.
-
- Internal Wallets are whitelisted wallets that belong to you outside of Fireblocks.
-
- - You can see the balance of the Internal Wallet via Fireblocks
- - You cannot initiate transactions from Internal Wallets through Fireblocks
-
- Learn more about Whitelisted Internal Addresses
- [here](https://developers.fireblocks.com/docs/whitelist-addresses#internal-wallets)
-
- Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ description: Adds an asset to an existing internal wallet.
operationId: createInternalWalletAsset
parameters:
- description: The ID of the wallet
@@ -7033,11 +7425,7 @@ paths:
- application/json
/key_link/signing_keys:
get:
- description: "Returns the list of signing keys in the workspace\nPlease note\
- \ that this endpoint is available only for Key Link enabled workspaces.\n\
- **Note:** \nThis endpoint is currently in beta and might be subject to changes.\n\
- If you want to participate and learn more about the Fireblocks Key Link, please\
- \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com."
+ description: Returns the list of signing keys in the workspace
operationId: getSigningKeysList
parameters:
- description: Cursor to the next page
@@ -7202,11 +7590,7 @@ paths:
description: "Adds a new signing key to the workspace. The added key will be\
\ linked to the specific Fireblocks agent user ID. The same user will receive\
\ the proof of ownership message to be signed, and upon successful proof,\
- \ the key will become enabled.\nPlease note that this endpoint is available\
- \ only for Key Link enabled workspaces.\n**Note:** \nThis endpoint is currently\
- \ in beta and might be subject to changes.\nIf you want to participate and\
- \ learn more about the Fireblocks Key Link, please contact your Fireblocks\
- \ Customer Success Manager or send an email to CSM@fireblocks.com."
+ \ the key will become enabled."
operationId: createSigningKey
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -7270,11 +7654,7 @@ paths:
/key_link/signing_keys/{keyId}:
get:
description: "Returns a signing key if it exists, identified by the specified\
- \ Fireblocks provided `keyId`.\nPlease note that this endpoint is available\
- \ only for Key Link enabled workspaces.\n**Note:** \nThis endpoint is currently\
- \ in beta and might be subject to changes.\nIf you want to participate and\
- \ learn more about the Fireblocks Key Link, please contact your Fireblocks\
- \ Customer Success Manager or send an email to CSM@fireblocks.com."
+ \ `keyId`."
operationId: getSigningKey
parameters:
- description: The unique identifier for the signing key provided by Fireblocks
@@ -7324,11 +7704,7 @@ paths:
- application/json
patch:
description: "Allows assigning the signing key to a vault account, if it hasn't\
- \ been assigned to any other vault accounts yet.\nPlease note that this endpoint\
- \ is available only for Key Link enabled workspaces.\n**Note:** \nThis endpoint\
- \ is currently in beta and might be subject to changes.\nIf you want to participate\
- \ and learn more about the Fireblocks Key Link, please contact your Fireblocks\
- \ Customer Success Manager or send an email to CSM@fireblocks.com."
+ \ been assigned to any other vault accounts yet."
operationId: updateSigningKey
parameters:
- description: The unique identifier for the signing key provided by Fireblocks
@@ -7358,7 +7734,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Modify the signing by Fireblocks provided `keyId`
+ summary: Modify the signing keyId
tags:
- Key Link (Beta)
x-rate-limit-category: write
@@ -7389,13 +7765,9 @@ paths:
- application/json
/key_link/signing_keys/{keyId}/agent_user_id:
patch:
- description: "Can modify existing signing key id if the key is not enabled.\
- \ The change done in background and will be visible once applied. If key is\
- \ already enabled (after proof of ownership) the user cannot be changed.\n\
- Please note that this endpoint is available only for Key Link enabled workspaces.\n\
- **Note:** \nThis endpoint is currently in beta and might be subject to changes.\n\
- If you want to participate and learn more about the Fireblocks Key Link, please\
- \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com."
+ description: Can modify existing signing key id if the key is not enabled. The
+ change done in background and will be visible once applied. If key is already
+ enabled (after proof of ownership) the user cannot be changed.
operationId: setAgentId
parameters:
- description: The unique identifier for the signing key provided by Fireblocks
@@ -7421,8 +7793,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Set agent user id that can sign with the signing key identified by
- the Fireblocks provided `keyId`
+ summary: Set agent user id
tags:
- Key Link (Beta)
x-rate-limit-category: write
@@ -7453,11 +7824,7 @@ paths:
- application/json
/key_link/validation_keys:
get:
- description: "Returns the list of validation keys in the workspace\nPlease note\
- \ that this endpoint is available only for Key Link enabled workspaces.\n\
- **Note:** \nThis endpoint is currently in beta and might be subject to changes.\n\
- If you want to participate and learn more about the Fireblocks Key Link, please\
- \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com."
+ description: Returns the list of validation keys in the workspace
operationId: getValidationKeysList
parameters:
- description: Cursor to the next page
@@ -7549,12 +7916,8 @@ paths:
x-accepts:
- application/json
post:
- description: "Adds a new validation key used to validate signing keys. The new\
- \ validation key will undergo an approval process by the workspace quorum.\n\
- Please note that this endpoint is available only for Key Link enabled workspaces.\n\
- **Note:** \nThis endpoint is currently in beta and might be subject to changes.\n\
- If you want to participate and learn more about the Fireblocks Key Link, please\
- \ contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com."
+ description: Adds a new validation key used to validate signing keys. The new
+ validation key will undergo an approval process by the workspace quorum.
operationId: createValidationKey
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -7622,11 +7985,7 @@ paths:
/key_link/validation_keys/{keyId}:
get:
description: "Returns a validation key if it exists, identified by the specified\
- \ `keyId`.\nPlease note that this endpoint is available only for Key Link\
- \ enabled workspaces.\n**Note:** \nThis endpoint is currently in beta and\
- \ might be subject to changes.\nIf you want to participate and learn more\
- \ about the Fireblocks Key Link, please contact your Fireblocks Customer Success\
- \ Manager or send an email to CSM@fireblocks.com."
+ \ `keyId`."
operationId: getValidationKey
parameters:
- explode: false
@@ -7673,13 +8032,9 @@ paths:
x-accepts:
- application/json
patch:
- description: "Allows disabling validation key even if it has not expired yet.\
- \ It is not allowed to enable the validation key back. Another key has to\
- \ be used for future validations.\nPlease note that this endpoint is available\
- \ only for Key Link enabled workspaces.\n**Note:** \nThis endpoint is currently\
- \ in beta and might be subject to changes.\nIf you want to participate and\
- \ learn more about the Fireblocks Key Link, please contact your Fireblocks\
- \ Customer Success Manager or send an email to CSM@fireblocks.com."
+ description: Allows disabling validation key even if it has not expired yet.
+ It is not allowed to enable the validation key back. Another key has to be
+ used for future validations.
operationId: disableValidationKey
parameters:
- description: The unique identifier for the validation key provided by Fireblocks
@@ -7840,7 +8195,14 @@ paths:
- application/json
/external_wallets:
get:
- description: Gets a list of external wallets under the workspace.
+ description: |-
+ Gets a list of external wallets under the workspace.
+
+ External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties.
+
+ - You cannot see the balance of the external wallet.
+ - You cannot initiate transactions from an external wallet as the source via Fireblocks.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getExternalWallets
responses:
"200":
@@ -7887,7 +8249,14 @@ paths:
x-accepts:
- application/json
post:
- description: Creates a new external wallet with the requested name.
+ description: |-
+ Creates a new external wallet with the requested name.
+
+ External Wallet is a whitelisted address of a wallet that belongs to your users/counterparties.
+
+ - You cannot see the balance of the external wallet.
+ - You cannot initiate transactions from an external wallet as the source via Fireblocks.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: createExternalWallet
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -7956,7 +8325,9 @@ paths:
- application/json
/external_wallets/{walletId}:
delete:
- description: Deletes an external wallet by ID.
+ description: "Deletes an external wallet by ID. External Wallet is a whitelisted\
+ \ address of a wallet that belongs to your users/counterparties. Endpoint\
+ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: deleteExternalWallet
parameters:
- description: The ID of the wallet to delete
@@ -8006,7 +8377,9 @@ paths:
x-accepts:
- application/json
get:
- description: Returns an external wallet by ID.
+ description: "Returns an external wallet by ID. External Wallet is a whitelisted\
+ \ address of a wallet that belongs to your users/counterparties. Endpoint\
+ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer."
operationId: getExternalWallet
parameters:
- description: The ID of the wallet to return
@@ -8061,8 +8434,10 @@ paths:
- application/json
/external_wallets/{walletId}/set_customer_ref_id:
post:
- description: Sets an AML/KYT customer reference ID for the specific external
- wallet.
+ description: "Sets an AML/KYT customer reference ID for the specific external\
+ \ wallet. External Wallet is a whitelisted address of a wallet that belongs\
+ \ to your users/counterparties. Endpoint Permission: Admin, Non-Signing\
+ \ Admin, Signer, Approver, Editor."
operationId: setExternalWalletCustomerRefId
parameters:
- description: The wallet ID
@@ -8137,7 +8512,8 @@ paths:
- application/json
/external_wallets/{walletId}/{assetId}:
delete:
- description: Deletes an external wallet asset by ID.
+ description: "Deletes an external wallet asset by ID. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: removeAssetFromExternalWallet
parameters:
- description: The ID of the wallet
@@ -8201,7 +8577,10 @@ paths:
x-accepts:
- application/json
get:
- description: Returns an external wallet by wallet ID and asset ID.
+ description: "Returns an external wallet by wallet ID and asset ID. External\
+ \ Wallet is a whitelisted address of a wallet that belongs to your users/counterparties.\
+ \ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,\
+ \ Viewer."
operationId: getExternalWalletAsset
parameters:
- description: The ID of the wallet
@@ -8272,7 +8651,8 @@ paths:
x-accepts:
- application/json
post:
- description: Adds an asset to an existing external wallet.
+ description: "Adds an asset to an existing external wallet. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: addAssetToExternalWallet
parameters:
- description: The ID of the wallet
@@ -8361,7 +8741,8 @@ paths:
- application/json
/contracts:
get:
- description: Gets a list of contracts.
+ description: "Gets a list of whitelisted contracts. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer."
operationId: getContracts
responses:
"200":
@@ -8375,7 +8756,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: List contracts
+ summary: List Whitelisted Contracts
tags:
- Contracts
x-rate-limit-category: query
@@ -8402,7 +8783,8 @@ paths:
x-accepts:
- application/json
post:
- description: Creates a new contract.
+ description: "Adds a contract to the workspace whitelist. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: createContract
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -8433,7 +8815,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Create a contract
+ summary: Add a contract
tags:
- Contracts
x-rate-limit-category: write
@@ -8464,7 +8846,8 @@ paths:
- application/json
/contracts/{contractId}:
delete:
- description: Deletes a contract by ID.
+ description: "Deletes a contract by ID. Endpoint Permission: Admin, Non-Signing\
+ \ Admin, Signer, Approver, Editor."
operationId: deleteContract
parameters:
- description: The ID of the contract to delete
@@ -8508,7 +8891,8 @@ paths:
x-accepts:
- application/json
get:
- description: Returns a contract by ID.
+ description: "Returns a whitelisted contract by Fireblocks Contract ID. Endpoint\
+ \ Permission: Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: getContract
parameters:
- description: The ID of the contract to return
@@ -8531,7 +8915,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Find a specific contract
+ summary: Find a Specific Whitelisted Contract
tags:
- Contracts
x-rate-limit-category: read
@@ -8557,7 +8941,8 @@ paths:
- application/json
/contracts/{contractId}/{assetId}:
delete:
- description: Deletes a contract asset by ID.
+ description: "Deletes a whitelisted contract asset by ID. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: deleteContractAsset
parameters:
- description: The ID of the contract
@@ -8585,7 +8970,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Delete a contract asset
+ summary: Delete an asset from a whitelisted contract
tags:
- Contracts
x-rate-limit-category: write
@@ -8614,7 +8999,8 @@ paths:
x-accepts:
- application/json
get:
- description: Returns a contract asset by ID.
+ description: "Returns a whitelisted contract's asset by ID. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: getContractAsset
parameters:
- description: The ID of the contract
@@ -8646,7 +9032,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Find a contract asset
+ summary: Find a whitelisted contract's asset
tags:
- Contracts
x-rate-limit-category: read
@@ -8675,7 +9061,8 @@ paths:
x-accepts:
- application/json
post:
- description: Adds an asset to an existing contract.
+ description: "Adds an asset to a whitelisted contract. Endpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor."
operationId: addContractAsset
parameters:
- description: The ID of the contract
@@ -8723,7 +9110,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Add an asset to a contract
+ summary: Add an asset to a whitelisted contract
tags:
- Contracts
x-rate-limit-category: write
@@ -8757,12 +9144,11 @@ paths:
/supported_assets:
get:
description: |
- Legacy Endpoint – Retrieves all assets supported by Fireblocks in your workspace without extended information.
- **Note**:
+ **This legacy endpoint has not been deprecated but it should not be used in your operations. Instead, use the new [List assets](https://developers.fireblocks.com/reference/listassets) endpoint for better performance and to retrieve more detailed asset information.**
- - This endpoint will remain available for the foreseeable future and is not deprecated.
- - The `listAssets` endpoint provides more detailed asset information and improved performance.
- - We recommend transitioning to the `listAssets` endpoint for better results.
+ Retrieves all assets supported by Fireblocks in your workspace.
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: getSupportedAssets
responses:
"200":
@@ -8776,7 +9162,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: List all asset types supported by Fireblocks - legacy endpoint
+ summary: List assets (Legacy)
tags:
- Blockchains & assets
x-rate-limit-category: external_query
@@ -8813,10 +9199,9 @@ paths:
/assets:
get:
description: |
- Retrieves all assets supported by Fireblocks in your workspace, providing extended information and enhanced performance compared to the legacy `supported_assets` endpoint.
- **Note**:
+ Retrieves a paginated list of all assets supported by Fireblocks in your workspace
- - We will continue displaying and supporting the legacy ID (API ID). Since not all Fireblocks services fully support the new Assets UUID, please use only the legacy ID until further notice.
+ **Note:** We will continue to support and display the legacy ID (API ID). Since not all Fireblocks services fully support the new Assets UUID, please use only the legacy ID until further notice.
operationId: listAssets
parameters:
- description: Blockchain id of the assets
@@ -8971,6 +9356,7 @@ paths:
- NEAR
- Solana
- Sui
+ - TON
operationId: registerNewAsset
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -9361,7 +9747,7 @@ paths:
/blockchains:
get:
description: |
- Returns all blockchains supported by Fireblocks.
+ Returns all blockchains supported by Fireblocks.
operationId: listBlockchains
parameters:
- description: Blockchain protocol
@@ -9482,7 +9868,7 @@ paths:
/blockchains/{id}:
get:
description: |
- Returns an blockchain by ID or legacyID.
+ Returns a blockchain by ID or legacyID.
operationId: getBlockchain
parameters:
- description: The ID or legacyId of the blockchain
@@ -9519,7 +9905,7 @@ paths:
description: Error occurred while getting an blockchain
default:
$ref: "#/components/responses/Error"
- summary: Get an blockchain
+ summary: Get a Blockchain by ID
tags:
- Blockchains & assets
x-rate-limit-category: external_query
@@ -9553,7 +9939,10 @@ paths:
- application/json
/transactions:
get:
- description: Lists the transaction history for your workspace.
+ description: |
+ Get the transaction history for your workspace.
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getTransactions
parameters:
- description: Cursor returned in next-page header that can be used to fetch
@@ -9574,8 +9963,10 @@ paths:
schema:
type: string
style: form
- - description: Unix timestamp in milliseconds. Returns only transactions created
- before the specified date
+ - description: "Unix timestamp in milliseconds. Returns only transactions created\
+ \ before the specified date.\nProvides an explicit end time. If not provided,\
+ \ default value will be applied, and may change over time. \nThe current\
+ \ default value is the past 90 days.\n"
explode: true
in: query
name: before
@@ -9583,8 +9974,10 @@ paths:
schema:
type: string
style: form
- - description: Unix timestamp in milliseconds. Returns only transactions created
- after the specified date
+ - description: "Unix timestamp in milliseconds. Returns only transactions created\
+ \ after the specified date.\nProvides an explicit start time. If not provided,\
+ \ default value will be applied, and may change over time. \nThe current\
+ \ default value is the past 90 days.\n"
explode: true
in: query
name: after
@@ -9600,10 +9993,10 @@ paths:
schema:
type: string
style: form
- - description: |-
- The field to order the results by
+ - description: |
+ The field to order the results by.
- **Note**: Ordering by a field that is not createdAt may result with transactions that receive updates as you request the next or previous pages of results, resulting with missing those transactions.
+ **Note:** Ordering by a field that is not `createdAt` may result in transactions that receive updates as you request the next or previous pages of results, resulting in missing those transactions.
explode: true
in: query
name: orderBy
@@ -9741,7 +10134,7 @@ paths:
$ref: "#/components/headers/prev-page"
default:
$ref: "#/components/responses/Error"
- summary: List transaction history
+ summary: Get transaction history
tags:
- Transactions
x-rate-limit-category: query
@@ -9787,7 +10180,11 @@ paths:
x-accepts:
- application/json
post:
- description: Creates a new transaction.
+ description: "Creates a new transaction. This endpoint can be used for regular\
+ \ Transfers, Contract Calls, Raw & Typed message signing. - For Transfers,\
+ \ the required parameters are: `assetId`, `source`, `destination` and `amount`.\
+ \ - For Contract Calls, the required parameters are: `operation.CONTRACT_CALL`,\
+ \ `assetId` (Base Asset), `source`,"
operationId: createTransaction
parameters:
- description: Unique ID of the End-User wallet to the API request. Required
@@ -9872,8 +10269,13 @@ paths:
/transactions/estimate_fee:
post:
description: |-
- Estimates the transaction fee for a transaction request.
- * Note: Supports all Fireblocks assets except ZCash (ZEC).
+ Estimates the transaction fee for a specific transaction request.
+ This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet.
+
+
+ **Note**: Supports all Fireblocks assets except ZCash (ZEC).
+ Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee).
+ Endpoint Permission: Admin, Signer, Approver, Editor.
operationId: estimateTransactionFee
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -9947,7 +10349,9 @@ paths:
- application/json
/transactions/{txId}:
get:
- description: Returns a transaction by ID.
+ description: |-
+ Get a specific transaction data by Fireblocks Transaction ID
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getTransaction
parameters:
- description: The ID of the transaction to return
@@ -9973,7 +10377,7 @@ paths:
$ref: "#/components/responses/Error"
default:
$ref: "#/components/responses/Error"
- summary: Find a specific transaction by Fireblocks transaction ID
+ summary: Get a specific transaction by Fireblocks transaction ID
tags:
- Transactions
x-rate-limit-category: read
@@ -10007,7 +10411,9 @@ paths:
- application/json
/transactions/external_tx_id/{externalTxId}:
get:
- description: Returns transaction by external transaction ID.
+ description: |-
+ Returns transaction by external transaction ID.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getTransactionByExternalId
parameters:
- description: The external ID of the transaction to return
@@ -10031,7 +10437,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Find a specific transaction by external transaction ID
+ summary: Get a specific transaction by external transaction ID
tags:
- Transactions
x-rate-limit-category: read
@@ -10065,8 +10471,9 @@ paths:
- application/json
/transactions/{txId}/set_confirmation_threshold:
post:
- description: Overrides the required number of confirmations for transaction
- completion by transaction ID.
+ description: |-
+ Overrides the required number of confirmations for transaction completion Fireblocks Transaction ID.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: setTransactionConfirmationThreshold
parameters:
- description: The ID of the transaction
@@ -10105,7 +10512,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Set confirmation threshold by transaction ID
+ summary: Set confirmation threshold by Fireblocks Transaction ID
tags:
- Transactions
x-rate-limit-category: write
@@ -10146,7 +10553,9 @@ paths:
- application/json
/transactions/{txId}/drop:
post:
- description: Drops a stuck ETH transaction and creates a replacement transaction.
+ description: |-
+ Drops a stuck ETH (EVM) transaction and creates a replacement transaction with 0 amount.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: dropTransaction
parameters:
- description: The ID of the transaction
@@ -10195,7 +10604,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Drop ETH transaction by ID
+ summary: Drop ETH (EVM) transaction by ID
tags:
- Transactions
x-rate-limit-category: write
@@ -10236,7 +10645,11 @@ paths:
- application/json
/transactions/{txId}/cancel:
post:
- description: Cancels a transaction by ID.
+ description: |-
+ Cancels a transaction by Fireblocks Transaction ID.
+
+ Can be used only for transactions that did not get to the BROADCASTING state.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: cancelTransaction
parameters:
- description: The ID of the transaction to cancel
@@ -10320,7 +10733,11 @@ paths:
- application/json
/transactions/{txId}/freeze:
post:
- description: Freezes a transaction by ID.
+ description: "Freezes a transaction by ID.\n\nUsually used for AML integrations\
+ \ when the incoming funds should be quarantined.\nFor account based assets\
+ \ - the entire amount of the transaction is frozen \nFor UTXO based assets\
+ \ - all UTXOs of the specified transaction are frozen\nEndpoint Permission:\
+ \ Admin, Non-Signing Admin."
operationId: freezeTransaction
parameters:
- description: The ID of the transaction to freeze
@@ -10402,8 +10819,9 @@ paths:
- application/json
/transactions/{txId}/unfreeze:
post:
- description: Unfreezes a transaction by ID and makes the transaction available
- again.
+ description: |-
+ Unfreezes a transaction by Fireblocks Transaction ID and makes the transaction available again.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: unfreezeTransaction
parameters:
- description: The ID of the transaction to unfreeze
@@ -10485,7 +10903,9 @@ paths:
- application/json
/transactions/validate_address/{assetId}/{address}:
get:
- description: "Checks if an address is valid (for XRP, DOT, XLM, and EOS)."
+ description: |-
+ Checks if an address is valid and active (for XRP, DOT, XLM, and EOS).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: validateAddress
parameters:
- description: The asset of the address
@@ -10551,81 +10971,11 @@ paths:
source: "response = fireblocks.transactions.validate_address(asset_id, address);"
x-accepts:
- application/json
- /transactions/rescan:
- post:
- description: |
- rescan transaction by running an async job.
- **Note**:
- - These endpoints are currently in beta and might be subject to changes.
- - We limit the amount of the transaction to 16 per request.
- operationId: rescanTransactionsBeta
- parameters:
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
- explode: false
- in: header
- name: Idempotency-Key
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/RescanTransactionRequest"
- required: true
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ValidatedTransactionsForRescanResponse"
- description: A array of validated transactions that were sent to rescan
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
- default:
- $ref: "#/components/responses/Error"
- summary: rescan array of transactions
- tags:
- - Transactions
- x-rate-limit-category: async
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise>\
- \ = fireblocks.transactions.rescanTransactionsBeta(transactionsApiRescanTransactionsBetaRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: "CompletableFuture>>\
- \ response = fireblocks.transactions().rescanTransactionsBeta(rescanTransaction,\
- \ idempotencyKey);"
- name: Fireblocks SDK Java example
- - language: python
- code: "response = fireblocks.transactions.rescan_transactions_beta(rescan_transaction,\
- \ idempotency_key);"
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.transactions.rescanTransactionsBeta(transactionsApiRescanTransactionsBetaRequest);"
- - lang: Java
- source: "CompletableFuture>>\
- \ response = fireblocks.transactions().rescanTransactionsBeta(rescanTransaction,\
- \ idempotencyKey);"
- - lang: Python
- source: "response = fireblocks.transactions.rescan_transactions_beta(rescan_transaction,\
- \ idempotency_key);"
- x-content-type: application/json
- x-accepts:
- - application/json
/txHash/{txHash}/set_confirmation_threshold:
post:
- description: Overrides the required number of confirmations for transaction
- completion by transaction hash.
+ description: |-
+ Overrides the required number of confirmations for transaction completion by transaction hash.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: setConfirmationThresholdByTransactionHash
parameters:
- description: The TxHash
@@ -10705,9 +11055,20 @@ paths:
- application/json
/estimate_network_fee:
get:
- description: "Gets the estimated required fee for an asset. For UTXO based assets,\
- \ the response will contain the suggested fee per byte, for ETH/ETC based\
- \ assets, the suggested gas price, and for XRP/XLM, the transaction fee."
+ description: |-
+ Gets the estimated required fee for an asset.
+ Fireblocks fetches, calculates and caches the result every 30 seconds.
+ Customers should query this API while taking the caching interval into consideration.
+ Notes:
+ - The `networkFee` parameter is the `gasPrice` with a given delta added, multiplied by the gasLimit plus the delta. - The estimation provided depends on the asset type.
+ - For UTXO-based assets, the response contains the `feePerByte` parameter
+ - For ETH-based and all EVM based assets, the response will contain `gasPrice` parameter. This is calculated by adding the `baseFee` to the `actualPriority` based on the latest 12 blocks. The response for ETH-based contains the `baseFee`, `gasPrice`, and `priorityFee` parameters.
+ - For ADA-based assets, the response will contain the parameter `networkFee` and `feePerByte` parameters.
+ - For XRP and XLM, the response will contain the transaction fee.
+ - For other assets, the response will contain the `networkFee` parameter.
+
+ Learn more about Fireblocks Fee Management in the following [guide](https://developers.fireblocks.com/reference/estimate-transaction-fee).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: estimateNetworkFee
parameters:
- description: The asset for which to estimate the fee
@@ -10778,6 +11139,8 @@ paths:
the payment account and its account type (vault, exchange, or fiat).
the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account.
+ Learn more about Fireblocks Payments - Payouts in the following [guide](https://developers.fireblocks.com/docs/create-payouts).
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: createPayout
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -10998,6 +11361,7 @@ paths:
**Note:** The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.
These endpoints are currently in beta and might be subject to changes.
If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email CSM@fireblocks.com.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getPayout
parameters:
- description: the payout id received from the creation of the payout instruction
@@ -11382,7 +11746,9 @@ paths:
- application/json
/gas_station:
get:
- description: Returns gas station settings and ETH balance.
+ description: |-
+ Returns gas station settings and ETH balance.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: getGasStationInfo
responses:
"200":
@@ -11432,7 +11798,9 @@ paths:
- application/json
/gas_station/{assetId}:
get:
- description: Returns gas station settings and balances for a requested asset.
+ description: |-
+ Returns gas station settings and balances for a requested asset.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: getGasStationByAssetId
parameters:
- description: The ID of the asset
@@ -11492,7 +11860,10 @@ paths:
- application/json
/gas_station/configuration:
put:
- description: Configures gas station settings for ETH.
+ description: |-
+ Configures gas station settings for ETH.
+ Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: updateGasStationConfiguration
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -11567,7 +11938,10 @@ paths:
- application/json
/gas_station/configuration/{assetId}:
put:
- description: Configures gas station settings for a requested asset.
+ description: |-
+ Configures gas station settings for a requested asset.
+ Learn more about the Fireblocks Gas Station in the following [guide](https://developers.fireblocks.com/docs/work-with-gas-station).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: updateGasStationConfigurationByAssetId
parameters:
- description: The ID of the asset
@@ -11643,12 +12017,11 @@ paths:
- application/json
/management/user_groups:
get:
- description: |
- Get all user groups in your workspace.
+ description: |-
+ Get all user groups in your workspace
- **Note**:
- - This endpoint is now in Beta, disabled for general availability at this time.
- - Please note that this endpoint is available only for API keys with Admin permissions.
+ - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getUserGroups
responses:
"200":
@@ -11691,12 +12064,9 @@ paths:
x-accepts:
- application/json
post:
- description: |
- Create a new user group.
-
- **Note**:
- - This endpoint is now in Beta, disabled for general availability at this time.
- - Please note that this endpoint is available only for API keys with Admin permissions.
+ description: |-
+ Create a new user group. Users with the Viewer role cannot be added to groups.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: createUserGroup
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -11996,7 +12366,11 @@ paths:
- application/json
/management/audit_logs:
get:
- description: Get all audits
+ description: |-
+ Get Audit logs for the last Day/Week.
+
+ - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
+ Endpoint Permission: Admin, Non-Signing Admin.
operationId: getAuditLogs
parameters:
- description: The last time period to fetch audit logs
@@ -12060,7 +12434,10 @@ paths:
- application/json
/off_exchange/add:
post:
- description: "add collateral, create deposit request"
+ description: |-
+ Add collateral and create deposit request.
+ Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: addOffExchange
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -12088,7 +12465,7 @@ paths:
description: A transaction object
default:
$ref: "#/components/responses/Error"
- summary: add collateral
+ summary: Add Collateral
tags:
- Off exchanges
x-rate-limit-category: write
@@ -12122,7 +12499,10 @@ paths:
- application/json
/off_exchange/remove:
post:
- description: "remove collateral, create withdraw request"
+ description: |-
+ Remove collateral, create withdraw request.
+ Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: removeOffExchange
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -12150,7 +12530,7 @@ paths:
description: A transaction object
default:
$ref: "#/components/responses/Error"
- summary: remove collateral
+ summary: Remove Collateral
tags:
- Off exchanges
x-rate-limit-category: write
@@ -12185,7 +12565,10 @@ paths:
- application/json
/off_exchange/settlements/trader:
post:
- description: create settlement for a trader
+ description: |-
+ Create settlement for a trader.
+ Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: settleOffExchangeTrades
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -12213,7 +12596,7 @@ paths:
description: A settlement object
default:
$ref: "#/components/responses/Error"
- summary: create settlement for a trader
+ summary: Create Settlement for a Trader
tags:
- Off exchanges
x-rate-limit-category: write
@@ -12246,7 +12629,10 @@ paths:
- application/json
/off_exchange/settlements/transactions:
get:
- description: get settlements transactions from exchange
+ description: |-
+ Get settlements transactions from exchange.
+ Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: getOffExchangeSettlementTransactions
parameters:
- explode: true
@@ -12265,7 +12651,7 @@ paths:
description: A settlement transactions
default:
$ref: "#/components/responses/Error"
- summary: get settlements transactions from exchange
+ summary: Get Settlements Transactions
tags:
- Off exchanges
x-rate-limit-category: query
@@ -12293,7 +12679,10 @@ paths:
- application/json
/off_exchange/collateral_accounts/{mainExchangeAccountId}:
get:
- description: Returns a collateral account by mainExchangeAccountId.
+ description: |-
+ Returns a collateral account by mainExchangeAccountId.
+ Learn more about Fireblocks Off Exchange in the following [guide](https://developers.fireblocks.com/docs/off-exchange).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: getOffExchangeCollateralAccounts
parameters:
- description: The id of the main exchange account for which the requested collateral
@@ -12343,7 +12732,12 @@ paths:
- application/json
/webhooks/resend:
post:
- description: Resends all failed webhook notifications.
+ description: |-
+ Resends all failed webhook notifications.
+
+ Learn more about Fireblocks Webhooks in the following [guide](https://developers.fireblocks.com/docs/configure-webhooks).
+
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: resendWebhooks
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -12405,7 +12799,12 @@ paths:
- application/json
/webhooks/resend/{txId}:
post:
- description: Resends failed webhook notifications for a transaction by ID.
+ description: |
+ Resends webhook notifications for a transaction by its unique identifier.
+
+ Learn more about Fireblocks Webhooks in the following [guide](https://developers.fireblocks.com/docs/configure-webhooks).
+
+ **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor.
operationId: resendTransactionWebhooks
parameters:
- description: The ID of the transaction for webhooks
@@ -12445,7 +12844,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Resend failed webhooks for a transaction by ID
+ summary: Resend webhooks for a transaction by ID
tags:
- Webhooks
x-rate-limit-category: async
@@ -12489,7 +12888,7 @@ paths:
/webhooks:
get:
description: |
- Get all webhooks (paginated)
+ Get all webhooks (paginated).
operationId: getWebhooks
parameters:
- description: ASC / DESC ordering (default DESC)
@@ -12571,7 +12970,7 @@ paths:
description: |
Creates a new webhook, which will be triggered on the specified events
- Endpoint Permission: Owner, Admin, Non-Signing Admin.
+ **Endpoint Permissions:** Owner, Admin, Non-Signing Admin.
operationId: createWebhook
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -12603,7 +13002,7 @@ paths:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Create new webhook
+ summary: Create a new webhook
tags:
- Webhooks V2
x-rate-limit-category: write
@@ -13481,8 +13880,9 @@ paths:
- application/json
/tokenization/templates:
get:
- description: Return minimal representation of all the contract templates available
- for the workspace
+ description: |-
+ Return minimal representation of all the contract templates available for the workspace.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getContractTemplates
parameters:
- description: Items per page (max 100)
@@ -13541,7 +13941,9 @@ paths:
- TOKEN_UTILITY
type: string
style: form
- - explode: true
+ - description: For standalone contracts use ON_DEPLOYMENT and for contracts
+ that are behind proxies use POST_DEPLOYMENT
+ explode: true
in: query
name: initializationPhase
required: false
@@ -14004,6 +14406,69 @@ paths:
x-content-type: application/json
x-accepts:
- application/json
+ /tokenization/templates/{contractTemplateId}/supported_blockchains:
+ get:
+ description: Get supported blockchains for the template
+ operationId: getSupportedBlockchainsByTemplateId
+ parameters:
+ - description: The Contract Template identifier
+ example: b70701f4-d7b1-4795-a8ee-b09cdb5b850d
+ explode: false
+ in: path
+ name: contractTemplateId
+ required: true
+ schema:
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/SupportedBlockChainsResponse"
+ description: Supported blockchains list
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/HttpContractDoesNotExistError"
+ description: Could not find contract.
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get supported blockchains for the template
+ tags:
+ - Contract Templates
+ x-rate-limit-category: read
+ x-readme:
+ code-samples:
+ - language: python
+ code: supported_blockchains = fireblocks.get_supported_blockchains_by_template_id(contract_template_id)
+ name: Fireblocks SDK Python example (Legacy)
+ - language: javascript
+ code: const supportedBlockchains = await fireblocks.getSupportedBlockchainsByTemplateId(contractTemplateId);
+ name: Fireblocks SDK Javascript example
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.contractTemplates.getSupportedBlockchainsByTemplateId(contractTemplatesApiGetSupportedBlockchainsByTemplateIdRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: CompletableFuture> response
+ = fireblocks.contractTemplates().getSupportedBlockchainsByTemplateId(contractTemplateId);
+ name: Fireblocks SDK Java example
+ - language: python
+ code: response = fireblocks.contract_templates.get_supported_blockchains_by_template_id(contract_template_id);
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.contractTemplates.getSupportedBlockchainsByTemplateId(contractTemplatesApiGetSupportedBlockchainsByTemplateIdRequest);"
+ - lang: Java
+ source: CompletableFuture> response
+ = fireblocks.contractTemplates().getSupportedBlockchainsByTemplateId(contractTemplateId);
+ - lang: Python
+ source: response = fireblocks.contract_templates.get_supported_blockchains_by_template_id(contract_template_id);
+ x-accepts:
+ - application/json
/tokenization/contracts:
get:
description: Return a filtered lean representation of the deployed contracts
@@ -14437,12 +14902,9 @@ paths:
x-accepts:
- application/json
post:
- description: "Facilitates the creation of a new token, supporting both EVM-based\
- \ and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract\
- \ template to the blockchain and links the token to the workspace. For Stellar/Ripple,\
- \ it links a newly created token directly to the workspace without deploying\
- \ a contract. Returns the token link with status \"PENDING\" until the token\
- \ is deployed or \"SUCCESS\" if no deployment is needed."
+ description: |-
+ Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status "PENDING" until the token is deployed or "SUCCESS" if no deployment is needed.
+ Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.
operationId: issueNewToken
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -14510,6 +14972,51 @@ paths:
x-content-type: application/json
x-accepts:
- application/json
+ /tokenization/tokens/count:
+ get:
+ description: Get the total count of linked tokens
+ operationId: getLinkedTokensCount
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/LinkedTokensCount"
+ description: Count fetched successfully
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get the total count of linked tokens
+ tags:
+ - Tokenization
+ x-rate-limit-category: read
+ x-readme:
+ code-samples:
+ - language: python
+ code: tokens_count = fireblocks.get_linked_tokens_count()
+ name: Fireblocks SDK Python example (Legacy)
+ - language: javascript
+ code: const tokensCount = await fireblocks.getLinkedTokensCount();
+ name: Fireblocks SDK Javascript example
+ - language: typescript
+ code: "const response: Promise> =\
+ \ fireblocks.tokenization.getLinkedTokensCount();"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: CompletableFuture> response = fireblocks.tokenization().getLinkedTokensCount();
+ name: Fireblocks SDK Java example
+ - language: python
+ code: response = fireblocks.tokenization.get_linked_tokens_count();
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise> =\
+ \ fireblocks.tokenization.getLinkedTokensCount();"
+ - lang: Java
+ source: CompletableFuture> response = fireblocks.tokenization().getLinkedTokensCount();
+ - lang: Python
+ source: response = fireblocks.tokenization.get_linked_tokens_count();
+ x-accepts:
+ - application/json
/tokenization/tokens/link:
post:
description: Link an a contract
@@ -15626,7 +16133,9 @@ paths:
- application/json
/tokenization/collections:
get:
- description: Get collections (paginated)
+ description: |-
+ Get collections (paginated).
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
operationId: getLinkedCollections
parameters:
- description: "Page cursor to get the next page, for example - \"MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==\""
@@ -15700,7 +16209,9 @@ paths:
x-accepts:
- application/json
post:
- description: Create a new collection and link it as a token
+ description: |-
+ Create a new collection and link it as a token.
+ Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.
operationId: createNewCollection
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -16063,8 +16574,9 @@ paths:
- application/json
/contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions:
get:
- description: Return deployed contract's ABI by blockchain native asset id and
- contract address
+ description: |-
+ Return deployed contract's ABI by blockchain native asset id and contract address.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer.
operationId: getDeployedContractAbi
parameters:
- description: "A unique identifier for the request. If the request is sent\
@@ -16087,7 +16599,9 @@ paths:
schema:
type: string
style: simple
- - explode: false
+ - description: The blockchain base assetId
+ example: ETH
+ explode: false
in: path
name: baseAssetId
required: true
@@ -16325,8 +16839,10 @@ paths:
- application/json
/contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt:
get:
- description: Retrieve the transaction receipt by blockchain native asset ID
- and transaction hash
+ description: "Retrieve the transaction receipt by blockchain native asset ID\
+ \ and transaction hash\n> **Note** > This functionality is exclusively available\
+ \ for EVM (Ethereum Virtual Machine) compatible chains. \nEndpoint Permission:\
+ \ Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer."
operationId: getTransactionReceipt
parameters:
- description: The blockchain base assetId
@@ -16492,852 +17008,1150 @@ paths:
x-content-type: application/json
x-accepts:
- application/json
- /staking/chains:
+ /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}:
get:
- description: Return an alphabetical list of supported chains.
- operationId: getChains
+ description: Retrieve the contract address by blockchain native asset ID and
+ transaction hash
+ operationId: getContractAddress
+ parameters:
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
+ required: false
+ schema:
+ type: string
+ style: simple
+ - description: The blockchain base assetId
+ example: ETH_TEST3
+ explode: false
+ in: path
+ name: baseAssetId
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: The transaction hash
+ example: 0x3b015ca0518c55d7bff4e3f5aa5d0431705771553ba8a95cf20e34cb597f57f6
+ explode: false
+ in: path
+ name: txHash
+ required: true
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/StakingGetChainsResponse"
- description: An array of supported chains was returned successfully
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ $ref: "#/components/schemas/ContractAddressResponse"
+ description: Retrieved The Contract Address Successfully
default:
$ref: "#/components/responses/Error"
- summary: List staking supported chains
+ summary: Get contract address by transaction hash
tags:
- - Staking
- x-rate-limit-category: query
+ - Contract Interactions
+ x-rate-limit-category: read
x-readme:
code-samples:
+ - language: python
+ code: "contract_address = fireblocks.get_contract_address(base_asset_id,\
+ \ tx_hash)"
+ name: Fireblocks SDK Python example (Legacy)
+ - language: javascript
+ code: "const contractAddress = await fireblocks.getContractAddress(baseAssetId,\
+ \ txHash);"
+ name: Fireblocks SDK Javascript example
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.staking.getChains();"
+ code: "const response: Promise>\
+ \ = fireblocks.contractInteractions.getContractAddress(contractInteractionsApiGetContractAddressRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: CompletableFuture>> response = fireblocks.staking().getChains();
+ code: "CompletableFuture> response\
+ \ = fireblocks.contractInteractions().getContractAddress(baseAssetId,\
+ \ txHash, idempotencyKey);"
name: Fireblocks SDK Java example
- language: python
- code: response = fireblocks.staking.get_chains();
+ code: "response = fireblocks.contract_interactions.get_contract_address(base_asset_id,\
+ \ tx_hash, idempotency_key);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.staking.getChains();"
+ source: "const response: Promise>\
+ \ = fireblocks.contractInteractions.getContractAddress(contractInteractionsApiGetContractAddressRequest);"
- lang: Java
- source: CompletableFuture>> response = fireblocks.staking().getChains();
+ source: "CompletableFuture> response\
+ \ = fireblocks.contractInteractions().getContractAddress(baseAssetId, txHash,\
+ \ idempotencyKey);"
- lang: Python
- source: response = fireblocks.staking.get_chains();
+ source: "response = fireblocks.contract_interactions.get_contract_address(base_asset_id,\
+ \ tx_hash, idempotency_key);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/chainInfo:
+ /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/roles:
get:
- description: "Return chain-specific, staking-related information summary (e.g.\
- \ epoch details, lockup durations, estimated rewards, etc.)"
- operationId: getChainInfo
+ description: Returns a list of currently active roles for the specified baseAssetId
+ and contractAddress.
+ operationId: getActiveRolesForContract
parameters:
- - description: The protocol identifier (e.g. "ETH"/"SOL"/"MATIC"/"STETH_ETH")
- to use
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- $ref: "#/components/schemas/ChainDescriptor"
+ type: string
+ style: simple
+ - description: The contract address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
+ explode: false
+ in: path
+ name: contractAddress
+ required: true
+ schema:
+ type: string
style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/ChainInfoResponse"
- description: Chain specific info summary was returned successfully
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ $ref: "#/components/schemas/ActiveRolesResponse"
+ description: Successfully retrieved the list of active roles
default:
$ref: "#/components/responses/Error"
- summary: Get chain-specific staking summary
+ summary: List of active roles for a given contract address and base asset ID
tags:
- - Staking
- x-rate-limit-category: query
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> =\
- \ fireblocks.staking.getChainInfo(stakingApiGetChainInfoRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getActiveRolesForContract(onchainDataApiGetActiveRolesForContractRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: CompletableFuture> response = fireblocks.staking().getChainInfo(chainDescriptor);
+ code: "CompletableFuture> response = fireblocks.onchainData().getActiveRolesForContract(baseAssetId,\
+ \ contractAddress);"
name: Fireblocks SDK Java example
- language: python
- code: response = fireblocks.staking.get_chain_info(chain_descriptor);
+ code: "response = fireblocks.onchain_data.get_active_roles_for_contract(base_asset_id,\
+ \ contract_address);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> =\
- \ fireblocks.staking.getChainInfo(stakingApiGetChainInfoRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getActiveRolesForContract(onchainDataApiGetActiveRolesForContractRequest);"
- lang: Java
- source: CompletableFuture> response = fireblocks.staking().getChainInfo(chainDescriptor);
+ source: "CompletableFuture> response = fireblocks.onchainData().getActiveRolesForContract(baseAssetId,\
+ \ contractAddress);"
- lang: Python
- source: response = fireblocks.staking.get_chain_info(chain_descriptor);
+ source: "response = fireblocks.onchain_data.get_active_roles_for_contract(base_asset_id,\
+ \ contract_address);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/stake:
- post:
- description: Perform a chain-specific Stake.
- operationId: stake
+ /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/list:
+ get:
+ description: Returns the current state of addresses in the specified access
+ registry. Only addresses that are currently active (added but not removed)
+ are included.
+ operationId: getAccessRegistryCurrentState
parameters:
- - description: The protocol identifier (e.g. "ETH"/"SOL"/"MATIC") to use
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- $ref: "#/components/schemas/ChainDescriptor"
+ type: string
style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
+ - description: The access registry address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
explode: false
- in: header
- name: Idempotency-Key
- required: false
+ in: path
+ name: accessRegistryAddress
+ required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/StakeRequest"
- required: true
+ - description: Page cursor to get the next page"
+ example: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "Number of items per page (max 100), requesting more then 100\
+ \ will return 100 items"
+ example: 10
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ maximum: 100
+ minimum: 1
+ type: integer
+ style: form
+ - description: Sorting field (enum).
+ explode: true
+ in: query
+ name: sortBy
+ required: false
+ schema:
+ default: dateAdded
+ enum:
+ - dateAdded
+ - address
+ type: string
+ style: form
+ - description: ASC / DESC ordering (default DESC)
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: DESC
+ enum:
+ - ASC
+ - DESC
+ type: string
+ style: form
responses:
- "201":
+ "200":
content:
application/json:
schema:
- $ref: "#/components/schemas/StakeResponse"
- description: Stake action has been executed successfully on vault and is
- associated with 201 status code.
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ $ref: "#/components/schemas/AccessRegistryCurrentStateResponse"
+ description: Access registry current state retrieved successfully
default:
$ref: "#/components/responses/Error"
- summary: Initiate Stake Operation
+ summary: Get the current state of addresses in an access registry
tags:
- - Staking
- x-rate-limit-category: write
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.staking.stake(stakingApiStakeRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getAccessRegistryCurrentState(onchainDataApiGetAccessRegistryCurrentStateRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.staking().stake(stakeRequest,\
- \ chainDescriptor, idempotencyKey);"
+ code: "CompletableFuture>\
+ \ response = fireblocks.onchainData().getAccessRegistryCurrentState(baseAssetId,\
+ \ accessRegistryAddress, pageCursor, pageSize, sortBy, order);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.stake(stake_request, chain_descriptor,\
- \ idempotency_key);"
+ code: "response = fireblocks.onchain_data.get_access_registry_current_state(base_asset_id,\
+ \ access_registry_address, page_cursor, page_size, sort_by, order);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.stake(stakingApiStakeRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getAccessRegistryCurrentState(onchainDataApiGetAccessRegistryCurrentStateRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.staking().stake(stakeRequest,\
- \ chainDescriptor, idempotencyKey);"
+ source: "CompletableFuture>\
+ \ response = fireblocks.onchainData().getAccessRegistryCurrentState(baseAssetId,\
+ \ accessRegistryAddress, pageCursor, pageSize, sortBy, order);"
- lang: Python
- source: "response = fireblocks.staking.stake(stake_request, chain_descriptor,\
- \ idempotency_key);"
- x-content-type: application/json
+ source: "response = fireblocks.onchain_data.get_access_registry_current_state(base_asset_id,\
+ \ access_registry_address, page_cursor, page_size, sort_by, order);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/unstake:
- post:
- description: Execute an Unstake operation
- operationId: unstake
+ /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/summary:
+ get:
+ description: Returns a summary of the current state of the access registry for
+ the specified baseAssetId and accessRegistryAddress.
+ operationId: getAccessRegistrySummary
parameters:
- - description: The protocol identifier (e.g. "ETH"/"SOL"/"MATIC") to use
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- $ref: "#/components/schemas/ChainDescriptor"
+ type: string
style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
+ - description: The access registry address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
explode: false
- in: header
- name: Idempotency-Key
- required: false
+ in: path
+ name: accessRegistryAddress
+ required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/UnstakeRequest"
- required: true
responses:
- "201":
- description: Unstake action has been executed successfully on vault and
- is associated with 201 status code.
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/AccessRegistrySummaryResponse"
+ description: Successfully retrieved the summary of the access registry state
default:
$ref: "#/components/responses/Error"
- summary: Execute an Unstake operation
+ summary: Summary of access registry state
tags:
- - Staking
- x-rate-limit-category: write
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.staking.unstake(stakingApiUnstakeRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getAccessRegistrySummary(onchainDataApiGetAccessRegistrySummaryRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.staking().unstake(unstakeRequest,\
- \ chainDescriptor, idempotencyKey);"
+ code: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getAccessRegistrySummary(baseAssetId, accessRegistryAddress);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.unstake(unstake_request, chain_descriptor,\
- \ idempotency_key);"
+ code: "response = fireblocks.onchain_data.get_access_registry_summary(base_asset_id,\
+ \ access_registry_address);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.unstake(stakingApiUnstakeRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getAccessRegistrySummary(onchainDataApiGetAccessRegistrySummaryRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.staking().unstake(unstakeRequest,\
- \ chainDescriptor, idempotencyKey);"
+ source: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getAccessRegistrySummary(baseAssetId, accessRegistryAddress);"
- lang: Python
- source: "response = fireblocks.staking.unstake(unstake_request, chain_descriptor,\
- \ idempotency_key);"
- x-content-type: application/json
+ source: "response = fireblocks.onchain_data.get_access_registry_summary(base_asset_id,\
+ \ access_registry_address);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/withdraw:
- post:
- description: Perform a chain-specific Withdraw.
- operationId: withdraw
+ /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/transactions:
+ get:
+ description: "Returns a paginated list of onchain transactions for the specified\
+ \ contract address and base asset ID, optionally filtered by date range."
+ operationId: getOnchainTransactions
parameters:
- - description: The protocol identifier (e.g. "ETH"/"SOL"/"MATIC") to use
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- $ref: "#/components/schemas/ChainDescriptor"
+ type: string
style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
+ - description: The contract address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
explode: false
- in: header
- name: Idempotency-Key
- required: false
+ in: path
+ name: contractAddress
+ required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/WithdrawRequest"
- required: true
+ - description: Start date of the time range in ISO 8601 format
+ example: 2025-01-16T15:45:00Z
+ explode: true
+ in: query
+ name: startDate
+ required: false
+ schema:
+ format: date-time
+ type: string
+ style: form
+ - description: End date of the time range in ISO 8601 format
+ example: 2025-01-16T15:45:00Z
+ explode: true
+ in: query
+ name: endDate
+ required: false
+ schema:
+ format: date-time
+ type: string
+ style: form
+ - description: Page cursor to get the next page"
+ example: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "Number of items per page (max 100), requesting more then 100\
+ \ will return 100 items"
+ example: 10
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ maximum: 100
+ minimum: 1
+ type: integer
+ style: form
+ - description: Sorting field (enum).
+ explode: true
+ in: query
+ name: sortBy
+ required: false
+ schema:
+ default: blockTimestamp
+ enum:
+ - blockTimestamp
+ - blockNumber
+ - transactionHash
+ type: string
+ style: form
+ - description: ASC / DESC ordering (default DESC)
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: DESC
+ enum:
+ - ASC
+ - DESC
+ type: string
+ style: form
responses:
- "201":
- description: Withdraw action has been executed successfully on vault and
- is associated with 201 status code.
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/OnchainTransactionsPagedResponse"
+ description: Onchain transactions fetched successfully
default:
$ref: "#/components/responses/Error"
- summary: Execute a Withdraw operation
+ summary: Fetch onchain transactions for a contract
tags:
- - Staking
- x-rate-limit-category: write
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.staking.withdraw(stakingApiWithdrawRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getOnchainTransactions(onchainDataApiGetOnchainTransactionsRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.staking().withdraw(withdrawRequest,\
- \ chainDescriptor, idempotencyKey);"
+ code: "CompletableFuture>\
+ \ response = fireblocks.onchainData().getOnchainTransactions(baseAssetId,\
+ \ contractAddress, startDate, endDate, pageCursor, pageSize, sortBy, order);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.withdraw(withdraw_request, chain_descriptor,\
- \ idempotency_key);"
+ code: "response = fireblocks.onchain_data.get_onchain_transactions(base_asset_id,\
+ \ contract_address, start_date, end_date, page_cursor, page_size, sort_by,\
+ \ order);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.withdraw(stakingApiWithdrawRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getOnchainTransactions(onchainDataApiGetOnchainTransactionsRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.staking().withdraw(withdrawRequest,\
- \ chainDescriptor, idempotencyKey);"
+ source: "CompletableFuture>\
+ \ response = fireblocks.onchainData().getOnchainTransactions(baseAssetId,\
+ \ contractAddress, startDate, endDate, pageCursor, pageSize, sortBy, order);"
- lang: Python
- source: "response = fireblocks.staking.withdraw(withdraw_request, chain_descriptor,\
- \ idempotency_key);"
- x-content-type: application/json
+ source: "response = fireblocks.onchain_data.get_onchain_transactions(base_asset_id,\
+ \ contract_address, start_date, end_date, page_cursor, page_size, sort_by,\
+ \ order);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/claim_rewards:
- post:
- description: Perform a chain-specific Claim Rewards.
- operationId: claimRewards
+ /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/total_supply:
+ get:
+ description: Returns the paginated total supply history of the specified contract
+ with optional date range and interval filtering.
+ operationId: getContractTotalSupply
parameters:
- - description: The protocol identifier (e.g. "MATIC"/"SOL") to use
- example: MATIC
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- enum:
- - MATIC
- - SOL
- - SOL_TEST
type: string
style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
+ - description: The contract address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
explode: false
- in: header
- name: Idempotency-Key
- required: false
+ in: path
+ name: contractAddress
+ required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ClaimRewardsRequest"
- required: true
+ - description: Start date of the time range in ISO 8601 format
+ example: 2025-01-16T15:45:00Z
+ explode: true
+ in: query
+ name: startDate
+ required: false
+ schema:
+ format: date-time
+ type: string
+ style: form
+ - description: End date of the time range in ISO 8601 format
+ example: 2025-01-16T15:45:00Z
+ explode: true
+ in: query
+ name: endDate
+ required: false
+ schema:
+ format: date-time
+ type: string
+ style: form
+ - description: Time interval for grouping data
+ example: day
+ explode: true
+ in: query
+ name: interval
+ required: false
+ schema:
+ default: day
+ enum:
+ - hour
+ - day
+ - week
+ - month
+ type: string
+ style: form
+ - description: Page cursor to get the next page"
+ example: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "Number of items per page (max 100), requesting more then 100\
+ \ will return 100 items"
+ example: 10
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ maximum: 100
+ minimum: 1
+ type: integer
+ style: form
+ - description: Sorting field (enum). Sorting only supported by 'blockTimestamp'
+ explode: true
+ in: query
+ name: sortBy
+ required: false
+ schema:
+ default: blockTimestamp
+ enum:
+ - blockTimestamp
+ type: string
+ style: form
+ - description: ASC / DESC ordering (default DESC)
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: DESC
+ enum:
+ - ASC
+ - DESC
+ type: string
+ style: form
responses:
- "201":
- description: Claim Rewards action has been executed successfully on vault
- and is associated with 201 status code.
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/TotalSupplyPagedResponse"
+ description: Successfully retrieved the contract total supply history
default:
$ref: "#/components/responses/Error"
- summary: Execute a Claim Rewards operation
+ summary: Get historical total supply data for a contract
tags:
- - Staking
- x-rate-limit-category: write
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.staking.claimRewards(stakingApiClaimRewardsRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getContractTotalSupply(onchainDataApiGetContractTotalSupplyRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.staking().claimRewards(claimRewardsRequest,\
- \ chainDescriptor, idempotencyKey);"
+ code: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getContractTotalSupply(baseAssetId, contractAddress,\
+ \ startDate, endDate, interval, pageCursor, pageSize, sortBy, order);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.claim_rewards(claim_rewards_request,\
- \ chain_descriptor, idempotency_key);"
+ code: "response = fireblocks.onchain_data.get_contract_total_supply(base_asset_id,\
+ \ contract_address, start_date, end_date, interval, page_cursor, page_size,\
+ \ sort_by, order);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.claimRewards(stakingApiClaimRewardsRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getContractTotalSupply(onchainDataApiGetContractTotalSupplyRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.staking().claimRewards(claimRewardsRequest,\
- \ chainDescriptor, idempotencyKey);"
+ source: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getContractTotalSupply(baseAssetId, contractAddress,\
+ \ startDate, endDate, interval, pageCursor, pageSize, sortBy, order);"
- lang: Python
- source: "response = fireblocks.staking.claim_rewards(claim_rewards_request,\
- \ chain_descriptor, idempotency_key);"
- x-content-type: application/json
+ source: "response = fireblocks.onchain_data.get_contract_total_supply(base_asset_id,\
+ \ contract_address, start_date, end_date, interval, page_cursor, page_size,\
+ \ sort_by, order);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/split:
- post:
- description: Perform a Solana Split stake account.
- operationId: split
+ /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/account_address/{accountAddress}/balance_history:
+ get:
+ description: Returns the paginated balance history of the specified account
+ in a contract with optional date range and interval filtering.
+ operationId: getContractBalanceHistory
parameters:
- - description: The protocol identifier (e.g. "SOL"/"SOL_TEST") to use
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- enum:
- - SOL
- - SOL_TEST
type: string
style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
+ - description: The contract address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
explode: false
- in: header
- name: Idempotency-Key
- required: false
+ in: path
+ name: contractAddress
+ required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/SplitRequest"
+ - description: The account address to get balance history for
+ explode: false
+ in: path
+ name: accountAddress
required: true
- responses:
- "201":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/SplitResponse"
- description: Split action has been executed successfully on vault and is
- associated with 201 status code.
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
- default:
+ schema:
+ example: 0x1234567890abcdef1234567890abcdef12345678
+ type: string
+ style: simple
+ - description: Start date of the time range in ISO 8601 format
+ example: 2025-01-16T15:45:00Z
+ explode: true
+ in: query
+ name: startDate
+ required: false
+ schema:
+ format: date-time
+ type: string
+ style: form
+ - description: End date of the time range in ISO 8601 format
+ example: 2025-01-16T15:45:00Z
+ explode: true
+ in: query
+ name: endDate
+ required: false
+ schema:
+ format: date-time
+ type: string
+ style: form
+ - description: Time interval for grouping data
+ example: day
+ explode: true
+ in: query
+ name: interval
+ required: false
+ schema:
+ default: day
+ enum:
+ - hour
+ - day
+ - week
+ - month
+ type: string
+ style: form
+ - description: Page cursor to get the next page"
+ example: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "Number of items per page (max 100), requesting more then 100\
+ \ will return 100 items"
+ example: 10
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ maximum: 100
+ minimum: 1
+ type: integer
+ style: form
+ - description: Sorting field (enum). Sorting only supported by 'blockTimestamp'
+ explode: true
+ in: query
+ name: sortBy
+ required: false
+ schema:
+ default: blockTimestamp
+ enum:
+ - blockTimestamp
+ type: string
+ style: form
+ - description: ASC / DESC ordering (default DESC)
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: DESC
+ enum:
+ - ASC
+ - DESC
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/BalanceHistoryPagedResponse"
+ description: Successfully retrieved the contract balance history
+ default:
$ref: "#/components/responses/Error"
- summary: Execute a Split operation on SOL/SOL_TEST stake account
+ summary: Get historical balance data for a specific account in a contract
tags:
- - Staking
- x-rate-limit-category: write
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.staking.split(stakingApiSplitRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getContractBalanceHistory(onchainDataApiGetContractBalanceHistoryRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.staking().split(splitRequest,\
- \ chainDescriptor, idempotencyKey);"
+ code: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getContractBalanceHistory(baseAssetId, contractAddress,\
+ \ accountAddress, startDate, endDate, interval, pageCursor, pageSize,\
+ \ sortBy, order);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.split(split_request, chain_descriptor,\
- \ idempotency_key);"
+ code: "response = fireblocks.onchain_data.get_contract_balance_history(base_asset_id,\
+ \ contract_address, account_address, start_date, end_date, interval, page_cursor,\
+ \ page_size, sort_by, order);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.split(stakingApiSplitRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getContractBalanceHistory(onchainDataApiGetContractBalanceHistoryRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.staking().split(splitRequest,\
- \ chainDescriptor, idempotencyKey);"
+ source: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getContractBalanceHistory(baseAssetId, contractAddress,\
+ \ accountAddress, startDate, endDate, interval, pageCursor, pageSize, sortBy,\
+ \ order);"
- lang: Python
- source: "response = fireblocks.staking.split(split_request, chain_descriptor,\
- \ idempotency_key);"
- x-content-type: application/json
+ source: "response = fireblocks.onchain_data.get_contract_balance_history(base_asset_id,\
+ \ contract_address, account_address, start_date, end_date, interval, page_cursor,\
+ \ page_size, sort_by, order);"
x-accepts:
- application/json
- /staking/chains/{chainDescriptor}/merge:
- post:
- description: |-
- Perform a Solana Merge of two active stake accounts into one.
-
- Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
- operationId: mergeStakeAccounts
+ /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/summary:
+ get:
+ description: Returns the total number of unique addresses holding balances and
+ the total supply for the specified contract.
+ operationId: getContractBalancesSummary
parameters:
- - description: The protocol identifier (e.g. "SOL"/"SOL_TEST") to use
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
explode: false
in: path
- name: chainDescriptor
+ name: baseAssetId
required: true
schema:
- enum:
- - SOL
- - SOL_TEST
type: string
style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
+ - description: The contract address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
explode: false
- in: header
- name: Idempotency-Key
- required: false
+ in: path
+ name: contractAddress
+ required: true
schema:
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/MergeStakeAccountsRequest"
- required: true
responses:
- "201":
+ "200":
content:
application/json:
schema:
- $ref: "#/components/schemas/MergeStakeAccountsResponse"
- description: Merge action has been executed successfully on vault and is
- associated with 201 status code.
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ $ref: "#/components/schemas/TokenContractSummaryResponse"
+ description: Successfully retrieved the summary for the token contract
default:
$ref: "#/components/responses/Error"
- summary: Merge Solana on stake accounts
+ summary: Get summary for the token contract
tags:
- - Staking
- x-rate-limit-category: write
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.staking.mergeStakeAccounts(stakingApiMergeStakeAccountsRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getContractBalancesSummary(onchainDataApiGetContractBalancesSummaryRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response\
- \ = fireblocks.staking().mergeStakeAccounts(mergeStakeAccountsRequest,\
- \ chainDescriptor, idempotencyKey);"
+ code: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getContractBalancesSummary(baseAssetId, contractAddress);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.merge_stake_accounts(merge_stake_accounts_request,\
- \ chain_descriptor, idempotency_key);"
+ code: "response = fireblocks.onchain_data.get_contract_balances_summary(base_asset_id,\
+ \ contract_address);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.staking.mergeStakeAccounts(stakingApiMergeStakeAccountsRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getContractBalancesSummary(onchainDataApiGetContractBalancesSummaryRequest);"
- lang: Java
- source: "CompletableFuture> response\
- \ = fireblocks.staking().mergeStakeAccounts(mergeStakeAccountsRequest, chainDescriptor,\
- \ idempotencyKey);"
+ source: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getContractBalancesSummary(baseAssetId, contractAddress);"
- lang: Python
- source: "response = fireblocks.staking.merge_stake_accounts(merge_stake_accounts_request,\
- \ chain_descriptor, idempotency_key);"
- x-content-type: application/json
+ source: "response = fireblocks.onchain_data.get_contract_balances_summary(base_asset_id,\
+ \ contract_address);"
x-accepts:
- application/json
- /staking/positions:
+ /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/balances:
get:
- description: "Return detailed information on all staking positions, including\
- \ the staked amount, rewards, status and more."
- operationId: getAllDelegations
+ description: Returns the latest balance for each unique address with support
+ for numeric balance sorting. The `prev` cursor is reserved for future support.
+ operationId: getLatestBalancesForContract
parameters:
- - description: Use "ETH" / "SOL" / "MATIC" / "STETH_ETH" in order to obtain
- information related to the specific blockchain network or retrieve information
- about all chains that have data available by providing no argument.
- example: SOL
+ - description: The blockchain base assetId
+ example: ETH_TEST3
+ explode: false
+ in: path
+ name: baseAssetId
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: The contract address
+ example: 0xC2c4e1Db41F0bB97996D0eD0542D2170d146FB66
+ explode: false
+ in: path
+ name: contractAddress
+ required: true
+ schema:
+ type: string
+ style: simple
+ - description: Optional filter to get balance for a specific account address
explode: true
in: query
- name: chainDescriptor
+ name: accountAddress
required: false
schema:
- $ref: "#/components/schemas/ChainDescriptor"
+ example: 0x1234567890abcdef1234567890abcdef12345678
+ type: string
+ style: form
+ - description: Page cursor to get the next page"
+ example: MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==
+ explode: true
+ in: query
+ name: pageCursor
+ required: false
+ schema:
+ type: string
+ style: form
+ - description: "Number of items per page (max 100), requesting more then 100\
+ \ will return 100 items"
+ example: 10
+ explode: true
+ in: query
+ name: pageSize
+ required: false
+ schema:
+ maximum: 100
+ minimum: 1
+ type: integer
+ style: form
+ - description: Sorting field for balances
+ explode: true
+ in: query
+ name: sortBy
+ required: false
+ schema:
+ default: blockTimestamp
+ enum:
+ - accountAddress
+ - blockTimestamp
+ type: string
+ style: form
+ - description: ASC / DESC ordering (default DESC)
+ explode: true
+ in: query
+ name: order
+ required: false
+ schema:
+ default: DESC
+ enum:
+ - ASC
+ - DESC
+ type: string
style: form
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/StakingGetAllDelegationsResponse"
- description: An array of position data was returned successfully
- headers:
- X-Request-ID:
- $ref: "#/components/headers/X-Request-ID"
+ $ref: "#/components/schemas/AddressBalancePagedResponse"
+ description: Successfully retrieved the latest balances for the contract
default:
$ref: "#/components/responses/Error"
- summary: List staking positions details
+ summary: Get latest balances for all addresses holding tokens from a contract
tags:
- - Staking
- x-rate-limit-category: query
+ - Onchain Data
+ x-rate-limit-category: read
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.staking.getAllDelegations(stakingApiGetAllDelegationsRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.onchainData.getLatestBalancesForContract(onchainDataApiGetLatestBalancesForContractRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: CompletableFuture>> response = fireblocks.staking().getAllDelegations(chainDescriptor);
+ code: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getLatestBalancesForContract(baseAssetId,\
+ \ contractAddress, accountAddress, pageCursor, pageSize, sortBy, order);"
name: Fireblocks SDK Java example
- language: python
- code: response = fireblocks.staking.get_all_delegations(chain_descriptor);
+ code: "response = fireblocks.onchain_data.get_latest_balances_for_contract(base_asset_id,\
+ \ contract_address, account_address, page_cursor, page_size, sort_by,\
+ \ order);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.staking.getAllDelegations(stakingApiGetAllDelegationsRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.onchainData.getLatestBalancesForContract(onchainDataApiGetLatestBalancesForContractRequest);"
- lang: Java
- source: CompletableFuture>> response = fireblocks.staking().getAllDelegations(chainDescriptor);
+ source: "CompletableFuture> response\
+ \ = fireblocks.onchainData().getLatestBalancesForContract(baseAssetId, contractAddress,\
+ \ accountAddress, pageCursor, pageSize, sortBy, order);"
- lang: Python
- source: response = fireblocks.staking.get_all_delegations(chain_descriptor);
+ source: "response = fireblocks.onchain_data.get_latest_balances_for_contract(base_asset_id,\
+ \ contract_address, account_address, page_cursor, page_size, sort_by, order);"
x-accepts:
- application/json
- /staking/positions/summary:
+ /staking/chains:
get:
- description: "Return a summary of all vaults, categorized by their status (active,\
- \ inactive), the total amounts staked and total rewards per-chain."
- operationId: getSummary
+ description: |-
+ Returns an alphabetical list of blockchains supported for staking by the current workspace context.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ operationId: getChains
responses:
"200":
content:
application/json:
- example:
- active:
- - chainDescriptor: ETH
- amount: "64.036604667"
- - chainDescriptor: SOL
- amount: "0.077345939"
- inactive:
- - chainDescriptor: ETH
- amount: "0"
- - chainDescriptor: SOL
- amount: "0"
- rewardsAmount:
- - chainDescriptor: ETH
- amount: "0.036604667"
- - chainDescriptor: SOL
- amount: "0.001345939"
- totalStaked:
- - chainDescriptor: ETH
- amount: "64.036604667"
- - chainDescriptor: SOL
- amount: "0.077345939"
schema:
- $ref: "#/components/schemas/DelegationSummary"
- description: A summary for all vaults were returned successfully
+ $ref: "#/components/schemas/StakingGetChainsResponse"
+ description: An array of supported chains was returned successfully.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- default:
- $ref: "#/components/responses/Error"
- summary: Get staking summary details
- tags:
- - Staking
- x-rate-limit-category: query
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> =\
- \ fireblocks.staking.getSummary();"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: CompletableFuture> response = fireblocks.staking().getSummary();
- name: Fireblocks SDK Java example
- - language: python
- code: response = fireblocks.staking.get_summary();
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> =\
- \ fireblocks.staking.getSummary();"
- - lang: Java
- source: CompletableFuture> response = fireblocks.staking().getSummary();
- - lang: Python
- source: response = fireblocks.staking.get_summary();
- x-accepts:
- - application/json
- /staking/positions/summary/vaults:
- get:
- description: "Return a summary for each vault, categorized by their status (active,\
- \ inactive), the total amounts staked and total rewards per-chain."
- operationId: getSummaryByVault
- responses:
- "200":
+ "403":
content:
application/json:
- example:
- "0":
- active:
- - chainDescriptor: SOL
- amount: "0.015202376"
- inactive:
- - chainDescriptor: SOL
- amount: "0"
- rewardsAmount:
- - chainDescriptor: SOL
- amount: "0.000202376"
- totalStaked:
- - chainDescriptor: SOL
- amount: "0.015202376"
- "1":
- active:
- - chainDescriptor: ETH
- amount: "64.036604667"
- - chainDescriptor: SOL
- amount: "0.011191566"
- inactive:
- - chainDescriptor: ETH
- amount: "0"
- - chainDescriptor: SOL
- amount: "0"
- rewardsAmount:
- - chainDescriptor: ETH
- amount: "0.036604667"
- - chainDescriptor: SOL
- amount: "0.000191566"
- totalStaked:
- - chainDescriptor: ETH
- amount: "64.036604667"
- - chainDescriptor: SOL
- amount: "0.011191566"
schema:
- $ref: "#/components/schemas/StakingGetSummaryByVaultResponse"
- description: A summary for each vault were returned successfully
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Get staking summary details by vault
+ summary: List supported staking chains
tags:
- Staking
x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.staking.getSummaryByVault();"
+ code: "const response: Promise>\
+ \ = fireblocks.staking.getChains();"
name: Fireblocks SDK TypeScript example
- language: java
- code: CompletableFuture> response
- = fireblocks.staking().getSummaryByVault();
+ code: CompletableFuture>> response = fireblocks.staking().getChains();
name: Fireblocks SDK Java example
- language: python
- code: response = fireblocks.staking.get_summary_by_vault();
+ code: response = fireblocks.staking.get_chains();
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.staking.getSummaryByVault();"
+ source: "const response: Promise>\
+ \ = fireblocks.staking.getChains();"
- lang: Java
- source: CompletableFuture> response
- = fireblocks.staking().getSummaryByVault();
+ source: CompletableFuture>> response = fireblocks.staking().getChains();
- lang: Python
- source: response = fireblocks.staking.get_summary_by_vault();
+ source: response = fireblocks.staking.get_chains();
x-accepts:
- application/json
- /staking/positions/{id}:
+ /staking/chains/{chainDescriptor}/chainInfo:
get:
- description: "Return detailed information on a staking position, including the\
- \ staked amount, rewards, status and more."
- operationId: getDelegationById
+ description: "Returns chain-specific staking information such as epoch/slot\
+ \ cadence, lockup or unbonding periods, fee/reward mechanics, and other operational\
+ \ constraints."
+ operationId: getChainInfo
parameters:
- - description: The unique identifier of the staking position
- example: 1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7
+ - description: "Protocol identifier for the chain info staking operation (e.g.,\
+ \ ETH/MATIC/SOL)."
explode: false
in: path
- name: id
+ name: chainDescriptor
required: true
schema:
- type: string
+ $ref: "#/components/schemas/ChainDescriptor"
style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/Delegation"
- description: Position data was returned successfully
+ $ref: "#/components/schemas/ChainInfoResponse"
+ description: Chain-specific staking information returned successfully.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- default:
- $ref: "#/components/responses/Error"
- summary: Get staking position details
- tags:
- - Staking
- x-rate-limit-category: query
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.staking.getDelegationById(stakingApiGetDelegationByIdRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: CompletableFuture> response = fireblocks.staking().getDelegationById(id);
- name: Fireblocks SDK Java example
- - language: python
- code: response = fireblocks.staking.get_delegation_by_id(id);
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.getDelegationById(stakingApiGetDelegationByIdRequest);"
- - lang: Java
- source: CompletableFuture> response = fireblocks.staking().getDelegationById(id);
- - lang: Python
- source: response = fireblocks.staking.get_delegation_by_id(id);
- x-accepts:
- - application/json
- /staking/providers:
- get:
- description: Return information on all the available staking providers.
- operationId: getProviders
- responses:
- "200":
+ "400":
content:
application/json:
schema:
- $ref: "#/components/schemas/StakingGetProvidersResponse"
- description: An array of supported providers was returned successfully
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: List staking providers details
+ summary: Get chain-level staking parameters
tags:
- Staking
x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.staking.getProviders();"
+ code: "const response: Promise> =\
+ \ fireblocks.staking.getChainInfo(stakingApiGetChainInfoRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: CompletableFuture>> response = fireblocks.staking().getProviders();
+ code: CompletableFuture> response = fireblocks.staking().getChainInfo(chainDescriptor);
name: Fireblocks SDK Java example
- language: python
- code: response = fireblocks.staking.get_providers();
+ code: response = fireblocks.staking.get_chain_info(chain_descriptor);
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.staking.getProviders();"
+ source: "const response: Promise> =\
+ \ fireblocks.staking.getChainInfo(stakingApiGetChainInfoRequest);"
- lang: Java
- source: CompletableFuture>> response = fireblocks.staking().getProviders();
+ source: CompletableFuture> response = fireblocks.staking().getChainInfo(chainDescriptor);
- lang: Python
- source: response = fireblocks.staking.get_providers();
+ source: response = fireblocks.staking.get_chain_info(chain_descriptor);
x-accepts:
- application/json
- /staking/providers/{providerId}/approveTermsOfService:
+ /staking/chains/{chainDescriptor}/stake:
post:
- description: |-
- Approve the terms of service of the staking provider.
- This must be called before performing a staking action for the first time with this provider.
- operationId: approveTermsOfServiceByProviderId
+ description: "Creates a new staking position and returns its unique ID. For\
+ \ Ethereum compounding validator (EIP-7251): when the 'id' of an existing\
+ \ compounding validator position is provided, adds to that position; otherwise\
+ \ creates a new position. For Ethereum legacy validator: creates a new position\
+ \ regardless of existing delegations. For Cosmos chains and Ethereum liquid\
+ \ staking (Lido): automatically add to existing positions for the same validator\
+ \ provider and same vault account if one exists, otherwise create a new position.\
+ \ For Solana and Polygon: always create new positions regardless of existing\
+ \ delegations."
+ operationId: stake
parameters:
- - description: The unique identifier of the staking provider
- example: kiln
+ - description: "Protocol identifier for the stake staking operation (e.g., ATOM_COS/AXL/CELESTIA)."
explode: false
in: path
- name: providerId
+ name: chainDescriptor
required: true
schema:
- $ref: "#/components/schemas/StakingProvider"
+ $ref: "#/components/schemas/ChainDescriptor"
style: simple
- description: "A unique identifier for the request. If the request is sent\
\ multiple times with the same idempotency key, the server will return the\
@@ -17350,136 +18164,233 @@ paths:
schema:
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/StakeRequest"
+ required: true
responses:
"201":
- description: The terms of service have been successfully approved and is
- associated with 201 status code.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/StakeResponse"
+ description: Stake request accepted and created.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Approve staking terms of service
+ summary: Initiate or add to existing stake
tags:
- Staking
x-rate-limit-category: write
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.staking.approveTermsOfServiceByProviderId(stakingApiApproveTermsOfServiceByProviderIdRequest);"
+ code: "const response: Promise> = fireblocks.staking.stake(stakingApiStakeRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.staking().approveTermsOfServiceByProviderId(providerId,\
- \ idempotencyKey);"
+ code: "CompletableFuture> response = fireblocks.staking().stake(stakeRequest,\
+ \ chainDescriptor, idempotencyKey);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.staking.approve_terms_of_service_by_provider_id(provider_id,\
+ code: "response = fireblocks.staking.stake(stake_request, chain_descriptor,\
\ idempotency_key);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.staking.approveTermsOfServiceByProviderId(stakingApiApproveTermsOfServiceByProviderIdRequest);"
+ source: "const response: Promise> = fireblocks.staking.stake(stakingApiStakeRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.staking().approveTermsOfServiceByProviderId(providerId,\
- \ idempotencyKey);"
+ source: "CompletableFuture> response = fireblocks.staking().stake(stakeRequest,\
+ \ chainDescriptor, idempotencyKey);"
- lang: Python
- source: "response = fireblocks.staking.approve_terms_of_service_by_provider_id(provider_id,\
+ source: "response = fireblocks.staking.stake(stake_request, chain_descriptor,\
\ idempotency_key);"
+ x-content-type: application/json
x-accepts:
- application/json
- /trading/providers:
- get:
- description: |-
- Retrieve a list of all available external providers supporting trading activities through the platform.
-
- Note: These endpoints are currently in beta and might be subject to changes.
-
- If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.
-
- Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
- operationId: getTradingProviders
+ /staking/chains/{chainDescriptor}/unstake:
+ post:
+ description: Submits a chain-specific unstake request.
+ operationId: unstake
parameters:
- - description: Page size for pagination.
- explode: true
- in: query
- name: pageSize
- required: false
+ - description: "Protocol identifier for the unstake staking operation (e.g.,\
+ \ SOL/SOL_TEST/MATIC)."
+ explode: false
+ in: path
+ name: chainDescriptor
+ required: true
schema:
- default: 20
- maximum: 100
- minimum: 1
- type: integer
- style: form
- - description: Page cursor for pagination.
- explode: true
- in: query
- name: pageCursor
+ $ref: "#/components/schemas/ChainDescriptor"
+ style: simple
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
required: false
schema:
type: string
- style: form
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/UnstakeRequest"
+ required: true
responses:
- "200":
+ "201":
+ description: Unstake request accepted and created.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProvidersListResponse"
- description: Providers response
- "401":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Unauthorized. Missing / invalid JWT token in Authorization
- header.
- "5XX":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Internal error.
- summary: Get providers
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Initiate unstake
tags:
- - Trading (Beta)
- x-rate-limit-category: query
+ - Staking
+ x-rate-limit-category: write
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.tradingBeta.getTradingProviders(tradingBetaApiGetTradingProvidersRequest);"
+ code: "const response: Promise> = fireblocks.staking.unstake(stakingApiUnstakeRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response =\
- \ fireblocks.tradingBeta().getTradingProviders(pageSize, pageCursor);"
+ code: "CompletableFuture> response = fireblocks.staking().unstake(unstakeRequest,\
+ \ chainDescriptor, idempotencyKey);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.trading_beta.get_trading_providers(page_size,\
- \ page_cursor);"
+ code: "response = fireblocks.staking.unstake(unstake_request, chain_descriptor,\
+ \ idempotency_key);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.tradingBeta.getTradingProviders(tradingBetaApiGetTradingProvidersRequest);"
+ source: "const response: Promise> = fireblocks.staking.unstake(stakingApiUnstakeRequest);"
- lang: Java
- source: "CompletableFuture> response =\
- \ fireblocks.tradingBeta().getTradingProviders(pageSize, pageCursor);"
+ source: "CompletableFuture> response = fireblocks.staking().unstake(unstakeRequest,\
+ \ chainDescriptor, idempotencyKey);"
- lang: Python
- source: "response = fireblocks.trading_beta.get_trading_providers(page_size,\
- \ page_cursor);"
+ source: "response = fireblocks.staking.unstake(unstake_request, chain_descriptor,\
+ \ idempotency_key);"
+ x-content-type: application/json
x-accepts:
- application/json
- /trading/quotes:
+ /staking/chains/{chainDescriptor}/withdraw:
post:
- description: |-
- Generate a time-limited quote for asset conversion, providing exchange rate and amount calculations.
-
- Note: These endpoints are currently in beta and might be subject to changes.
-
- If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.
-
- Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor.
- operationId: createQuote
+ description: Withdraws funds that have completed the unbonding period. Typically
+ requires the position to be deactivated first (unstake → unbond → withdraw).
+ Amount and timing vary by chain protocol.
+ operationId: withdraw
parameters:
+ - description: "Protocol identifier for the withdraw staking operation (e.g.,\
+ \ ATOM_COS/ETH/STETH_ETH)."
+ explode: false
+ in: path
+ name: chainDescriptor
+ required: true
+ schema:
+ $ref: "#/components/schemas/ChainDescriptor"
+ style: simple
- description: "A unique identifier for the request. If the request is sent\
\ multiple times with the same idempotency key, the server will return the\
\ same response as the first request. The idempotency key is valid for 24\
@@ -17495,231 +18406,235 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/CreateQuote"
+ $ref: "#/components/schemas/WithdrawRequest"
required: true
responses:
"201":
+ description: Withdraw request accepted and created.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
content:
application/json:
schema:
- $ref: "#/components/schemas/QuotesResponse"
- description: Quote created
- "401":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Unauthorized. Missing / invalid JWT token in Authorization
- header.
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Not found
- "5XX":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Internal error.
- summary: Create a quote
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Withdraw staked funds
tags:
- - Trading (Beta)
+ - Staking
x-rate-limit-category: write
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.tradingBeta.createQuote(tradingBetaApiCreateQuoteRequest);"
+ code: "const response: Promise> = fireblocks.staking.withdraw(stakingApiWithdrawRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.tradingBeta().createQuote(createQuote,\
- \ idempotencyKey);"
+ code: "CompletableFuture> response = fireblocks.staking().withdraw(withdrawRequest,\
+ \ chainDescriptor, idempotencyKey);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.trading_beta.create_quote(create_quote, idempotency_key);"
+ code: "response = fireblocks.staking.withdraw(withdraw_request, chain_descriptor,\
+ \ idempotency_key);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.tradingBeta.createQuote(tradingBetaApiCreateQuoteRequest);"
+ source: "const response: Promise> = fireblocks.staking.withdraw(stakingApiWithdrawRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.tradingBeta().createQuote(createQuote,\
- \ idempotencyKey);"
+ source: "CompletableFuture> response = fireblocks.staking().withdraw(withdrawRequest,\
+ \ chainDescriptor, idempotencyKey);"
- lang: Python
- source: "response = fireblocks.trading_beta.create_quote(create_quote, idempotency_key);"
+ source: "response = fireblocks.staking.withdraw(withdraw_request, chain_descriptor,\
+ \ idempotency_key);"
x-content-type: application/json
x-accepts:
- application/json
- /trading/orders:
- get:
- description: |-
- Retrieve a paginated list of orders with optional filtering by account, provider, status, and time range.
-
- Note:These endpoints are currently in beta and might be subject to changes.
-
- If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.
-
- Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
- operationId: getOrders
+ /staking/chains/{chainDescriptor}/claim_rewards:
+ post:
+ description: "Claims available staking rewards for the specified chain and vault.\
+ \ Supported chains: Solana and Polygon (Matic). Behavior depends on protocol\
+ \ reward distribution."
+ operationId: claimRewards
parameters:
- - description: pageSize for pagination.
- explode: true
- in: query
- name: pageSize
+ - description: "Protocol identifier for the claim rewards staking operation\
+ \ (e.g., MATIC/SOL)."
+ example: SOL
+ explode: false
+ in: path
+ name: chainDescriptor
required: true
schema:
- maximum: 100
- minimum: 1
- type: integer
- style: form
- - explode: true
- in: query
- name: pageCursor
- required: false
- schema:
- minLength: 1
- type: string
- style: form
- - description: ASC / DESC ordering (default DESC)
- explode: true
- in: query
- name: order
- required: false
- schema:
- default: DESC
enum:
- - ASC
- - DESC
+ - SOL
+ - SOL_TEST
+ - MATIC
type: string
- style: form
- - description: Filter by accountId.
- explode: true
- in: query
- name: accountId
- required: false
- schema:
- items:
- minLength: 1
- type: string
- type: array
- style: form
- - description: Filter by providerId.
- explode: true
- in: query
- name: providerId
- required: false
- schema:
- items:
- minLength: 1
- type: string
- type: array
- style: form
- - description: Filter by order status.
- explode: true
- in: query
- name: statuses
- required: false
- schema:
- items:
- $ref: "#/components/schemas/OrderStatus"
- type: array
- style: form
- - explode: true
- in: query
- name: startTime
- required: false
- schema:
- minimum: 0
- type: integer
- style: form
- - explode: true
- in: query
- name: endTime
- required: false
- schema:
- minimum: 0
- type: integer
- style: form
- - explode: true
- in: query
- name: assetConversionType
+ style: simple
+ - description: "A unique identifier for the request. If the request is sent\
+ \ multiple times with the same idempotency key, the server will return the\
+ \ same response as the first request. The idempotency key is valid for 24\
+ \ hours."
+ explode: false
+ in: header
+ name: Idempotency-Key
required: false
schema:
- description: Filter by asset conversion type.
- enum:
- - DIGITAL_ONLY
- - FIAT
type: string
- style: form
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ClaimRewardsRequest"
+ required: true
responses:
- "200":
+ "201":
+ description: Claim-rewards request accepted and created.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
content:
application/json:
schema:
- $ref: "#/components/schemas/GetOrdersResponse"
- description: Orders response
- "401":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Unauthorized. Missing / invalid JWT token in Authorization
- header.
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Not found
- "5XX":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Internal error.
- summary: Get orders
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Claim accrued rewards
tags:
- - Trading (Beta)
- x-rate-limit-category: read
+ - Staking
+ x-rate-limit-category: write
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> =\
- \ fireblocks.tradingBeta.getOrders(tradingBetaApiGetOrdersRequest);"
+ code: "const response: Promise> = fireblocks.staking.claimRewards(stakingApiClaimRewardsRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.tradingBeta().getOrders(pageSize,\
- \ pageCursor, order, accountId, providerId, statuses, startTime, endTime,\
- \ assetConversionType);"
+ code: "CompletableFuture> response = fireblocks.staking().claimRewards(claimRewardsRequest,\
+ \ chainDescriptor, idempotencyKey);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.trading_beta.get_orders(page_size, page_cursor,\
- \ order, account_id, provider_id, statuses, start_time, end_time, asset_conversion_type);"
+ code: "response = fireblocks.staking.claim_rewards(claim_rewards_request,\
+ \ chain_descriptor, idempotency_key);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> =\
- \ fireblocks.tradingBeta.getOrders(tradingBetaApiGetOrdersRequest);"
+ source: "const response: Promise> = fireblocks.staking.claimRewards(stakingApiClaimRewardsRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.tradingBeta().getOrders(pageSize,\
- \ pageCursor, order, accountId, providerId, statuses, startTime, endTime,\
- \ assetConversionType);"
+ source: "CompletableFuture> response = fireblocks.staking().claimRewards(claimRewardsRequest,\
+ \ chainDescriptor, idempotencyKey);"
- lang: Python
- source: "response = fireblocks.trading_beta.get_orders(page_size, page_cursor,\
- \ order, account_id, provider_id, statuses, start_time, end_time, asset_conversion_type);"
+ source: "response = fireblocks.staking.claim_rewards(claim_rewards_request,\
+ \ chain_descriptor, idempotency_key);"
+ x-content-type: application/json
x-accepts:
- application/json
+ /staking/chains/{chainDescriptor}/split:
post:
- description: |-
- Create an order to buy or sell an asset. If no source is given, an external source will be use.
-
- Note: These endpoints are currently in beta and might be subject to changes.
-
- If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.
-
- Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor.
- operationId: createOrder
+ description: "Splits a staking position by creating a new stake account with\
+ \ the requested amount, while keeping the original account with the remaining\
+ \ balance. Supported chains: Solana (SOL)."
+ operationId: split
parameters:
+ - description: "Protocol identifier for the staking operation (e.g., SOL)."
+ example: SOL
+ explode: false
+ in: path
+ name: chainDescriptor
+ required: true
+ schema:
+ enum:
+ - SOL
+ - SOL_TEST
+ type: string
+ style: simple
- description: "A unique identifier for the request. If the request is sent\
\ multiple times with the same idempotency key, the server will return the\
\ same response as the first request. The idempotency key is valid for 24\
@@ -17735,139 +18650,116 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/CreateOrderRequest"
+ $ref: "#/components/schemas/SplitRequest"
required: true
responses:
- "202":
+ "201":
content:
application/json:
schema:
- $ref: "#/components/schemas/OrderDetails"
- description: Order creation response
- "401":
+ $ref: "#/components/schemas/SplitResponse"
+ description: Split request accepted and created.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Unauthorized. Missing / invalid JWT token in Authorization
- header.
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Not found
- "5XX":
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
content:
application/json:
schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Internal error.
- summary: Create an order
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Split a staking position
tags:
- - Trading (Beta)
+ - Staking
x-rate-limit-category: write
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.tradingBeta.createOrder(tradingBetaApiCreateOrderRequest);"
+ code: "const response: Promise> = fireblocks.staking.split(stakingApiSplitRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.tradingBeta().createOrder(createOrderRequest,\
- \ idempotencyKey);"
+ code: "CompletableFuture> response = fireblocks.staking().split(splitRequest,\
+ \ chainDescriptor, idempotencyKey);"
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.trading_beta.create_order(create_order_request,\
+ code: "response = fireblocks.staking.split(split_request, chain_descriptor,\
\ idempotency_key);"
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.tradingBeta.createOrder(tradingBetaApiCreateOrderRequest);"
+ source: "const response: Promise> = fireblocks.staking.split(stakingApiSplitRequest);"
- lang: Java
- source: "CompletableFuture> response = fireblocks.tradingBeta().createOrder(createOrderRequest,\
- \ idempotencyKey);"
+ source: "CompletableFuture> response = fireblocks.staking().split(splitRequest,\
+ \ chainDescriptor, idempotencyKey);"
- lang: Python
- source: "response = fireblocks.trading_beta.create_order(create_order_request,\
+ source: "response = fireblocks.staking.split(split_request, chain_descriptor,\
\ idempotency_key);"
x-content-type: application/json
x-accepts:
- application/json
- /trading/orders/{orderId}:
- get:
+ /staking/chains/{chainDescriptor}/merge:
+ post:
description: |-
- Retrieve detailed information about a specific order by its ID.
-
- Note:These endpoints are currently in beta and might be subject to changes.
-
- If you want to participate and learn more about the Fireblocks Trading, please contact your Fireblocks Customer Success Manager or send an email to CSM@fireblocks.com.
-
- Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.
- operationId: getOrder
+ Merges the source stake account into the destination, consolidating the balance into the destination and closing the source account once complete. Both accounts must be from the same validator provider and of same vault account.. Supported chains: Solana (SOL).
+ Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Approver, Editor.
+ operationId: mergeStakeAccounts
parameters:
- - description: The ID of the order to fetch.
+ - description: "Protocol identifier for the merge staking operation (e.g., SOL)."
+ example: SOL
explode: false
in: path
- name: orderId
+ name: chainDescriptor
required: true
schema:
- minLength: 1
- type: string
+ enum:
+ - SOL
+ - SOL_TEST
+ type: string
style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/OrderDetails"
- description: Order response
- "401":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Unauthorized. Missing / invalid JWT token in Authorization
- header.
- "404":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Not found
- "5XX":
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TradingErrorResponse"
- description: Internal error.
- summary: Get order details
- tags:
- - Trading (Beta)
- x-rate-limit-category: read
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.tradingBeta.getOrder(tradingBetaApiGetOrderRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: CompletableFuture> response = fireblocks.tradingBeta().getOrder(orderId);
- name: Fireblocks SDK Java example
- - language: python
- code: response = fireblocks.trading_beta.get_order(order_id);
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.tradingBeta.getOrder(tradingBetaApiGetOrderRequest);"
- - lang: Java
- source: CompletableFuture> response = fireblocks.tradingBeta().getOrder(orderId);
- - lang: Python
- source: response = fireblocks.trading_beta.get_order(order_id);
- x-accepts:
- - application/json
- /admin_quorum:
- put:
- description: Update admin quorum threshold
- operationId: setAdminQuorumThreshold
- parameters:
- description: "A unique identifier for the request. If the request is sent\
\ multiple times with the same idempotency key, the server will return the\
\ same response as the first request. The idempotency key is valid for 24\
@@ -17883,701 +18775,616 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/SetAdminQuorumThresholdRequest"
+ $ref: "#/components/schemas/MergeStakeAccountsRequest"
required: true
responses:
- "202":
+ "201":
content:
application/json:
schema:
- $ref: "#/components/schemas/SetAdminQuorumThresholdResponse"
- description: OK
+ $ref: "#/components/schemas/MergeStakeAccountsResponse"
+ description: Merge request accepted and created.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
default:
$ref: "#/components/responses/Error"
- summary: Update admin quorum threshold
+ summary: Merge staking positions
tags:
- - Admin Quorum
- x-internal: true
+ - Staking
x-rate-limit-category: write
x-readme:
code-samples:
+ - language: typescript
+ code: "const response: Promise>\
+ \ = fireblocks.staking.mergeStakeAccounts(stakingApiMergeStakeAccountsRequest);"
+ name: Fireblocks SDK TypeScript example
+ - language: java
+ code: "CompletableFuture> response\
+ \ = fireblocks.staking().mergeStakeAccounts(mergeStakeAccountsRequest,\
+ \ chainDescriptor, idempotencyKey);"
+ name: Fireblocks SDK Java example
- language: python
- code: result = fireblocks.set_admin_quorum_threshold(adminQuorumThreshold)
- name: Fireblocks SDK Python example (Legacy)
- - language: javascript
- code: const result = await fireblocks.setAdminQuorumThreshold(adminQuorumThreshold)
- name: Fireblocks SDK Javascript example
+ code: "response = fireblocks.staking.merge_stake_accounts(merge_stake_accounts_request,\
+ \ chain_descriptor, idempotency_key);"
+ name: Fireblocks SDK Python example
+ x-codeSamples:
+ - lang: TypeScript
+ source: "const response: Promise>\
+ \ = fireblocks.staking.mergeStakeAccounts(stakingApiMergeStakeAccountsRequest);"
+ - lang: Java
+ source: "CompletableFuture> response\
+ \ = fireblocks.staking().mergeStakeAccounts(mergeStakeAccountsRequest, chainDescriptor,\
+ \ idempotencyKey);"
+ - lang: Python
+ source: "response = fireblocks.staking.merge_stake_accounts(merge_stake_accounts_request,\
+ \ chain_descriptor, idempotency_key);"
x-content-type: application/json
x-accepts:
- application/json
- /nfts/ownership/tokens:
+ /staking/positions:
get:
- description: |
- Returns all tokens and their data in your workspace.
- operationId: getOwnershipTokens
+ description: |-
+ Returns all staking positions with core details: amounts, rewards, status, chain, and vault.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ operationId: getAllDelegations
parameters:
- - description: Blockchain descriptor filter
- explode: true
- in: query
- name: blockchainDescriptor
- required: false
- schema:
- enum:
- - ETH
- - ETH_TEST3
- - ETH_TEST5
- - ETH_TEST6
- - POLYGON
- - POLYGON_TEST_MUMBAI
- - AMOY_POLYGON_TEST
- - XTZ
- - XTZ_TEST
- - BASECHAIN_ETH
- - BASECHAIN_ETH_TEST3
- - BASECHAIN_ETH_TEST5
- - ETHERLINK
- - ETHERLINK_TEST
- - MANTLE
- - MANTLE_TEST
- - GUN_GUNZILLA
- - GUN_GUNZILLA_TEST
- - ETH_SONEIUM
- - SONEIUM_MINATO_TEST
- - IOTX_IOTEX
- - KLAY_KAIA
- - KLAY_KAIA_TEST
- - APECHAIN
- - APECHAIN_TEST
- type: string
- style: form
- - description: A comma separated list of Vault Account IDs. Up to 100 are allowed
- in a single request. This field will be ignored when walletType=END_USER_WALLET
- or ncwId is provided.
- explode: true
- in: query
- name: vaultAccountIds
- required: false
- schema:
- type: string
- style: form
- - description: Tenant's Non-Custodial Wallet ID
- explode: true
- in: query
- name: ncwId
- required: false
- schema:
- type: string
- style: form
- - description: A comma separated list of Non-Custodial account IDs. Up to 100
- are allowed in a single request. This field will be ignored when walletType=VAULT_ACCOUNT
- or ncwId is not provided.
- explode: true
- in: query
- name: ncwAccountIds
- required: false
- schema:
- type: string
- style: form
- - description: "Wallet type, it can be `VAULT_ACCOUNT` or `END_USER_WALLET`"
- explode: true
- in: query
- name: walletType
- required: false
- schema:
- default: VAULT_ACCOUNT
- enum:
- - VAULT_ACCOUNT
- - END_USER_WALLET
- type: string
- style: form
- - description: A comma separated list of NFT IDs. Up to 100 are allowed in a
- single request.
- explode: true
- in: query
- name: ids
- required: false
- schema:
- type: string
- style: form
- - description: A comma separated list of collection IDs. Up to 100 are allowed
- in a single request.
- explode: true
- in: query
- name: collectionIds
- required: false
- schema:
- type: string
- style: form
- - description: Page cursor to fetch
- explode: true
- in: query
- name: pageCursor
- required: false
- schema:
- type: string
- style: form
- - description: Items per page (max 100)
- explode: true
- in: query
- name: pageSize
- required: false
- schema:
- maximum: 100
- minimum: 1
- type: number
- style: form
- - description: "Sort by param, it can be one param or a list of params separated\
- \ by comma"
- explode: true
- in: query
- name: sort
- required: false
- schema:
- items:
- enum:
- - ownershipLastUpdateTime
- - name
- - collection.name
- - blockchainDescriptor
- type: string
- type: array
- style: form
- - description: "Order direction, it can be `ASC` for ascending or `DESC` for\
- \ descending"
- explode: true
- in: query
- name: order
- required: false
- schema:
- default: ASC
- enum:
- - DESC
- - ASC
- type: string
- style: form
- - description: Token ownership status
- explode: true
- in: query
- name: status
- required: false
- schema:
- default: LISTED
- enum:
- - LISTED
- - ARCHIVED
- type: string
- style: form
- - description: "Search owned tokens and their collections. Possible criteria\
- \ for search: token name and id within the contract/collection, collection\
- \ name, blockchain descriptor and name."
- explode: true
- in: query
- name: search
- required: false
- schema:
- maximum: 100
- type: string
- style: form
- - description: Token ownership spam status.
+ - description: "Protocol identifier to filter positions (e.g., ATOM_COS/AXL/CELESTIA}).\
+ \ If omitted, positions across all supported chains are returned."
explode: true
in: query
- name: spam
+ name: chainDescriptor
required: false
schema:
- enum:
- - "true"
- - "false"
- - all
- type: string
+ $ref: "#/components/schemas/ChainDescriptor"
style: form
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/GetOwnershipTokensResponse"
- description: ""
+ $ref: "#/components/schemas/StakingGetAllDelegationsResponse"
+ description: Positions retrieved successfully.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List all owned tokens (paginated)
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: List staking positions
tags:
- - NFTs
+ - Staking
x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.nFTs.getOwnershipTokens(nFTsApiGetOwnershipTokensRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.staking.getAllDelegations(stakingApiGetAllDelegationsRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response\
- \ = fireblocks.nFTs().getOwnershipTokens(blockchainDescriptor, vaultAccountIds,\
- \ ncwId, ncwAccountIds, walletType, ids, collectionIds, pageCursor, pageSize,\
- \ sort, order, status, search, spam);"
+ code: CompletableFuture>> response = fireblocks.staking().getAllDelegations(chainDescriptor);
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.n_f_ts.get_ownership_tokens(blockchain_descriptor,\
- \ vault_account_ids, ncw_id, ncw_account_ids, wallet_type, ids, collection_ids,\
- \ page_cursor, page_size, sort, order, status, search, spam);"
+ code: response = fireblocks.staking.get_all_delegations(chain_descriptor);
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.nFTs.getOwnershipTokens(nFTsApiGetOwnershipTokensRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.staking.getAllDelegations(stakingApiGetAllDelegationsRequest);"
- lang: Java
- source: "CompletableFuture> response\
- \ = fireblocks.nFTs().getOwnershipTokens(blockchainDescriptor, vaultAccountIds,\
- \ ncwId, ncwAccountIds, walletType, ids, collectionIds, pageCursor, pageSize,\
- \ sort, order, status, search, spam);"
+ source: CompletableFuture>> response = fireblocks.staking().getAllDelegations(chainDescriptor);
- lang: Python
- source: "response = fireblocks.n_f_ts.get_ownership_tokens(blockchain_descriptor,\
- \ vault_account_ids, ncw_id, ncw_account_ids, wallet_type, ids, collection_ids,\
- \ page_cursor, page_size, sort, order, status, search, spam);"
+ source: response = fireblocks.staking.get_all_delegations(chain_descriptor);
x-accepts:
- application/json
- put:
- description: |
- Updates all tokens and balances per blockchain and vault account.
- operationId: updateOwnershipTokens
- parameters:
- - description: Blockchain descriptor filter
- explode: true
- in: query
- name: blockchainDescriptor
- required: true
- schema:
- enum:
- - ETH
- - ETH_TEST5
- - ETH_TEST6
- - POLYGON
- - POLYGON_TEST_MUMBAI
- - AMOY_POLYGON_TEST
- - BASECHAIN_ETH
- - BASECHAIN_ETH_TEST5
- - ETHERLINK
- - ETHERLINK_TEST
- - MANTLE
- - MANTLE_TEST
- - GUN_GUNZILLA
- - GUN_GUNZILLA_TEST
- - ETH_SONEIUM
- - SONEIUM_MINATO_TEST
- - IOTX_IOTEX
- - KLAY_KAIA
- - KLAY_KAIA_TEST
- - APECHAIN
- - APECHAIN_TEST
- type: string
- style: form
- - description: Vault account filter
- explode: true
- in: query
- name: vaultAccountId
- required: true
- schema:
- type: string
- style: form
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
- explode: false
- in: header
- name: Idempotency-Key
- required: false
- schema:
- type: string
- style: simple
+ /staking/positions/summary:
+ get:
+ description: "Returns an aggregated cross-vault summary: active/inactive counts,\
+ \ total staked, and total rewards per chain."
+ operationId: getSummary
responses:
- "202":
- description: ""
+ "200":
+ content:
+ application/json:
+ example:
+ active:
+ - chainDescriptor: ETH
+ amount: "64.036604667"
+ - chainDescriptor: SOL
+ amount: "0.077345939"
+ inactive:
+ - chainDescriptor: ETH
+ amount: "0"
+ - chainDescriptor: SOL
+ amount: "0"
+ rewardsAmount:
+ - chainDescriptor: ETH
+ amount: "0.036604667"
+ - chainDescriptor: SOL
+ amount: "0.001345939"
+ totalStaked:
+ - chainDescriptor: ETH
+ amount: "64.036604667"
+ - chainDescriptor: SOL
+ amount: "0.077345939"
+ schema:
+ $ref: "#/components/schemas/DelegationSummary"
+ description: Summary across all vaults returned successfully.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: Refresh vault account tokens
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get positions summary
tags:
- - NFTs
- x-rate-limit-category: write
+ - Staking
+ x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.nFTs.updateOwnershipTokens(nFTsApiUpdateOwnershipTokensRequest);"
+ code: "const response: Promise> =\
+ \ fireblocks.staking.getSummary();"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response = fireblocks.nFTs().updateOwnershipTokens(blockchainDescriptor,\
- \ vaultAccountId, idempotencyKey);"
+ code: CompletableFuture> response = fireblocks.staking().getSummary();
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.n_f_ts.update_ownership_tokens(blockchain_descriptor,\
- \ vault_account_id, idempotency_key);"
+ code: response = fireblocks.staking.get_summary();
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.nFTs.updateOwnershipTokens(nFTsApiUpdateOwnershipTokensRequest);"
+ source: "const response: Promise> =\
+ \ fireblocks.staking.getSummary();"
- lang: Java
- source: "CompletableFuture> response = fireblocks.nFTs().updateOwnershipTokens(blockchainDescriptor,\
- \ vaultAccountId, idempotencyKey);"
+ source: CompletableFuture> response = fireblocks.staking().getSummary();
- lang: Python
- source: "response = fireblocks.n_f_ts.update_ownership_tokens(blockchain_descriptor,\
- \ vault_account_id, idempotency_key);"
+ source: response = fireblocks.staking.get_summary();
x-accepts:
- application/json
- /nfts/ownership/assets:
+ /staking/positions/summary/vaults:
get:
- description: |
- Returns all owned distinct tokens (for your tenant) and their data in your workspace.
- operationId: listOwnedTokens
- parameters:
- - description: Tenant's Non-Custodial Wallet ID
- explode: true
- in: query
- name: ncwId
- required: false
- schema:
- type: string
- style: form
- - description: "Wallet type, it can be `VAULT_ACCOUNT` or `END_USER_WALLET`"
- explode: true
- in: query
- name: walletType
- required: false
- schema:
- default: VAULT_ACCOUNT
- enum:
- - VAULT_ACCOUNT
- - END_USER_WALLET
- type: string
- style: form
- - description: Page cursor to fetch
- explode: true
- in: query
- name: pageCursor
- required: false
- schema:
- type: string
- style: form
- - description: Items per page (max 100)
- explode: true
- in: query
- name: pageSize
- required: false
- schema:
- maximum: 100
- minimum: 1
- type: number
- style: form
- - description: "Sort by param, it can be one param or a list of params separated\
- \ by comma"
- explode: true
- in: query
- name: sort
- required: false
- schema:
- items:
- enum:
- - name
- type: string
- type: array
- style: form
- - description: "Order direction, it can be `ASC` for ascending or `DESC` for\
- \ descending"
- explode: true
- in: query
- name: order
- required: false
- schema:
- default: ASC
- enum:
- - DESC
- - ASC
- type: string
- style: form
- - description: Token ownership status
- explode: true
- in: query
- name: status
- required: false
- schema:
- default: LISTED
- enum:
- - LISTED
- - ARCHIVED
- type: string
- style: form
- - description: Search owned tokens by token name
- explode: true
- in: query
- name: search
- required: false
- schema:
- maximum: 100
- type: string
- style: form
- - description: Token ownership spam status.
- explode: true
- in: query
- name: spam
- required: false
- schema:
- enum:
- - "true"
- - "false"
- - all
- type: string
- style: form
+ description: "Returns per-vault aggregates: status breakdown, total staked,\
+ \ and total rewards per chain."
+ operationId: getSummaryByVault
responses:
"200":
+ content:
+ application/json:
+ example:
+ "0":
+ active:
+ - chainDescriptor: SOL
+ amount: "0.015202376"
+ inactive:
+ - chainDescriptor: SOL
+ amount: "0"
+ rewardsAmount:
+ - chainDescriptor: SOL
+ amount: "0.000202376"
+ totalStaked:
+ - chainDescriptor: SOL
+ amount: "0.015202376"
+ "1":
+ active:
+ - chainDescriptor: ETH
+ amount: "64.036604667"
+ - chainDescriptor: SOL
+ amount: "0.011191566"
+ inactive:
+ - chainDescriptor: ETH
+ amount: "0"
+ - chainDescriptor: SOL
+ amount: "0"
+ rewardsAmount:
+ - chainDescriptor: ETH
+ amount: "0.036604667"
+ - chainDescriptor: SOL
+ amount: "0.000191566"
+ totalStaked:
+ - chainDescriptor: ETH
+ amount: "64.036604667"
+ - chainDescriptor: SOL
+ amount: "0.011191566"
+ schema:
+ $ref: "#/components/schemas/StakingGetSummaryByVaultResponse"
+ description: Per-vault summary returned successfully.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
content:
application/json:
schema:
- $ref: "#/components/schemas/ListOwnedTokensResponse"
- description: ""
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List all distinct owned tokens (paginated)
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get positions summary by vault
tags:
- - NFTs
+ - Staking
x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.nFTs.listOwnedTokens(nFTsApiListOwnedTokensRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.staking.getSummaryByVault();"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response\
- \ = fireblocks.nFTs().listOwnedTokens(ncwId, walletType, pageCursor, pageSize,\
- \ sort, order, status, search, spam);"
+ code: CompletableFuture> response
+ = fireblocks.staking().getSummaryByVault();
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.n_f_ts.list_owned_tokens(ncw_id, wallet_type,\
- \ page_cursor, page_size, sort, order, status, search, spam);"
+ code: response = fireblocks.staking.get_summary_by_vault();
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.nFTs.listOwnedTokens(nFTsApiListOwnedTokensRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.staking.getSummaryByVault();"
- lang: Java
- source: "CompletableFuture> response\
- \ = fireblocks.nFTs().listOwnedTokens(ncwId, walletType, pageCursor, pageSize,\
- \ sort, order, status, search, spam);"
+ source: CompletableFuture> response
+ = fireblocks.staking().getSummaryByVault();
- lang: Python
- source: "response = fireblocks.n_f_ts.list_owned_tokens(ncw_id, wallet_type,\
- \ page_cursor, page_size, sort, order, status, search, spam);"
+ source: response = fireblocks.staking.get_summary_by_vault();
x-accepts:
- application/json
- /nfts/ownership/collections:
+ /staking/positions/{id}:
get:
- description: |
- Returns all collections in your workspace
- operationId: listOwnedCollections
+ description: "Returns full details for a single staking position: amounts, rewards,\
+ \ status, chain, and vault."
+ operationId: getDelegationById
parameters:
- - description: Tenant's Non-Custodial Wallet ID
- explode: true
- in: query
- name: ncwId
- required: false
- schema:
- type: string
- style: form
- - description: "Wallet type, it can be `VAULT_ACCOUNT` or `END_USER_WALLET`"
- explode: true
- in: query
- name: walletType
- required: false
- schema:
- default: VAULT_ACCOUNT
- enum:
- - VAULT_ACCOUNT
- - END_USER_WALLET
- type: string
- style: form
- - description: "Search owned collections. Possible criteria for search: collection\
- \ name, collection contract address."
- explode: true
- in: query
- name: search
- required: false
- schema:
- maximum: 100
- type: string
- style: form
- - description: Page cursor to fetch
- explode: true
- in: query
- name: pageCursor
- required: false
- schema:
- type: string
- style: form
- - description: Items per page (max 100)
- explode: true
- in: query
- name: pageSize
- required: false
- schema:
- maximum: 100
- minimum: 1
- type: number
- style: form
- - description: "Sort by param, it can be one param or a list of params separated\
- \ by comma"
- explode: true
- in: query
- name: sort
- required: false
- schema:
- items:
- enum:
- - name
- type: string
- type: array
- style: form
- - description: "Order direction, it can be `ASC` for ascending or `DESC` for\
- \ descending"
- explode: true
- in: query
- name: order
- required: false
- schema:
- default: ASC
- enum:
- - DESC
- - ASC
- type: string
- style: form
- - description: Token ownership status
- explode: true
- in: query
- name: status
- required: false
+ - description: Unique identifier of the staking position.
+ explode: false
+ in: path
+ name: id
+ required: true
schema:
- default: LISTED
- enum:
- - LISTED
- - ARCHIVED
type: string
- style: form
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/ListOwnedCollectionsResponse"
- description: ""
+ $ref: "#/components/schemas/Delegation"
+ description: Position retrieved successfully.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List owned collections (paginated)
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Get position details
tags:
- - NFTs
+ - Staking
x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise>\
- \ = fireblocks.nFTs.listOwnedCollections(nFTsApiListOwnedCollectionsRequest);"
+ code: "const response: Promise> = fireblocks.staking.getDelegationById(stakingApiGetDelegationByIdRequest);"
name: Fireblocks SDK TypeScript example
- language: java
- code: "CompletableFuture> response\
- \ = fireblocks.nFTs().listOwnedCollections(ncwId, walletType, search,\
- \ pageCursor, pageSize, sort, order, status);"
+ code: CompletableFuture> response = fireblocks.staking().getDelegationById(id);
name: Fireblocks SDK Java example
- language: python
- code: "response = fireblocks.n_f_ts.list_owned_collections(ncw_id, wallet_type,\
- \ search, page_cursor, page_size, sort, order, status);"
+ code: response = fireblocks.staking.get_delegation_by_id(id);
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise>\
- \ = fireblocks.nFTs.listOwnedCollections(nFTsApiListOwnedCollectionsRequest);"
+ source: "const response: Promise> = fireblocks.staking.getDelegationById(stakingApiGetDelegationByIdRequest);"
- lang: Java
- source: "CompletableFuture> response\
- \ = fireblocks.nFTs().listOwnedCollections(ncwId, walletType, search, pageCursor,\
- \ pageSize, sort, order, status);"
+ source: CompletableFuture> response = fireblocks.staking().getDelegationById(id);
- lang: Python
- source: "response = fireblocks.n_f_ts.list_owned_collections(ncw_id, wallet_type,\
- \ search, page_cursor, page_size, sort, order, status);"
+ source: response = fireblocks.staking.get_delegation_by_id(id);
x-accepts:
- application/json
- /nfts/tokens/{id}:
+ /staking/providers:
get:
- description: |
- Returns the requested token data.
- operationId: getNFT
- parameters:
- - description: NFT ID
- example: NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd
- explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
+ description: |-
+ Returns all available staking providers with metadata such as name, ID, and supported chains.
+ Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.
+ operationId: getProviders
responses:
"200":
content:
application/json:
schema:
- $ref: "#/components/schemas/TokenResponse"
- description: ""
+ $ref: "#/components/schemas/StakingGetProvidersResponse"
+ description: Supported providers retrieved successfully.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List token data by ID
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: List staking providers
tags:
- - NFTs
+ - Staking
x-rate-limit-category: query
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise> = fireblocks.nFTs.getNFT(nFTsApiGetNFTRequest);"
+ code: "const response: Promise>\
+ \ = fireblocks.staking.getProviders();"
name: Fireblocks SDK TypeScript example
- language: java
- code: CompletableFuture> response = fireblocks.nFTs().getNFT(id);
+ code: CompletableFuture>> response = fireblocks.staking().getProviders();
name: Fireblocks SDK Java example
- language: python
- code: response = fireblocks.n_f_ts.get_n_f_t(id);
+ code: response = fireblocks.staking.get_providers();
name: Fireblocks SDK Python example
x-codeSamples:
- lang: TypeScript
- source: "const response: Promise> = fireblocks.nFTs.getNFT(nFTsApiGetNFTRequest);"
+ source: "const response: Promise>\
+ \ = fireblocks.staking.getProviders();"
- lang: Java
- source: CompletableFuture> response = fireblocks.nFTs().getNFT(id);
+ source: CompletableFuture>> response = fireblocks.staking().getProviders();
- lang: Python
- source: response = fireblocks.n_f_ts.get_n_f_t(id);
+ source: response = fireblocks.staking.get_providers();
x-accepts:
- application/json
- put:
- description: |
- Updates the latest token metadata.
- operationId: refreshNFTMetadata
+ /staking/providers/{providerId}/approveTermsOfService:
+ post:
+ description: Approves the provider's terms of service. Must be called once before
+ performing any staking operation with this provider.
+ operationId: approveTermsOfServiceByProviderId
parameters:
- - description: Unique ID of the End-User wallet to the API request. Required
- for end-user wallet operations.
- explode: false
- in: header
- name: X-End-User-Wallet-Id
- required: false
- schema:
- format: uuid
- type: string
- style: simple
- - description: NFT ID
- example: NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd
+ - description: Unique identifier of the staking provider.
explode: false
in: path
- name: id
+ name: providerId
required: true
schema:
- type: string
+ $ref: "#/components/schemas/StakingProvider"
style: simple
- description: "A unique identifier for the request. If the request is sent\
\ multiple times with the same idempotency key, the server will return the\
@@ -18591,308 +19398,214 @@ paths:
type: string
style: simple
responses:
- "202":
- description: ""
+ "201":
+ description: Terms of service accepted.
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: Refresh token metadata
- tags:
- - NFTs
- x-rate-limit-category: write
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.nFTs.refreshNFTMetadata(nFTsApiRefreshNFTMetadataRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: "CompletableFuture> response = fireblocks.nFTs().refreshNFTMetadata(id,\
- \ xEndUserWalletId, idempotencyKey);"
- name: Fireblocks SDK Java example
- - language: python
- code: "response = fireblocks.n_f_ts.refresh_n_f_t_metadata(id, x_end_user_wallet_id,\
- \ idempotency_key);"
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.nFTs.refreshNFTMetadata(nFTsApiRefreshNFTMetadataRequest);"
- - lang: Java
- source: "CompletableFuture> response = fireblocks.nFTs().refreshNFTMetadata(id,\
- \ xEndUserWalletId, idempotencyKey);"
- - lang: Python
- source: "response = fireblocks.n_f_ts.refresh_n_f_t_metadata(id, x_end_user_wallet_id,\
- \ idempotency_key);"
- x-accepts:
- - application/json
- /nfts/tokens:
- get:
- description: |
- Returns the requested tokens data.
- operationId: getNFTs
- parameters:
- - description: A comma separated list of NFT IDs. Up to 100 are allowed in a
- single request.
- explode: true
- in: query
- name: ids
- required: true
- schema:
- type: string
- style: form
- - description: Page cursor to fetch
- explode: true
- in: query
- name: pageCursor
- required: false
- schema:
- type: string
- style: form
- - description: Items per page (max 100)
- explode: true
- in: query
- name: pageSize
- required: false
- schema:
- maximum: 100
- minimum: 1
- type: number
- style: form
- - description: "Sort by param, it can be one param or a list of params separated\
- \ by comma"
- explode: true
- in: query
- name: sort
- required: false
- schema:
- items:
- enum:
- - collection.name
- - name
- - blockchainDescriptor
- type: string
- type: array
- style: form
- - description: "Order direction, it can be `ASC` for ascending or `DESC` for\
- \ descending"
- explode: true
- in: query
- name: order
- required: false
- schema:
- default: ASC
- enum:
- - DESC
- - ASC
- type: string
- style: form
- responses:
- "200":
+ "400":
content:
application/json:
schema:
- $ref: "#/components/schemas/GetNFTsResponse"
- description: ""
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Bad request: missing/invalid fields, unsupported amount, or\
+ \ malformed payload."
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: List tokens by IDs
- tags:
- - NFTs
- x-rate-limit-category: query
- x-readme:
- code-samples:
- - language: typescript
- code: "const response: Promise> = fireblocks.nFTs.getNFTs(nFTsApiGetNFTsRequest);"
- name: Fireblocks SDK TypeScript example
- - language: java
- code: "CompletableFuture> response = fireblocks.nFTs().getNFTs(ids,\
- \ pageCursor, pageSize, sort, order);"
- name: Fireblocks SDK Java example
- - language: python
- code: "response = fireblocks.n_f_ts.get_n_f_ts(ids, page_cursor, page_size,\
- \ sort, order);"
- name: Fireblocks SDK Python example
- x-codeSamples:
- - lang: TypeScript
- source: "const response: Promise> = fireblocks.nFTs.getNFTs(nFTsApiGetNFTsRequest);"
- - lang: Java
- source: "CompletableFuture> response = fireblocks.nFTs().getNFTs(ids,\
- \ pageCursor, pageSize, sort, order);"
- - lang: Python
- source: "response = fireblocks.n_f_ts.get_n_f_ts(ids, page_cursor, page_size,\
- \ sort, order);"
- x-accepts:
- - application/json
- /nfts/ownership/tokens/{id}/status:
- put:
- description: |
- Updates token status for a tenant, in all tenant vaults.
- operationId: updateTokenOwnershipStatus
- parameters:
- - description: Unique ID of the End-User wallet to the API request. Required
- for end-user wallet operations.
- explode: false
- in: header
- name: X-End-User-Wallet-Id
- required: false
- schema:
- format: uuid
- type: string
- style: simple
- - description: NFT ID
- example: NFT-abcdefabcdefabcdefabcdefabcdefabcdefabcd
- explode: false
- in: path
- name: id
- required: true
- schema:
- type: string
- style: simple
- - description: "A unique identifier for the request. If the request is sent\
- \ multiple times with the same idempotency key, the server will return the\
- \ same response as the first request. The idempotency key is valid for 24\
- \ hours."
- explode: false
- in: header
- name: Idempotency-Key
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/UpdateTokenOwnershipStatusDto"
- required: true
- responses:
- "200":
- description: ""
+ "403":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Forbidden: insufficient permissions, disabled feature, or\
+ \ restricted provider/validator."
headers:
X-Request-ID:
$ref: "#/components/headers/X-Request-ID"
- summary: Update token ownership status
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Not found: requested resource does not exist (e.g., position,\
+ \ validator, provider, or wallet)."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "429":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: "Rate limit exceeded: slow down and retry later."
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ "500":
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorSchema"
+ description: Internal error while processing the request.
+ headers:
+ X-Request-ID:
+ $ref: "#/components/headers/X-Request-ID"
+ default:
+ $ref: "#/components/responses/Error"
+ summary: Approve provider terms of service
tags:
- - NFTs
+ - Staking
x-rate-limit-category: write
x-readme:
code-samples:
- language: typescript
- code: "const response: Promise