fireblocks_api

v1.8.0

Published

a year ago

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_httpsfireblocks_com__Visit_our_develop

Downloads

0High
0Medium
0Low

jremmy

fireblocks_api

FireblocksApi - JavaScript client for fireblocks_api 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 - Visit our developer docs: Fireblocks DevPortal This SDK is automatically generated by the Swagger Codegen project:

API version: 1.8.0
Package version: 1.8.0
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install fireblocks_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var FireblocksApi = require('fireblocks_api');

var api = new FireblocksApi.BlockchainsAssetsApi()
var assetId = "assetId_example"; // {String} The asset for which to estimate the fee

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.estimateNetworkFee(assetId, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- FireblocksApi.BlockchainsAssetsApi | estimateNetworkFee | GET /estimate_network_fee | Estimate the required fee for an asset FireblocksApi.BlockchainsAssetsApi | getSupportedAssets | GET /supported_assets | List all asset types supported by Fireblocks FireblocksApi.BlockchainsAssetsApi | registerNewAsset | POST /assets | Register an asset FireblocksApi.BlockchainsAssetsApi | validateAddress | GET /transactions/validate_address/{assetId}/{address} | Validate destination address FireblocksApi.ComplianceApi | getAmlPostScreeningPolicy | GET /screening/aml/post_screening_policy | AML - View Post-Screening Policy FireblocksApi.ComplianceApi | getAmlScreeningConfiguration | GET /screening/aml/policy_configuration | Get AML Screening Policy Configuration FireblocksApi.ComplianceApi | getAmlScreeningPolicy | GET /screening/aml/screening_policy | AML - View Screening Policy FireblocksApi.ComplianceApi | getPostScreeningPolicy | GET /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy FireblocksApi.ComplianceApi | getScreeningConfiguration | GET /screening/travel_rule/policy_configuration | Get Travel Rule Screening Policy Configuration FireblocksApi.ComplianceApi | getScreeningPolicy | GET /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy FireblocksApi.ComplianceApi | getVASPByDID | GET /screening/travel_rule/vasp/{did} | Get VASP details FireblocksApi.ComplianceApi | getVASPs | GET /screening/travel_rule/vasp | Get All VASPs FireblocksApi.ComplianceApi | updateAmlScreeningConfiguration | PUT /screening/aml/policy_configuration | Update AML Configuration FireblocksApi.ComplianceApi | updateScreeningConfiguration | PUT /screening/configurations | Screening Configuration Update FireblocksApi.ComplianceApi | updateTravelRuleConfig | PUT /screening/travel_rule/policy_configuration | Update Travel Rule Configuration FireblocksApi.ComplianceApi | updateVasp | PUT /screening/travel_rule/vasp/update | Add jsonDidKey to VASP details FireblocksApi.ComplianceApi | validateFullTravelRuleTransaction | POST /screening/travel_rule/transaction/validate/full | Validate Full Travel Rule Transaction FireblocksApi.ComplianceApi | validateTravelRuleTransaction | POST /screening/travel_rule/transaction/validate | Validate Travel Rule Transaction FireblocksApi.ContractInteractionsApi | getDeployedContractAbi | GET /contract_interactions/base_asset_id/{assetId}/contract_address/{contractAddress}/functions | Return deployed contract's ABI FireblocksApi.ContractInteractionsApi | readCallFunction | POST /contract_interactions/base_asset_id/{assetId}/contract_address/{contractAddress}/functions/read | Call a read function on a deployed contract FireblocksApi.ContractInteractionsApi | writeCallFunction | POST /contract_interactions/base_asset_id/{assetId}/contract_address/{contractAddress}/functions/write | Call a write function on a deployed contract FireblocksApi.ContractTemplatesApi | deleteContractTemplateById | DELETE /tokenization/templates/{contractTemplateId} | Delete a contract template by id FireblocksApi.ContractTemplatesApi | deployContract | POST /tokenization/templates/{contractTemplateId}/deploy | Deploy contract FireblocksApi.ContractTemplatesApi | getConstructorByContractTemplateId | GET /tokenization/templates/{contractTemplateId}/constructor | Return contract template's constructor FireblocksApi.ContractTemplatesApi | getContractTemplateById | GET /tokenization/templates/{contractTemplateId} | Return contract template by id FireblocksApi.ContractTemplatesApi | getContractTemplates | GET /tokenization/templates | List all contract templates FireblocksApi.ContractTemplatesApi | getFunctionAbiByContractTemplateId | GET /tokenization/templates/{contractTemplateId}/function | Return contract template's function FireblocksApi.ContractTemplatesApi | uploadContractTemplate | POST /tokenization/templates | Upload contract template FireblocksApi.CosignersBetaApi | getApiKey | GET /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key FireblocksApi.CosignersBetaApi | getApiKeys | GET /cosigners/{cosignerId}/api_keys | Get all API keys FireblocksApi.CosignersBetaApi | getCosigner | GET /cosigners/{cosignerId} | Get cosigner FireblocksApi.CosignersBetaApi | getCosigners | GET /cosigners | Get all cosigners FireblocksApi.CosignersBetaApi | renameCosigner | PATCH /cosigners/{cosignerId} | Rename cosigner FireblocksApi.DAppConnectionsApi | create | POST /connections/wc | Create a new dApp connection. FireblocksApi.DAppConnectionsApi | get | GET /connections | List all open dApp connections FireblocksApi.DAppConnectionsApi | remove | DELETE /connections/wc/{id} | Remove an existing dApp connection FireblocksApi.DAppConnectionsApi | submit | PUT /connections/wc/{id} | Respond to a pending dApp connection request FireblocksApi.DeployedContractsApi | getDeployedContractByAddress | GET /tokenization/contracts/{assetId}/{contractAddress} | Return deployed contract data FireblocksApi.DeployedContractsApi | getDeployedContractById | GET /tokenization/contracts/{id} | Return deployed contract data by id FireblocksApi.DeployedContractsApi | getDeployedContracts | GET /tokenization/contracts | List deployed contracts data FireblocksApi.ExchangeAccountsApi | convertAssets | POST /exchange_accounts/{exchangeAccountId}/convert | Convert exchange account funds from the source asset to the destination asset FireblocksApi.ExchangeAccountsApi | getExchangeAccount | GET /exchange_accounts/{exchangeAccountId} | Get a specific exchange account FireblocksApi.ExchangeAccountsApi | getExchangeAccountAsset | GET /exchange_accounts/{exchangeAccountId}/{assetId} | Get an asset for an exchange account FireblocksApi.ExchangeAccountsApi | getExchangeAccounts | GET /exchange_accounts | List exchange accounts FireblocksApi.ExchangeAccountsApi | getPagedExchangeAccounts | GET /exchange_accounts/paged | List connected exchange accounts FireblocksApi.ExchangeAccountsApi | internalTransfer | POST /exchange_accounts/{exchangeAccountId}/internal_transfer | Internal transfer for exchange accounts FireblocksApi.FiatAccountsApi | depositFundsFromLinkedDDA | POST /fiat_accounts/{accountId}/deposit_from_linked_dda | Deposit funds from DDA FireblocksApi.FiatAccountsApi | getFiatAccount | GET /fiat_accounts/{accountId} | Find a specific fiat account FireblocksApi.FiatAccountsApi | getFiatAccounts | GET /fiat_accounts | List fiat accounts FireblocksApi.FiatAccountsApi | redeemFundsToLinkedDDA | POST /fiat_accounts/{accountId}/redeem_to_linked_dda | Redeem funds to DDA FireblocksApi.FireblocksNetworkApi | checkThirdPartyRouting | GET /network_connections/{connectionId}/is_third_party_routing/{assetType} | Retrieve third-party network routing validation by asset type. FireblocksApi.FireblocksNetworkApi | createNetworkConnection | POST /network_connections | Creates a new network connection FireblocksApi.FireblocksNetworkApi | createNetworkId | POST /network_ids | Creates a new Network ID FireblocksApi.FireblocksNetworkApi | deleteNetworkConnection | DELETE /network_connections/{connectionId} | Deletes a network connection by ID FireblocksApi.FireblocksNetworkApi | deleteNetworkId | DELETE /network_ids/{networkId} | Deletes specific network ID. FireblocksApi.FireblocksNetworkApi | getNetwork | GET /network_connections/{connectionId} | Get a network connection FireblocksApi.FireblocksNetworkApi | getNetworkConnections | GET /network_connections | List network connections FireblocksApi.FireblocksNetworkApi | getNetworkId | GET /network_ids/{networkId} | Returns specific network ID. FireblocksApi.FireblocksNetworkApi | getNetworkIds | GET /network_ids | Returns all network IDs, both local IDs and discoverable remote IDs FireblocksApi.FireblocksNetworkApi | getRoutingPolicyAssetGroups | GET /network_ids/routing_policy_asset_groups | Returns all enabled routing policy asset groups FireblocksApi.FireblocksNetworkApi | setNetworkIdDiscoverability | PATCH /network_ids/{networkId}/set_discoverability | Update network ID's discoverability. FireblocksApi.FireblocksNetworkApi | setNetworkIdName | PATCH /network_ids/{networkId}/set_name | Update network ID's name. FireblocksApi.FireblocksNetworkApi | setNetworkIdRoutingPolicy | PATCH /network_ids/{networkId}/set_routing_policy | Update network id routing policy. FireblocksApi.FireblocksNetworkApi | setRoutingPolicy | PATCH /network_connections/{connectionId}/set_routing_policy | Update network connection routing policy. FireblocksApi.GasStationApi | getGasStationByAssetId | GET /gas_station/{assetId} | Get gas station settings by asset FireblocksApi.GasStationApi | getGasStationInfo | GET /gas_station | Get gas station settings FireblocksApi.GasStationApi | updateGasStationConfiguration | PUT /gas_station/configuration | Edit gas station settings FireblocksApi.GasStationApi | updateGasStationConfigurationByAssetId | PUT /gas_station/configuration/{assetId} | Edit gas station settings for an asset FireblocksApi.KeyLinkBetaApi | createSigningKey | POST /key_link/signing_keys | Add a new signing key FireblocksApi.KeyLinkBetaApi | createValidationKey | POST /key_link/validation_keys | Add a new validation key FireblocksApi.KeyLinkBetaApi | disableValidationKey | PATCH /key_link/validation_keys/{keyId} | Disables a validation key FireblocksApi.KeyLinkBetaApi | getSigningKey | GET /key_link/signing_keys/{keyId} | Get a signing key by `keyId` FireblocksApi.KeyLinkBetaApi | getSigningKeysList | GET /key_link/signing_keys | Get list of signing keys FireblocksApi.KeyLinkBetaApi | getValidationKey | GET /key_link/validation_keys/{keyId} | Get a validation key by `keyId` FireblocksApi.KeyLinkBetaApi | getValidationKeysList | GET /key_link/validation_keys | Get list of registered validation keys FireblocksApi.KeyLinkBetaApi | 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` FireblocksApi.KeyLinkBetaApi | updateSigningKey | PATCH /key_link/signing_keys/{keyId} | Modify the signing by Fireblocks provided `keyId` FireblocksApi.NFTsApi | getNFT | GET /nfts/tokens/{id} | List token data by ID FireblocksApi.NFTsApi | getNFTs | GET /nfts/tokens | List tokens by IDs FireblocksApi.NFTsApi | getOwnershipTokens | GET /nfts/ownership/tokens | List all owned tokens (paginated) FireblocksApi.NFTsApi | listOwnedCollections | GET /nfts/ownership/collections | List owned collections (paginated) FireblocksApi.NFTsApi | listOwnedTokens | GET /nfts/ownership/assets | List all distinct owned tokens (paginated) FireblocksApi.NFTsApi | refreshNFTMetadata | PUT /nfts/tokens/{id} | Refresh token metadata FireblocksApi.NFTsApi | updateOwnershipTokens | PUT /nfts/ownership/tokens | Refresh vault account tokens FireblocksApi.NFTsApi | updateTokenOwnershipStatus | PUT /nfts/ownership/tokens/{id}/status | Update token ownership status FireblocksApi.NFTsApi | updateTokensOwnershipSpam | PUT /nfts/ownership/tokens/spam | Update tokens ownership spam property FireblocksApi.NFTsApi | updateTokensOwnershipStatus | PUT /nfts/ownership/tokens/status | Update tokens ownership status FireblocksApi.OffExchangeApi | addOffExchange | POST /off_exchange/add | add collateral FireblocksApi.OffExchangeApi | getOffExchangeCollateralAccounts | GET /off_exchange/collateral_accounts/{mainExchangeAccountId} | Find a specific collateral exchange account FireblocksApi.OffExchangeApi | getOffExchangeSettlementTransactions | GET /off_exchange/settlements/transactions | get settlements transactions from exchange FireblocksApi.OffExchangeApi | removeOffExchange | POST /off_exchange/remove | remove collateral FireblocksApi.OffExchangeApi | settleOffExchangeTrades | POST /off_exchange/settlements/trader | create settlement for a trader FireblocksApi.PaymentsFlowsApi | createFlowConfiguration | POST /payments/workflow_config | Create payment flow configuration FireblocksApi.PaymentsFlowsApi | createFlowExecution | POST /payments/workflow_execution | Create workflow execution FireblocksApi.PaymentsFlowsApi | deleteFlowConfiguration | DELETE /payments/workflow_config/{configId} | Delete workflow configuration FireblocksApi.PaymentsFlowsApi | getFlowConfiguration | GET /payments/workflow_config/{configId} | Retrieve workflow configuration FireblocksApi.PaymentsFlowsApi | getFlowExecution | GET /payments/workflow_execution/{workflowExecutionId} | Get workflow execution details FireblocksApi.PaymentsFlowsApi | launchFlowExecution | POST /payments/workflow_execution/{workflowExecutionId}/actions/execute | Execute the payments workflow FireblocksApi.PaymentsPayoutApi | createPayout | POST /payments/payout | Create a payout instruction set FireblocksApi.PaymentsPayoutApi | executePayoutAction | POST /payments/payout/{payoutId}/actions/execute | Execute a payout instruction set FireblocksApi.PaymentsPayoutApi | getPayout | GET /payments/payout/{payoutId} | Get the status of a payout instruction set FireblocksApi.PolicyEditorBetaApi | getActivePolicy | GET /tap/active_policy | Get the active policy and its validation FireblocksApi.PolicyEditorBetaApi | getDraft | GET /tap/draft | Get the active draft FireblocksApi.PolicyEditorBetaApi | publishDraft | POST /tap/draft | Send publish request for a certain draft id FireblocksApi.PolicyEditorBetaApi | publishPolicyRules | POST /tap/publish | Send publish request for a set of policy rules FireblocksApi.PolicyEditorBetaApi | updateDraft | PUT /tap/draft | Update the draft with a new set of rules FireblocksApi.SmartTransfersApi | cancelTicket | PUT /smart-transfers/{ticketId}/cancel | Cancel Ticket FireblocksApi.SmartTransfersApi | createTicket | POST /smart-transfers | Create Ticket FireblocksApi.SmartTransfersApi | createTicketTerm | POST /smart-transfers/{ticketId}/terms | Create leg (term) FireblocksApi.SmartTransfersApi | findTicketById | GET /smart-transfers/{ticketId} | Search Ticket by ID FireblocksApi.SmartTransfersApi | findTicketTermById | GET /smart-transfers/{ticketId}/terms/{termId} | Get Smart Transfer ticket term FireblocksApi.SmartTransfersApi | fulfillTicket | PUT /smart-transfers/{ticketId}/fulfill | Fund ticket manually FireblocksApi.SmartTransfersApi | fundTicketTerm | PUT /smart-transfers/{ticketId}/terms/{termId}/fund | Define funding source FireblocksApi.SmartTransfersApi | getSmartTransferUserGroups | GET /smart-transfers/settings/user-groups | Get user group FireblocksApi.SmartTransfersApi | manuallyFundTicketTerm | PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund | Manually add term transaction FireblocksApi.SmartTransfersApi | removeTicketTerm | DELETE /smart-transfers/{ticketId}/terms/{termId} | Delete ticket leg (term) FireblocksApi.SmartTransfersApi | searchTickets | GET /smart-transfers | Find Ticket FireblocksApi.SmartTransfersApi | setExternalRefId | PUT /smart-transfers/{ticketId}/external-id | Add external ref. ID FireblocksApi.SmartTransfersApi | setTicketExpiration | PUT /smart-transfers/{ticketId}/expires-in | Set expiration FireblocksApi.SmartTransfersApi | setUserGroups | POST /smart-transfers/settings/user-groups | Set user group FireblocksApi.SmartTransfersApi | submitTicket | PUT /smart-transfers/{ticketId}/submit | Submit ticket FireblocksApi.SmartTransfersApi | updateTicketTerm | PUT /smart-transfers/{ticketId}/terms/{termId} | Update ticket leg (term) FireblocksApi.StakingApi | approveTermsOfServiceByProviderId | POST /staking/providers/{providerId}/approveTermsOfService | Approve staking terms of service FireblocksApi.StakingApi | executeAction | POST /staking/chains/{chainDescriptor}/{actionId} | Execute a staking action FireblocksApi.StakingApi | getAllDelegations | GET /staking/positions | List staking positions details FireblocksApi.StakingApi | getChainInfo | GET /staking/chains/{chainDescriptor}/chainInfo | Get chain-specific staking summary FireblocksApi.StakingApi | getChains | GET /staking/chains | List supported chains for Fireblocks Staking FireblocksApi.StakingApi | getDelegationById | GET /staking/positions/{id} | Get staking position details FireblocksApi.StakingApi | getProviders | GET /staking/providers | List staking providers details FireblocksApi.StakingApi | getSummary | GET /staking/positions/summary | Get staking summary details FireblocksApi.StakingApi | getSummaryByVault | GET /staking/positions/summary/vaults | Get staking summary details by vault FireblocksApi.TokenizationApi | getLinkedToken | GET /tokenization/tokens/{id} | Return a linked token FireblocksApi.TokenizationApi | getLinkedTokens | GET /tokenization/tokens | List all linked tokens FireblocksApi.TokenizationApi | issueNewToken | POST /tokenization/tokens | Issue a new token FireblocksApi.TokenizationApi | link | POST /tokenization/tokens/link | Link a token FireblocksApi.TokenizationApi | unlink | DELETE /tokenization/tokens/{id} | Unlink a token FireblocksApi.TransactionsApi | cancelTransaction | POST /transactions/{txId}/cancel | Cancel a transaction FireblocksApi.TransactionsApi | createTransaction | POST /transactions | Create a new transaction FireblocksApi.TransactionsApi | dropTransaction | POST /transactions/{txId}/drop | Drop ETH (EVM) transaction by ID FireblocksApi.TransactionsApi | estimateTransactionFee | POST /transactions/estimate_fee | Estimate transaction fee FireblocksApi.TransactionsApi | freezeTransaction | POST /transactions/{txId}/freeze | Freeze a transaction FireblocksApi.TransactionsApi | getTransaction | GET /transactions/{txId} | Get a specific transaction by Fireblocks transaction ID FireblocksApi.TransactionsApi | getTransactionByExternalId | GET /transactions/external_tx_id/{externalTxId} | Get a specific transaction by external transaction ID FireblocksApi.TransactionsApi | getTransactions | GET /transactions | Get transaction history FireblocksApi.TransactionsApi | setConfirmationThresholdByTransactionHash | POST /txHash/{txHash}/set_confirmation_threshold | Set confirmation threshold by transaction hash FireblocksApi.TransactionsApi | setTransactionConfirmationThreshold | POST /transactions/{txId}/set_confirmation_threshold | Set confirmation threshold by Fireblocks Transaction ID FireblocksApi.TransactionsApi | unfreezeTransaction | POST /transactions/{txId}/unfreeze | Unfreeze a transaction FireblocksApi.VaultsApi | activateAssetForVaultAccount | POST /vault/accounts/{vaultAccountId}/{assetId}/activate | Activate a wallet in a vault account FireblocksApi.VaultsApi | createLegacyAddress | POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy | Convert a segwit address to legacy format FireblocksApi.VaultsApi | createVaultAccount | POST /vault/accounts | Create a new vault account FireblocksApi.VaultsApi | createVaultAccountAsset | POST /vault/accounts/{vaultAccountId}/{assetId} | Create a new vault wallet FireblocksApi.VaultsApi | createVaultAccountAssetAddress | POST /vault/accounts/{vaultAccountId}/{assetId}/addresses | Create new asset deposit address FireblocksApi.VaultsApi | getAssetWallets | GET /vault/asset_wallets | Get vault wallets (Paginated) FireblocksApi.VaultsApi | getMaxSpendableAmount | GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount | Get the maximum spendable amount in a single transaction. FireblocksApi.VaultsApi | getPagedVaultAccounts | GET /vault/accounts_paged | Get vault accounts (Paginated) FireblocksApi.VaultsApi | getPublicKeyInfo | GET /vault/public_key_info | Get the public key for a derivation path FireblocksApi.VaultsApi | getPublicKeyInfoForAddress | GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info | Get the public key of an asset in a vault account FireblocksApi.VaultsApi | getUnspentInputs | GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs | Get UTXO unspent inputs information FireblocksApi.VaultsApi | getVaultAccount | GET /vault/accounts/{vaultAccountId} | Get a vault account by ID FireblocksApi.VaultsApi | getVaultAccountAsset | GET /vault/accounts/{vaultAccountId}/{assetId} | Get the asset balance for a vault account FireblocksApi.VaultsApi | getVaultAccountAssetAddresses | GET /vault/accounts/{vaultAccountId}/{assetId}/addresses | Get asset addresses FireblocksApi.VaultsApi | getVaultAccountAssetAddressesPaginated | GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated | Get addresses (Paginated) FireblocksApi.VaultsApi | getVaultAccounts | GET /vault/accounts | Get vault accounts FireblocksApi.VaultsApi | getVaultAssets | GET /vault/assets | Get asset balance for chosen assets FireblocksApi.VaultsApi | getVaultBalanceByAsset | GET /vault/assets/{assetId} | Get vault balance by an asset FireblocksApi.VaultsApi | hideVaultAccount | POST /vault/accounts/{vaultAccountId}/hide | Hide a vault account in the console FireblocksApi.VaultsApi | setCustomerRefIdForAddress | POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id | Assign AML customer reference ID FireblocksApi.VaultsApi | setVaultAccountAutoFuel | POST /vault/accounts/{vaultAccountId}/set_auto_fuel | Set auto fueling to on or off FireblocksApi.VaultsApi | setVaultAccountCustomerRefId | POST /vault/accounts/{vaultAccountId}/set_customer_ref_id | Set an AML/KYT customer reference ID for a vault account FireblocksApi.VaultsApi | unhideVaultAccount | POST /vault/accounts/{vaultAccountId}/unhide | Unhide a vault account in the console FireblocksApi.VaultsApi | updateVaultAccount | PUT /vault/accounts/{vaultAccountId} | Rename a vault account FireblocksApi.VaultsApi | updateVaultAccountAssetAddress | PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} | Update address description FireblocksApi.VaultsApi | updateVaultAccountAssetBalance | POST /vault/accounts/{vaultAccountId}/{assetId}/balance | Refresh asset balance data FireblocksApi.WebhooksApi | resendTransactionWebhooks | POST /webhooks/resend/{txId} | Resend webhooks for a transaction by ID FireblocksApi.WebhooksApi | resendWebhooks | POST /webhooks/resend | Resend failed webhooks FireblocksApi.WhitelistedContractsApi | addContractAsset | POST /contracts/{contractId}/{assetId} | Add an Asset to a Whitelisted Contract FireblocksApi.WhitelistedContractsApi | createContract | POST /contracts | Create a Whitelisted Contract FireblocksApi.WhitelistedContractsApi | deleteContract | DELETE /contracts/{contractId} | Delete a Whitelisted Contract FireblocksApi.WhitelistedContractsApi | deleteContractAsset | DELETE /contracts/{contractId}/{assetId} | Delete a Whitelisted Contract's Asset FireblocksApi.WhitelistedContractsApi | getContract | GET /contracts/{contractId} | Find a Specific Whitelisted Contract FireblocksApi.WhitelistedContractsApi | getContractAsset | GET /contracts/{contractId}/{assetId} | Find a whitelisted contract's asset FireblocksApi.WhitelistedContractsApi | getContracts | GET /contracts | List Whitelisted Contracts FireblocksApi.WhitelistedExternalWalletsApi | addAssetToExternalWallet | POST /external_wallets/{walletId}/{assetId} | Add an asset to an external wallet. FireblocksApi.WhitelistedExternalWalletsApi | createExternalWallet | POST /external_wallets | Create an external wallet FireblocksApi.WhitelistedExternalWalletsApi | deleteExternalWallet | DELETE /external_wallets/{walletId} | Delete an external wallet FireblocksApi.WhitelistedExternalWalletsApi | getExternalWallet | GET /external_wallets/{walletId} | Find an external wallet FireblocksApi.WhitelistedExternalWalletsApi | getExternalWalletAsset | GET /external_wallets/{walletId}/{assetId} | Get an asset from an external wallet FireblocksApi.WhitelistedExternalWalletsApi | getExternalWallets | GET /external_wallets | List external wallets FireblocksApi.WhitelistedExternalWalletsApi | removeAssetFromExternalWallet | DELETE /external_wallets/{walletId}/{assetId} | Delete an asset from an external wallet FireblocksApi.WhitelistedExternalWalletsApi | setExternalWalletCustomerRefId | POST /external_wallets/{walletId}/set_customer_ref_id | Set an AML customer reference ID for an external wallet FireblocksApi.WhitelistedInternalWalletsApi | createInternalWallet | POST /internal_wallets | Create an internal wallet FireblocksApi.WhitelistedInternalWalletsApi | createInternalWalletAsset | POST /internal_wallets/{walletId}/{assetId} | Add an asset to an internal wallet FireblocksApi.WhitelistedInternalWalletsApi | deleteInternalWallet | DELETE /internal_wallets/{walletId} | Delete an internal wallet FireblocksApi.WhitelistedInternalWalletsApi | deleteInternalWalletAsset | DELETE /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address from an internal wallet FireblocksApi.WhitelistedInternalWalletsApi | getInternalWallet | GET /internal_wallets/{walletId} | Get assets for internal wallet FireblocksApi.WhitelistedInternalWalletsApi | getInternalWalletAsset | GET /internal_wallets/{walletId}/{assetId} | Get an asset from an internal wallet FireblocksApi.WhitelistedInternalWalletsApi | getInternalWallets | GET /internal_wallets | List internal wallets FireblocksApi.WhitelistedInternalWalletsApi | setCustomerRefIdForInternalWallet | POST /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for an internal wallet FireblocksApi.WorkspaceManagementApi | createApiUser | POST /management/api_users | Create API Key FireblocksApi.WorkspaceManagementApi | createConsoleUser | POST /management/users | Create console user FireblocksApi.WorkspaceManagementApi | createUserGroup | POST /management/user_groups | Create user group FireblocksApi.WorkspaceManagementApi | deleteUserGroup | DELETE /management/user_groups/{groupId} | Delete user group FireblocksApi.WorkspaceManagementApi | freezeWorkspace | POST /workspace/freeze | Freeze FireblocksApi.WorkspaceManagementApi | getApiUsers | GET /management/api_users | Get API Keys FireblocksApi.WorkspaceManagementApi | getAuditLogs | GET /management/audit_logs | Get audit logs FireblocksApi.WorkspaceManagementApi | getAudits | GET /audits | Get audit logs FireblocksApi.WorkspaceManagementApi | getConsoleUsers | GET /management/users | Get console users FireblocksApi.WorkspaceManagementApi | getOtaStatus | GET /management/ota | Returns current One Time Address status FireblocksApi.WorkspaceManagementApi | getUserGroup | GET /management/user_groups/{groupId} | Get user group FireblocksApi.WorkspaceManagementApi | getUserGroups | GET /management/user_groups | List user groups FireblocksApi.WorkspaceManagementApi | getUsers | GET /users | List users FireblocksApi.WorkspaceManagementApi | getWhitelistIpAddresses | GET /management/api_users/{userId}/whitelist_ip_addresses | Get whitelisted ip addresses for an API Key FireblocksApi.WorkspaceManagementApi | getWorkspaceStatus | GET /management/workspace_status | Returns current workspace status FireblocksApi.WorkspaceManagementApi | resetDevice | POST /management/users/{id}/reset_device | Resets device FireblocksApi.WorkspaceManagementApi | setAdminQuorumThreshold | PUT /admin_quorum | Update admin quorum threshold FireblocksApi.WorkspaceManagementApi | setOtaStatus | PUT /management/ota | Enable or disable transactions to One Time Addresses FireblocksApi.WorkspaceManagementApi | updateUserGroup | PUT /management/user_groups/{groupId} | Update user group

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

fireblocks_api

Installation

For Node.js

npm

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models