Skip to content

fireblocks/java-sdk

This branch is 3 commits ahead of, 35 commits behind master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
FireblocksBot
Feb 29, 2024
d00116b · Feb 29, 2024

History

16 Commits
Feb 29, 2024
Aug 24, 2023
Feb 29, 2024
Feb 29, 2024
Aug 24, 2023
Feb 29, 2024
Aug 24, 2023
Aug 24, 2023
Aug 24, 2023
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Feb 29, 2024
Aug 24, 2023
Aug 24, 2023
Feb 29, 2024
Feb 29, 2024

Repository files navigation

Fireblocks Java SDK (Beta)

Warning This package is currently in a beta stage and should be used at your own risk. The provided interfaces might go through backwards-incompatibale changes.

For detailed API documentation please refer to the Fireblocks API Reference.

Building the API client library requires:

  1. Java 11+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.fireblocks.sdk</groupId>
  <artifactId>fireblocks-sdk</artifactId>
  <version>1.6.2</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.fireblocks.sdk:fireblocks-sdk:1.6.2"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/fireblocks-sdk-1.6.2.jar
  • target/lib/*.jar

Getting Started

Initiate Fireblocks Client

ConfigurationOptions configurationOptions = new ConfigurationOptions()
    .basePath(BASE_PATH)
    .apiKey(API_KEY)
    .secretKey(SECRET_KEY);
Fireblocks fireblocks = new Fireblocks(configurationOptions);

Examples

Creating a Vault Account

CreateVaultAccountRequest request = new CreateVaultAccountRequest().name("My Vault Account");
String idempotencyKey = Integer.toString(new Random().nextInt()); // String | 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.
// Async request
CompletableFuture<VaultAccount> response = fireblocks.vaults().createVaultAccount(request, idempotencyKey);
// Waiting for the request
VaultAccount vaultAccount = response.get();

Retrieving Vault Accounts

BigDecimal limit = new BigDecimal(10);
CompletableFuture<VaultAccountsPagedResponse> response = fireblocks.vaults().getPagedVaultAccounts(null, null, null, null, null, null, null, limit);
VaultAccountsPagedResponse vaultAccountsPagedResponse = response.get();

Creating a Transaction

TransactionRequest transactionRequest = new TransactionRequest()
    .operation(TransactionOperation.TRANSFER)
    .source(new TransferPeerPath()
        .type(TransferPeerPath.TypeEnum.VAULT_ACCOUNT)
        .id("0"))
    .destination(new DestinationTransferPeerPath()
        .type(DestinationTransferPeerPath.TypeEnum.VAULT_ACCOUNT)
        .id("1"))
    .amount(new TransactionRequestAmount("0.001"))
    .assetId("ETH_TEST3"); // Ethereum Goerli testnet
    .note("My first Java transaction!");
String idempotencyKey = Integer.toString(new Random().nextInt()); // String | 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.
CompletableFuture<CreateTransactionResponse> response = fireblocks.transactions().createTransaction(transactionRequest, null, idempotencyKey);
CreateTransactionResponse transactionResponse = response.get();
String txId = transactionResponse.getId();

Documentation for API Endpoints

All URIs are relative to https://api.fireblocks.io/v1

Class Method HTTP request Description
AdminQuorumApi setAdminQuorumThreshold PUT /admin_quorum Update admin quorum threshold
AdminQuorumApi setAdminQuorumThresholdWithHttpInfo PUT /admin_quorum Update admin quorum threshold
ApiUserApi createApiUser POST /management/api_users create api user
ApiUserApi createApiUserWithHttpInfo POST /management/api_users create api user
ApiUserApi getApiUsers GET /management/api_users get api users
ApiUserApi getApiUsersWithHttpInfo GET /management/api_users get api users
AssetsApi createAssetsBulk POST /vault/assets/bulk Bulk creation of wallets
AssetsApi createAssetsBulkWithHttpInfo POST /vault/assets/bulk Bulk creation of wallets
AuditLogsApi getAuditLogs GET /management/audit_logs Get audit logs
AuditLogsApi getAuditLogsWithHttpInfo GET /management/audit_logs Get audit logs
AuditLogsApi getAudits GET /audits Get audit logs
AuditLogsApi getAuditsWithHttpInfo GET /audits Get audit logs
BlockchainsAssetsApi getSupportedAssets GET /supported_assets List all asset types supported by Fireblocks
BlockchainsAssetsApi getSupportedAssetsWithHttpInfo GET /supported_assets List all asset types supported by Fireblocks
ComplianceApi getAmlPostScreeningPolicy GET /screening/aml/post_screening_policy AML - View Post-Screening Policy
ComplianceApi getAmlPostScreeningPolicyWithHttpInfo GET /screening/aml/post_screening_policy AML - View Post-Screening Policy
ComplianceApi getAmlScreeningPolicy GET /screening/aml/screening_policy AML - View Screening Policy
ComplianceApi getAmlScreeningPolicyWithHttpInfo GET /screening/aml/screening_policy AML - View Screening Policy
ComplianceApi getPostScreeningPolicy GET /screening/travel_rule/post_screening_policy Travel Rule - View Post-Screening Policy
ComplianceApi getPostScreeningPolicyWithHttpInfo GET /screening/travel_rule/post_screening_policy Travel Rule - View Post-Screening Policy
ComplianceApi getScreeningPolicy GET /screening/travel_rule/screening_policy Travel Rule - View Screening Policy
ComplianceApi getScreeningPolicyWithHttpInfo GET /screening/travel_rule/screening_policy Travel Rule - View Screening Policy
ComplianceApi updateAmlScreeningConfiguration PUT /screening/aml/policy_configuration Update AML Configuration
ComplianceApi updateAmlScreeningConfigurationWithHttpInfo PUT /screening/aml/policy_configuration Update AML Configuration
ComplianceApi updateScreeningConfiguration PUT /screening/configurations Tenant - Screening Configuration
ComplianceApi updateScreeningConfigurationWithHttpInfo PUT /screening/configurations Tenant - Screening Configuration
ComplianceApi updateTravelRuleConfig PUT /screening/travel_rule/policy_configuration Update Travel Rule Configuration
ComplianceApi updateTravelRuleConfigWithHttpInfo PUT /screening/travel_rule/policy_configuration Update Travel Rule Configuration
ComplianceScreeningConfigurationApi getAmlScreeningConfiguration GET /screening/aml/policy_configuration Get AML Screening Policy Configuration
ComplianceScreeningConfigurationApi getAmlScreeningConfigurationWithHttpInfo GET /screening/aml/policy_configuration Get AML Screening Policy Configuration
ComplianceScreeningConfigurationApi getScreeningConfiguration GET /screening/travel_rule/policy_configuration Get Travel Rule Screening Policy Configuration
ComplianceScreeningConfigurationApi getScreeningConfigurationWithHttpInfo GET /screening/travel_rule/policy_configuration Get Travel Rule Screening Policy Configuration
ConsoleUserApi createConsoleUser POST /management/users create console user
ConsoleUserApi createConsoleUserWithHttpInfo POST /management/users create console user
ConsoleUserApi getConsoleUsers GET /management/users get console users
ConsoleUserApi getConsoleUsersWithHttpInfo GET /management/users get console users
ContractsApi addContractAsset POST /contracts/{contractId}/{assetId} Add an asset to a contract
ContractsApi addContractAssetWithHttpInfo POST /contracts/{contractId}/{assetId} Add an asset to a contract
ContractsApi createContract POST /contracts Create a contract
ContractsApi createContractWithHttpInfo POST /contracts Create a contract
ContractsApi deleteContract DELETE /contracts/{contractId} Delete a contract
ContractsApi deleteContractWithHttpInfo DELETE /contracts/{contractId} Delete a contract
ContractsApi deleteContractAsset DELETE /contracts/{contractId}/{assetId} Delete a contract asset
ContractsApi deleteContractAssetWithHttpInfo DELETE /contracts/{contractId}/{assetId} Delete a contract asset
ContractsApi getContract GET /contracts/{contractId} Find a specific contract
ContractsApi getContractWithHttpInfo GET /contracts/{contractId} Find a specific contract
ContractsApi getContractAsset GET /contracts/{contractId}/{assetId} Find a contract asset
ContractsApi getContractAssetWithHttpInfo GET /contracts/{contractId}/{assetId} Find a contract asset
ContractsApi getContracts GET /contracts List contracts
ContractsApi getContractsWithHttpInfo GET /contracts List contracts
DefaultApi cancelJob POST /batch/{jobId}/cancel Cancel a running job
DefaultApi cancelJobWithHttpInfo POST /batch/{jobId}/cancel Cancel a running job
DefaultApi continueJob POST /batch/{jobId}/continue Continue a paused job
DefaultApi continueJobWithHttpInfo POST /batch/{jobId}/continue Continue a paused job
DefaultApi getJob GET /batch/{jobId} Get job details
DefaultApi getJobWithHttpInfo GET /batch/{jobId} Get job details
DefaultApi getJobTasks GET /batch/{jobId}/tasks Return a list of tasks for given job
DefaultApi getJobTasksWithHttpInfo GET /batch/{jobId}/tasks Return a list of tasks for given job
DefaultApi getJobs GET /batch/jobs Return a list of jobs belonging to tenant
DefaultApi getJobsWithHttpInfo GET /batch/jobs Return a list of jobs belonging to tenant
DefaultApi pauseJob POST /batch/{jobId}/pause Pause a job
DefaultApi pauseJobWithHttpInfo POST /batch/{jobId}/pause Pause a job
ExchangeAccountsApi convertAssets POST /exchange_accounts/{exchangeAccountId}/convert Convert exchange account funds from the source asset to the destination asset.
ExchangeAccountsApi convertAssetsWithHttpInfo POST /exchange_accounts/{exchangeAccountId}/convert Convert exchange account funds from the source asset to the destination asset.
ExchangeAccountsApi getExchangeAccount GET /exchange_accounts/{exchangeAccountId} Find a specific exchange account
ExchangeAccountsApi getExchangeAccountWithHttpInfo GET /exchange_accounts/{exchangeAccountId} Find a specific exchange account
ExchangeAccountsApi getExchangeAccountAsset GET /exchange_accounts/{exchangeAccountId}/{assetId} Find an asset for an exchange account
ExchangeAccountsApi getExchangeAccountAssetWithHttpInfo GET /exchange_accounts/{exchangeAccountId}/{assetId} Find an asset for an exchange account
ExchangeAccountsApi getExchangeAccounts GET /exchange_accounts List exchange accounts
ExchangeAccountsApi getExchangeAccountsWithHttpInfo GET /exchange_accounts List exchange accounts
ExchangeAccountsApi getPagedExchangeAccounts GET /exchange_accounts/paged Pagination list exchange accounts
ExchangeAccountsApi getPagedExchangeAccountsWithHttpInfo GET /exchange_accounts/paged Pagination list exchange accounts
ExchangeAccountsApi internalTransfer POST /exchange_accounts/{exchangeAccountId}/internal_transfer Internal transfer for exchange accounts
ExchangeAccountsApi internalTransferWithHttpInfo POST /exchange_accounts/{exchangeAccountId}/internal_transfer Internal transfer for exchange accounts
ExternalWalletsApi addAssetToExternalWallet POST /external_wallets/{walletId}/{assetId} Add an asset to an external wallet.
ExternalWalletsApi addAssetToExternalWalletWithHttpInfo POST /external_wallets/{walletId}/{assetId} Add an asset to an external wallet.
ExternalWalletsApi createExternalWallet POST /external_wallets Create an external wallet
ExternalWalletsApi createExternalWalletWithHttpInfo POST /external_wallets Create an external wallet
ExternalWalletsApi deleteExternalWallet DELETE /external_wallets/{walletId} Delete an external wallet
ExternalWalletsApi deleteExternalWalletWithHttpInfo DELETE /external_wallets/{walletId} Delete an external wallet
ExternalWalletsApi getExternalWallet GET /external_wallets/{walletId} Find an external wallet
ExternalWalletsApi getExternalWalletWithHttpInfo GET /external_wallets/{walletId} Find an external wallet
ExternalWalletsApi getExternalWalletAsset GET /external_wallets/{walletId}/{assetId} Get an asset from an external wallet
ExternalWalletsApi getExternalWalletAssetWithHttpInfo GET /external_wallets/{walletId}/{assetId} Get an asset from an external wallet
ExternalWalletsApi getExternalWallets GET /external_wallets List external wallets
ExternalWalletsApi getExternalWalletsWithHttpInfo GET /external_wallets List external wallets
ExternalWalletsApi removeAssetFromExternalWallet DELETE /external_wallets/{walletId}/{assetId} Delete an asset from an external wallet
ExternalWalletsApi removeAssetFromExternalWalletWithHttpInfo DELETE /external_wallets/{walletId}/{assetId} Delete an asset from an external wallet
ExternalWalletsApi setExternalWalletCustomerRefId POST /external_wallets/{walletId}/set_customer_ref_id Set an AML customer reference ID for an external wallet
ExternalWalletsApi setExternalWalletCustomerRefIdWithHttpInfo POST /external_wallets/{walletId}/set_customer_ref_id Set an AML customer reference ID for an external wallet
FiatAccountsApi depositFundsFromLinkedDDA POST /fiat_accounts/{accountId}/deposit_from_linked_dda Deposit funds from DDA
FiatAccountsApi depositFundsFromLinkedDDAWithHttpInfo POST /fiat_accounts/{accountId}/deposit_from_linked_dda Deposit funds from DDA
FiatAccountsApi getFiatAccount GET /fiat_accounts/{accountId} Find a specific fiat account
FiatAccountsApi getFiatAccountWithHttpInfo GET /fiat_accounts/{accountId} Find a specific fiat account
FiatAccountsApi getFiatAccounts GET /fiat_accounts List fiat accounts
FiatAccountsApi getFiatAccountsWithHttpInfo GET /fiat_accounts List fiat accounts
FiatAccountsApi redeemFundsToLinkedDDA POST /fiat_accounts/{accountId}/redeem_to_linked_dda Redeem funds to DDA
FiatAccountsApi redeemFundsToLinkedDDAWithHttpInfo POST /fiat_accounts/{accountId}/redeem_to_linked_dda Redeem funds to DDA
GasStationsApi getGasStationByAssetId GET /gas_station/{assetId} Get gas station settings by asset
GasStationsApi getGasStationByAssetIdWithHttpInfo GET /gas_station/{assetId} Get gas station settings by asset
GasStationsApi getGasStationInfo GET /gas_station Get gas station settings
GasStationsApi getGasStationInfoWithHttpInfo GET /gas_station Get gas station settings
GasStationsApi updateGasStationConfiguration PUT /gas_station/configuration Edit gas station settings
GasStationsApi updateGasStationConfigurationWithHttpInfo PUT /gas_station/configuration Edit gas station settings
GasStationsApi updateGasStationConfigurationByAssetId PUT /gas_station/configuration/{assetId} Edit gas station settings for an asset
GasStationsApi updateGasStationConfigurationByAssetIdWithHttpInfo PUT /gas_station/configuration/{assetId} Edit gas station settings for an asset
InternalWalletsApi createInternalWallet POST /internal_wallets Create an internal wallet
InternalWalletsApi createInternalWalletWithHttpInfo POST /internal_wallets Create an internal wallet
InternalWalletsApi createInternalWalletAsset POST /internal_wallets/{walletId}/{assetId} Add an asset to an internal wallet
InternalWalletsApi createInternalWalletAssetWithHttpInfo POST /internal_wallets/{walletId}/{assetId} Add an asset to an internal wallet
InternalWalletsApi deleteInternalWallet DELETE /internal_wallets/{walletId} Delete an internal wallet
InternalWalletsApi deleteInternalWalletWithHttpInfo DELETE /internal_wallets/{walletId} Delete an internal wallet
InternalWalletsApi deleteInternalWalletAsset DELETE /internal_wallets/{walletId}/{assetId} Delete a whitelisted address from an internal wallet
InternalWalletsApi deleteInternalWalletAssetWithHttpInfo DELETE /internal_wallets/{walletId}/{assetId} Delete a whitelisted address from an internal wallet
InternalWalletsApi getInternalWallet GET /internal_wallets/{walletId} Get assets for internal wallet
InternalWalletsApi getInternalWalletWithHttpInfo GET /internal_wallets/{walletId} Get assets for internal wallet
InternalWalletsApi getInternalWalletAsset GET /internal_wallets/{walletId}/{assetId} Get an asset from an internal wallet
InternalWalletsApi getInternalWalletAssetWithHttpInfo GET /internal_wallets/{walletId}/{assetId} Get an asset from an internal wallet
InternalWalletsApi getInternalWallets GET /internal_wallets List internal wallets
InternalWalletsApi getInternalWalletsWithHttpInfo GET /internal_wallets List internal wallets
InternalWalletsApi setCustomerRefIdForInternalWallet POST /internal_wallets/{walletId}/set_customer_ref_id Set an AML/KYT customer reference ID for an internal wallet
InternalWalletsApi setCustomerRefIdForInternalWalletWithHttpInfo POST /internal_wallets/{walletId}/set_customer_ref_id Set an AML/KYT customer reference ID for an internal wallet
NetworkConnectionsApi checkThirdPartyRouting GET /network_connections/{connectionId}/is_third_party_routing/{assetType} Retrieve third-party network routing validation by asset type.
NetworkConnectionsApi checkThirdPartyRoutingWithHttpInfo GET /network_connections/{connectionId}/is_third_party_routing/{assetType} Retrieve third-party network routing validation by asset type.
NetworkConnectionsApi createNetworkConnection POST /network_connections Creates a new network connection
NetworkConnectionsApi createNetworkConnectionWithHttpInfo POST /network_connections Creates a new network connection
NetworkConnectionsApi createNetworkId POST /network_ids Creates a new Network ID
NetworkConnectionsApi createNetworkIdWithHttpInfo POST /network_ids Creates a new Network ID
NetworkConnectionsApi deleteNetworkConnection DELETE /network_connections/{connectionId} Deletes a network connection by ID
NetworkConnectionsApi deleteNetworkConnectionWithHttpInfo DELETE /network_connections/{connectionId} Deletes a network connection by ID
NetworkConnectionsApi deleteNetworkId DELETE /network_ids/{networkId} Deletes specific network ID.
NetworkConnectionsApi deleteNetworkIdWithHttpInfo DELETE /network_ids/{networkId} Deletes specific network ID.
NetworkConnectionsApi getNetwork GET /network_connections/{connectionId} Get a network connection
NetworkConnectionsApi getNetworkWithHttpInfo GET /network_connections/{connectionId} Get a network connection
NetworkConnectionsApi getNetworkConnections GET /network_connections List network connections
NetworkConnectionsApi getNetworkConnectionsWithHttpInfo GET /network_connections List network connections
NetworkConnectionsApi getNetworkId GET /network_ids/{networkId} Returns specific network ID.
NetworkConnectionsApi getNetworkIdWithHttpInfo GET /network_ids/{networkId} Returns specific network ID.
NetworkConnectionsApi getNetworkIds GET /network_ids Returns all network IDs, both local IDs and discoverable remote IDs
NetworkConnectionsApi getNetworkIdsWithHttpInfo GET /network_ids Returns all network IDs, both local IDs and discoverable remote IDs
NetworkConnectionsApi setNetworkIdDiscoverability PATCH /network_ids/{networkId}/set_discoverability Update network ID's discoverability.
NetworkConnectionsApi setNetworkIdDiscoverabilityWithHttpInfo PATCH /network_ids/{networkId}/set_discoverability Update network ID's discoverability.
NetworkConnectionsApi setNetworkIdName PATCH /network_ids/{networkId}/set_name Update network ID's name.
NetworkConnectionsApi setNetworkIdNameWithHttpInfo PATCH /network_ids/{networkId}/set_name Update network ID's name.
NetworkConnectionsApi setNetworkIdRoutingPolicy PATCH /network_ids/{networkId}/set_routing_policy Update network id routing policy.
NetworkConnectionsApi setNetworkIdRoutingPolicyWithHttpInfo PATCH /network_ids/{networkId}/set_routing_policy Update network id routing policy.
NetworkConnectionsApi setRoutingPolicy PATCH /network_connections/{connectionId}/set_routing_policy Update network connection routing policy.
NetworkConnectionsApi setRoutingPolicyWithHttpInfo PATCH /network_connections/{connectionId}/set_routing_policy Update network connection routing policy.
NftsApi getNFT GET /nfts/tokens/{id} List token data by ID
NftsApi getNFTWithHttpInfo GET /nfts/tokens/{id} List token data by ID
NftsApi getNFTs GET /nfts/tokens List tokens by IDs
NftsApi getNFTsWithHttpInfo GET /nfts/tokens List tokens by IDs
NftsApi getOwnershipTokens GET /nfts/ownership/tokens List all owned tokens (paginated)
NftsApi getOwnershipTokensWithHttpInfo GET /nfts/ownership/tokens List all owned tokens (paginated)
NftsApi listOwnedCollections GET /nfts/ownership/collections List owned collections (paginated)
NftsApi listOwnedCollectionsWithHttpInfo GET /nfts/ownership/collections List owned collections (paginated)
NftsApi listOwnedTokens GET /nfts/ownership/assets List all distinct owned tokens (paginated)
NftsApi listOwnedTokensWithHttpInfo GET /nfts/ownership/assets List all distinct owned tokens (paginated)
NftsApi refreshNFTMetadata PUT /nfts/tokens/{id} Refresh token metadata
NftsApi refreshNFTMetadataWithHttpInfo PUT /nfts/tokens/{id} Refresh token metadata
NftsApi updateOwnershipTokens PUT /nfts/ownership/tokens Refresh vault account tokens
NftsApi updateOwnershipTokensWithHttpInfo PUT /nfts/ownership/tokens Refresh vault account tokens
NftsApi updateTokenOwnershipStatus PUT /nfts/ownership/tokens/{id}/status Update token ownership status
NftsApi updateTokenOwnershipStatusWithHttpInfo PUT /nfts/ownership/tokens/{id}/status Update token ownership status
NftsApi updateTokensOwnershipSpam PUT /nfts/ownership/tokens/spam Update tokens ownership spam property
NftsApi updateTokensOwnershipSpamWithHttpInfo PUT /nfts/ownership/tokens/spam Update tokens ownership spam property
NftsApi updateTokensOwnershipStatus PUT /nfts/ownership/tokens/status Update tokens ownership status
NftsApi updateTokensOwnershipStatusWithHttpInfo PUT /nfts/ownership/tokens/status Update tokens ownership status
OffExchangesApi addOffExchange POST /off_exchange/add add collateral
OffExchangesApi addOffExchangeWithHttpInfo POST /off_exchange/add add collateral
OffExchangesApi getOffExchangeCollateralAccounts GET /off_exchange/collateral_accounts/{mainExchangeAccountId} Find a specific collateral exchange account
OffExchangesApi getOffExchangeCollateralAccountsWithHttpInfo GET /off_exchange/collateral_accounts/{mainExchangeAccountId} Find a specific collateral exchange account
OffExchangesApi getOffExchangeSettlementTransactions GET /off_exchange/settlements/transactions get settlements transactions from exchange
OffExchangesApi getOffExchangeSettlementTransactionsWithHttpInfo GET /off_exchange/settlements/transactions get settlements transactions from exchange
OffExchangesApi removeOffExchange POST /off_exchange/remove remove collateral
OffExchangesApi removeOffExchangeWithHttpInfo POST /off_exchange/remove remove collateral
OffExchangesApi settleOffExchangeTrades POST /off_exchange/settlements/trader create settlement for a trader
OffExchangesApi settleOffExchangeTradesWithHttpInfo POST /off_exchange/settlements/trader create settlement for a trader
OtaBetaApi getOtaStatus GET /management/ota Returns current OTA status
OtaBetaApi getOtaStatusWithHttpInfo GET /management/ota Returns current OTA status
OtaBetaApi setOtaStatus PUT /management/ota Enable or disable transactions to OTA
OtaBetaApi setOtaStatusWithHttpInfo PUT /management/ota Enable or disable transactions to OTA
PaymentsPayoutApi createPayout POST /payments/payout Create a payout instruction set
PaymentsPayoutApi createPayoutWithHttpInfo POST /payments/payout Create a payout instruction set
PaymentsPayoutApi executePayoutAction POST /payments/payout/{payoutId}/actions/execute Execute a payout instruction set
PaymentsPayoutApi executePayoutActionWithHttpInfo POST /payments/payout/{payoutId}/actions/execute Execute a payout instruction set
PaymentsPayoutApi getPayout GET /payments/payout/{payoutId} Get the status of a payout instruction set
PaymentsPayoutApi getPayoutWithHttpInfo GET /payments/payout/{payoutId} Get the status of a payout instruction set
PolicyEditorBetaApi getActivePolicy GET /tap/active_policy Get the active policy and its validation
PolicyEditorBetaApi getActivePolicyWithHttpInfo GET /tap/active_policy Get the active policy and its validation
PolicyEditorBetaApi getDraft GET /tap/draft Get the active draft
PolicyEditorBetaApi getDraftWithHttpInfo GET /tap/draft Get the active draft
PolicyEditorBetaApi publishDraft POST /tap/draft Send publish request for a certain draft id
PolicyEditorBetaApi publishDraftWithHttpInfo POST /tap/draft Send publish request for a certain draft id
PolicyEditorBetaApi publishPolicyRules POST /tap/publish Send publish request for a set of policy rules
PolicyEditorBetaApi publishPolicyRulesWithHttpInfo POST /tap/publish Send publish request for a set of policy rules
PolicyEditorBetaApi updateDraft PUT /tap/draft Update the draft with a new set of rules
PolicyEditorBetaApi updateDraftWithHttpInfo PUT /tap/draft Update the draft with a new set of rules
ResetDeviceApi resetDevice POST /management/users/{id}/reset_device resets device
ResetDeviceApi resetDeviceWithHttpInfo POST /management/users/{id}/reset_device resets device
SmartTransferApi cancelTicket PUT /smart-transfers/{ticketId}/cancel Cancel Ticket
SmartTransferApi cancelTicketWithHttpInfo PUT /smart-transfers/{ticketId}/cancel Cancel Ticket
SmartTransferApi createTicket POST /smart-transfers Create Ticket
SmartTransferApi createTicketWithHttpInfo POST /smart-transfers Create Ticket
SmartTransferApi createTicketTerm POST /smart-transfers/{ticketId}/terms Create leg (term)
SmartTransferApi createTicketTermWithHttpInfo POST /smart-transfers/{ticketId}/terms Create leg (term)
SmartTransferApi findTicketById GET /smart-transfers/{ticketId} Search Tickets by ID
SmartTransferApi findTicketByIdWithHttpInfo GET /smart-transfers/{ticketId} Search Tickets by ID
SmartTransferApi findTicketTermById GET /smart-transfers/{ticketId}/terms/{termId} Search ticket by leg (term) ID
SmartTransferApi findTicketTermByIdWithHttpInfo GET /smart-transfers/{ticketId}/terms/{termId} Search ticket by leg (term) ID
SmartTransferApi fulfillTicket PUT /smart-transfers/{ticketId}/fulfill Fund ticket manually
SmartTransferApi fulfillTicketWithHttpInfo PUT /smart-transfers/{ticketId}/fulfill Fund ticket manually
SmartTransferApi fundTicketTerm PUT /smart-transfers/{ticketId}/terms/{termId}/fund Define funding source
SmartTransferApi fundTicketTermWithHttpInfo PUT /smart-transfers/{ticketId}/terms/{termId}/fund Define funding source
SmartTransferApi getSmartTransferUserGroups GET /smart-transfers/settings/user-groups Get user group
SmartTransferApi getSmartTransferUserGroupsWithHttpInfo GET /smart-transfers/settings/user-groups Get user group
SmartTransferApi manuallyFundTicketTerm PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund Manually add term transaction
SmartTransferApi manuallyFundTicketTermWithHttpInfo PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund Manually add term transaction
SmartTransferApi removeTicketTerm DELETE /smart-transfers/{ticketId}/terms/{termId} Delete ticket leg (term)
SmartTransferApi removeTicketTermWithHttpInfo DELETE /smart-transfers/{ticketId}/terms/{termId} Delete ticket leg (term)
SmartTransferApi searchTickets GET /smart-transfers Find Ticket
SmartTransferApi searchTicketsWithHttpInfo GET /smart-transfers Find Ticket
SmartTransferApi setExternalRefId PUT /smart-transfers/{ticketId}/external-id Add external ref. ID
SmartTransferApi setExternalRefIdWithHttpInfo PUT /smart-transfers/{ticketId}/external-id Add external ref. ID
SmartTransferApi setTicketExpiration PUT /smart-transfers/{ticketId}/expires-in Set expiration
SmartTransferApi setTicketExpirationWithHttpInfo PUT /smart-transfers/{ticketId}/expires-in Set expiration
SmartTransferApi setUserGroups POST /smart-transfers/settings/user-groups Set user group
SmartTransferApi setUserGroupsWithHttpInfo POST /smart-transfers/settings/user-groups Set user group
SmartTransferApi submitTicket PUT /smart-transfers/{ticketId}/submit Submit ticket
SmartTransferApi submitTicketWithHttpInfo PUT /smart-transfers/{ticketId}/submit Submit ticket
SmartTransferApi updateTicketTerm PUT /smart-transfers/{ticketId}/terms/{termId} Update ticket leg (term)
SmartTransferApi updateTicketTermWithHttpInfo PUT /smart-transfers/{ticketId}/terms/{termId} Update ticket leg (term)
StakingBetaApi approveTermsOfServiceByProviderId POST /staking/providers/{providerId}/approveTermsOfService
StakingBetaApi approveTermsOfServiceByProviderIdWithHttpInfo POST /staking/providers/{providerId}/approveTermsOfService
StakingBetaApi executeAction POST /staking/chains/{chainDescriptor}/{actionId}
StakingBetaApi executeActionWithHttpInfo POST /staking/chains/{chainDescriptor}/{actionId}
StakingBetaApi getAllDelegations GET /staking/positions
StakingBetaApi getAllDelegationsWithHttpInfo GET /staking/positions
StakingBetaApi getChainInfo GET /staking/chains/{chainDescriptor}/chainInfo
StakingBetaApi getChainInfoWithHttpInfo GET /staking/chains/{chainDescriptor}/chainInfo
StakingBetaApi getChains GET /staking/chains
StakingBetaApi getChainsWithHttpInfo GET /staking/chains
StakingBetaApi getDelegationById GET /staking/positions/{id}
StakingBetaApi getDelegationByIdWithHttpInfo GET /staking/positions/{id}
StakingBetaApi getProviders GET /staking/providers
StakingBetaApi getProvidersWithHttpInfo GET /staking/providers
StakingBetaApi getSummary GET /staking/positions/summary
StakingBetaApi getSummaryWithHttpInfo GET /staking/positions/summary
StakingBetaApi getSummaryByVault GET /staking/positions/summary/vaults
StakingBetaApi getSummaryByVaultWithHttpInfo GET /staking/positions/summary/vaults
TransactionsApi cancelTransaction POST /transactions/{txId}/cancel Cancel a transaction
TransactionsApi cancelTransactionWithHttpInfo POST /transactions/{txId}/cancel Cancel a transaction
TransactionsApi createTransaction POST /transactions Create a new transaction
TransactionsApi createTransactionWithHttpInfo POST /transactions Create a new transaction
TransactionsApi dropTransaction POST /transactions/{txId}/drop Drop ETH transaction by ID
TransactionsApi dropTransactionWithHttpInfo POST /transactions/{txId}/drop Drop ETH transaction by ID
TransactionsApi estimateNetworkFee GET /estimate_network_fee Estimate the required fee for an asset
TransactionsApi estimateNetworkFeeWithHttpInfo GET /estimate_network_fee Estimate the required fee for an asset
TransactionsApi estimateTransactionFee POST /transactions/estimate_fee Estimate transaction fee
TransactionsApi estimateTransactionFeeWithHttpInfo POST /transactions/estimate_fee Estimate transaction fee
TransactionsApi freezeTransaction POST /transactions/{txId}/freeze Freeze a transaction
TransactionsApi freezeTransactionWithHttpInfo POST /transactions/{txId}/freeze Freeze a transaction
TransactionsApi getTransaction GET /transactions/{txId} Find a specific transaction by Fireblocks transaction ID
TransactionsApi getTransactionWithHttpInfo GET /transactions/{txId} Find a specific transaction by Fireblocks transaction ID
TransactionsApi getTransactionByExternalId GET /transactions/external_tx_id/{externalTxId} Find a specific transaction by external transaction ID
TransactionsApi getTransactionByExternalIdWithHttpInfo GET /transactions/external_tx_id/{externalTxId} Find a specific transaction by external transaction ID
TransactionsApi getTransactions GET /transactions List transaction history
TransactionsApi getTransactionsWithHttpInfo GET /transactions List transaction history
TransactionsApi setConfirmationThresholdByTransactionHash POST /txHash/{txHash}/set_confirmation_threshold Set confirmation threshold by transaction hash
TransactionsApi setConfirmationThresholdByTransactionHashWithHttpInfo POST /txHash/{txHash}/set_confirmation_threshold Set confirmation threshold by transaction hash
TransactionsApi setTransactionConfirmationThreshold POST /transactions/{txId}/set_confirmation_threshold Set confirmation threshold by transaction ID
TransactionsApi setTransactionConfirmationThresholdWithHttpInfo POST /transactions/{txId}/set_confirmation_threshold Set confirmation threshold by transaction ID
TransactionsApi unfreezeTransaction POST /transactions/{txId}/unfreeze Unfreeze a transaction
TransactionsApi unfreezeTransactionWithHttpInfo POST /transactions/{txId}/unfreeze Unfreeze a transaction
TransactionsApi validateAddress GET /transactions/validate_address/{assetId}/{address} Validate destination address
TransactionsApi validateAddressWithHttpInfo GET /transactions/validate_address/{assetId}/{address} Validate destination address
TravelRuleBetaApi getVASPByDID GET /screening/travel_rule/vasp/{did} Get VASP details
TravelRuleBetaApi getVASPByDIDWithHttpInfo GET /screening/travel_rule/vasp/{did} Get VASP details
TravelRuleBetaApi getVASPs GET /screening/travel_rule/vasp Get All VASPs
TravelRuleBetaApi getVASPsWithHttpInfo GET /screening/travel_rule/vasp Get All VASPs
TravelRuleBetaApi updateVasp PUT /screening/travel_rule/vasp/update Add jsonDidKey to VASP details
TravelRuleBetaApi updateVaspWithHttpInfo PUT /screening/travel_rule/vasp/update Add jsonDidKey to VASP details
TravelRuleBetaApi validateFullTravelRuleTransaction POST /screening/travel_rule/transaction/validate/full Validate Full Travel Rule Transaction
TravelRuleBetaApi validateFullTravelRuleTransactionWithHttpInfo POST /screening/travel_rule/transaction/validate/full Validate Full Travel Rule Transaction
TravelRuleBetaApi validateTravelRuleTransaction POST /screening/travel_rule/transaction/validate Validate Travel Rule Transaction
TravelRuleBetaApi validateTravelRuleTransactionWithHttpInfo POST /screening/travel_rule/transaction/validate Validate Travel Rule Transaction
UserGroupsBetaApi createUserGroup POST /management/user_groups Create user group
UserGroupsBetaApi createUserGroupWithHttpInfo POST /management/user_groups Create user group
UserGroupsBetaApi deleteUserGroup DELETE /management/user_groups/{groupId} Delete user group
UserGroupsBetaApi deleteUserGroupWithHttpInfo DELETE /management/user_groups/{groupId} Delete user group
UserGroupsBetaApi getUserGroup GET /management/user_groups/{groupId} Get user group
UserGroupsBetaApi getUserGroupWithHttpInfo GET /management/user_groups/{groupId} Get user group
UserGroupsBetaApi getUserGroups GET /management/user_groups List user groups
UserGroupsBetaApi getUserGroupsWithHttpInfo GET /management/user_groups List user groups
UserGroupsBetaApi updateUserGroup PUT /management/user_groups/{groupId} Update user group
UserGroupsBetaApi updateUserGroupWithHttpInfo PUT /management/user_groups/{groupId} Update user group
UsersApi getUsers GET /users List users
UsersApi getUsersWithHttpInfo GET /users List users
VaultsApi activateAssetForVaultAccount POST /vault/accounts/{vaultAccountId}/{assetId}/activate Activate a wallet in a vault account
VaultsApi activateAssetForVaultAccountWithHttpInfo POST /vault/accounts/{vaultAccountId}/{assetId}/activate Activate a wallet in a vault account
VaultsApi createLegacyAddress POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy Convert a segwit address to legacy format
VaultsApi createLegacyAddressWithHttpInfo POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy Convert a segwit address to legacy format
VaultsApi createMultipleAccounts POST /vault/accounts/bulk Bulk creation of new vault accounts
VaultsApi createMultipleAccountsWithHttpInfo POST /vault/accounts/bulk Bulk creation of new vault accounts
VaultsApi createVaultAccount POST /vault/accounts Create a new vault account
VaultsApi createVaultAccountWithHttpInfo POST /vault/accounts Create a new vault account
VaultsApi createVaultAccountAsset POST /vault/accounts/{vaultAccountId}/{assetId} Create a new wallet
VaultsApi createVaultAccountAssetWithHttpInfo POST /vault/accounts/{vaultAccountId}/{assetId} Create a new wallet
VaultsApi createVaultAccountAssetAddress POST /vault/accounts/{vaultAccountId}/{assetId}/addresses Create new asset deposit address
VaultsApi createVaultAccountAssetAddressWithHttpInfo POST /vault/accounts/{vaultAccountId}/{assetId}/addresses Create new asset deposit address
VaultsApi getAssetWallets GET /vault/asset_wallets List asset wallets (Paginated)
VaultsApi getAssetWalletsWithHttpInfo GET /vault/asset_wallets List asset wallets (Paginated)
VaultsApi getMaxSpendableAmount GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount Get the maximum spendable amount in a single transaction.
VaultsApi getMaxSpendableAmountWithHttpInfo GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount Get the maximum spendable amount in a single transaction.
VaultsApi getPagedVaultAccounts GET /vault/accounts_paged List vault accounts (Paginated)
VaultsApi getPagedVaultAccountsWithHttpInfo GET /vault/accounts_paged List vault accounts (Paginated)
VaultsApi getPublicKeyInfo GET /vault/public_key_info Get the public key information
VaultsApi getPublicKeyInfoWithHttpInfo GET /vault/public_key_info Get the public key information
VaultsApi getPublicKeyInfoForAddress GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info Get the public key for a vault account
VaultsApi getPublicKeyInfoForAddressWithHttpInfo GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info Get the public key for a vault account
VaultsApi getUnspentInputs GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs Get UTXO unspent inputs information
VaultsApi getUnspentInputsWithHttpInfo GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs Get UTXO unspent inputs information
VaultsApi getVaultAccount GET /vault/accounts/{vaultAccountId} Find a vault account by ID
VaultsApi getVaultAccountWithHttpInfo GET /vault/accounts/{vaultAccountId} Find a vault account by ID
VaultsApi getVaultAccountAsset GET /vault/accounts/{vaultAccountId}/{assetId} Get the asset balance for a vault account
VaultsApi getVaultAccountAssetWithHttpInfo GET /vault/accounts/{vaultAccountId}/{assetId} Get the asset balance for a vault account
VaultsApi getVaultAccountAssetAddresses GET /vault/accounts/{vaultAccountId}/{assetId}/addresses Get asset addresses
VaultsApi getVaultAccountAssetAddressesWithHttpInfo GET /vault/accounts/{vaultAccountId}/{assetId}/addresses Get asset addresses
VaultsApi getVaultAccountAssetAddressesPaginated GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated List addresses (Paginated)
VaultsApi getVaultAccountAssetAddressesPaginatedWithHttpInfo GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated List addresses (Paginated)
VaultsApi getVaultAccounts GET /vault/accounts List vault accounts
VaultsApi getVaultAccountsWithHttpInfo GET /vault/accounts List vault accounts
VaultsApi getVaultAssets GET /vault/assets Get asset balance for chosen assets
VaultsApi getVaultAssetsWithHttpInfo GET /vault/assets Get asset balance for chosen assets
VaultsApi getVaultBalanceByAsset GET /vault/assets/{assetId} Get vault balance by asset
VaultsApi getVaultBalanceByAssetWithHttpInfo GET /vault/assets/{assetId} Get vault balance by asset
VaultsApi hideVaultAccount POST /vault/accounts/{vaultAccountId}/hide Hide a vault account in the console
VaultsApi hideVaultAccountWithHttpInfo POST /vault/accounts/{vaultAccountId}/hide Hide a vault account in the console
VaultsApi setCustomerRefIdForAddress POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id Assign AML customer reference ID
VaultsApi setCustomerRefIdForAddressWithHttpInfo POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id Assign AML customer reference ID
VaultsApi setVaultAccountAutoFuel POST /vault/accounts/{vaultAccountId}/set_auto_fuel Turn autofueling on or off
VaultsApi setVaultAccountAutoFuelWithHttpInfo POST /vault/accounts/{vaultAccountId}/set_auto_fuel Turn autofueling on or off
VaultsApi setVaultAccountCustomerRefId POST /vault/accounts/{vaultAccountId}/set_customer_ref_id Set an AML/KYT customer reference ID for a vault account
VaultsApi setVaultAccountCustomerRefIdWithHttpInfo POST /vault/accounts/{vaultAccountId}/set_customer_ref_id Set an AML/KYT customer reference ID for a vault account
VaultsApi unhideVaultAccount POST /vault/accounts/{vaultAccountId}/unhide Unhide a vault account in the console
VaultsApi unhideVaultAccountWithHttpInfo POST /vault/accounts/{vaultAccountId}/unhide Unhide a vault account in the console
VaultsApi updateVaultAccount PUT /vault/accounts/{vaultAccountId} Rename a vault account
VaultsApi updateVaultAccountWithHttpInfo PUT /vault/accounts/{vaultAccountId} Rename a vault account
VaultsApi updateVaultAccountAssetAddress PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} Update address description
VaultsApi updateVaultAccountAssetAddressWithHttpInfo PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} Update address description
VaultsApi updateVaultAccountAssetBalance POST /vault/accounts/{vaultAccountId}/{assetId}/balance Refresh asset balance data
VaultsApi updateVaultAccountAssetBalanceWithHttpInfo POST /vault/accounts/{vaultAccountId}/{assetId}/balance Refresh asset balance data
Web3ConnectionsApi create POST /connections/wc Create a new Web3 connection.
Web3ConnectionsApi createWithHttpInfo POST /connections/wc Create a new Web3 connection.
Web3ConnectionsApi get GET /connections List all open Web3 connections.
Web3ConnectionsApi getWithHttpInfo GET /connections List all open Web3 connections.
Web3ConnectionsApi remove DELETE /connections/wc/{id} Remove an existing Web3 connection.
Web3ConnectionsApi removeWithHttpInfo DELETE /connections/wc/{id} Remove an existing Web3 connection.
Web3ConnectionsApi submit PUT /connections/wc/{id} Respond to a pending Web3 connection request.
Web3ConnectionsApi submitWithHttpInfo PUT /connections/wc/{id} Respond to a pending Web3 connection request.
WebhooksApi resendTransactionWebhooks POST /webhooks/resend/{txId} Resend failed webhooks for a transaction by ID
WebhooksApi resendTransactionWebhooksWithHttpInfo POST /webhooks/resend/{txId} Resend failed webhooks for a transaction by ID
WebhooksApi resendWebhooks POST /webhooks/resend Resend failed webhooks
WebhooksApi resendWebhooksWithHttpInfo POST /webhooks/resend Resend failed webhooks
WhitelistIpAddressesApi getWhitelistIpAddresses GET /management/api_users/{userId}/whitelist_ip_addresses gets ip addresses
WhitelistIpAddressesApi getWhitelistIpAddressesWithHttpInfo GET /management/api_users/{userId}/whitelist_ip_addresses gets ip addresses
WorkspaceApi freezeWorkspace POST /workspace/freeze Freeze Workspace
WorkspaceApi freezeWorkspaceWithHttpInfo POST /workspace/freeze Freeze Workspace
WorkspaceStatusBetaApi getWorkspaceStatus GET /management/workspace_status Returns current workspace status
WorkspaceStatusBetaApi getWorkspaceStatusWithHttpInfo GET /management/workspace_status Returns current workspace status

Documentation for Models

Author

[email protected]