npm
Options
All
  • Public
  • Public/Protected
  • All
Menu

External module core.api

This is the API submodule providing Signum Network API functions

see

composeApi and/or ApiComposer

Index

References

Interfaces

Classes

Functions

References

addAssetTreasuryAccount

addAssetTreasuryAccount:

addCommitment

addCommitment:

broadcastTransaction

broadcastTransaction:

burnAsset

burnAsset:

buyAlias

buyAlias:

buyTopLevelDomain

buyTopLevelDomain:

calculateDistributionFee

calculateDistributionFee:

callContractMethod

callContractMethod:

cancelAskOrder

cancelAskOrder:

cancelBidOrder

cancelBidOrder:

cancelSubscription

cancelSubscription:

createSubscription

createSubscription:

distributeToAssetHolders

distributeToAssetHolders:

generateSendTransactionQRCode

generateSendTransactionQRCode:

generateSendTransactionQRCodeAddress

generateSendTransactionQRCodeAddress:

getAccount

getAccount:

getAccountBalance

getAccountBalance:

getAccountBlockIds

getAccountBlockIds:

getAccountBlocks

getAccountBlocks:

getAccountSubscriptions

getAccountSubscriptions:

getAccountTransactions

getAccountTransactions:

getAliasById

getAliasById:

getAliasByName

getAliasByName:

getAliases

getAliases:

getAliasesOnSale

getAliasesOnSale:

getAllAssets

getAllAssets:

getAllContractIds

getAllContractIds:

getAllContractsByCodeHash

getAllContractsByCodeHash:

getAllTrades

getAllTrades:

getAsset

getAsset:

getAssetHolders

getAssetHolders:

getAssetTrades

getAssetTrades:

getAssetTradesPerAccount

getAssetTradesPerAccount:

getAssetTradesPerAsset

getAssetTradesPerAsset:

getAssetTransfers

getAssetTransfers:

getAssetTransfersPerAccount

getAssetTransfersPerAccount:

getAssetTransfersPerAsset

getAssetTransfersPerAsset:

getAssetsByIssuer

getAssetsByIssuer:

getAssetsByName

getAssetsByName:

getAssetsByOwner

getAssetsByOwner:

getBlockByHeight

getBlockByHeight:

getBlockById

getBlockById:

getBlockByTimestamp

getBlockByTimestamp:

getBlockId

getBlockId:

getBlockchainStatus

getBlockchainStatus:

getBlocks

getBlocks:

getContract

getContract:

getContractMapValuesByFirstKey

getContractMapValuesByFirstKey:

getContractsByAccount

getContractsByAccount:

getDistributionAmountsFromTransaction

getDistributionAmountsFromTransaction:

getMiningInfo

getMiningInfo:

getNetworkInfo

getNetworkInfo:

getOpenAskOrders

getOpenAskOrders:

getOpenAskOrdersPerAccount

getOpenAskOrdersPerAccount:

getOpenAskOrdersPerAsset

getOpenAskOrdersPerAsset:

getOpenBidOrders

getOpenBidOrders:

getOpenBidOrdersPerAccount

getOpenBidOrdersPerAccount:

getOpenBidOrdersPerAsset

getOpenBidOrdersPerAsset:

getPeer

getPeer:

getPeers

getPeers:

getRewardRecipient

getRewardRecipient:

getServerStatus

getServerStatus:

getSingleContractMapValue

getSingleContractMapValue:

getSubscription

getSubscription:

getSubscriptionPayments

getSubscriptionPayments:

getSubscriptionsToAccount

getSubscriptionsToAccount:

getSuggestedFees

getSuggestedFees:

getTime

getTime:

getTopLevelDomains

getTopLevelDomains:

getTradeHistoryPerAccount

getTradeHistoryPerAccount:

getTransaction

getTransaction:

getTransactionByFullHash

getTransactionByFullHash:

getUnconfirmedAccountTransactions

getUnconfirmedAccountTransactions:

getUnconfirmedTransactions

getUnconfirmedTransactions:

issueAsset

issueAsset:

mintAsset

mintAsset:

parseTransactionBytes

parseTransactionBytes:

placeAskOrder

placeAskOrder:

placeBidOrder

placeBidOrder:

publishContract

publishContract:

publishContractByReference

publishContractByReference:

removeCommitment

removeCommitment:

searchAliasesByName

searchAliasesByName:

sellAlias

sellAlias:

sendAmountToMultipleRecipients

sendAmountToMultipleRecipients:

sendAmountToSingleRecipient

sendAmountToSingleRecipient:

sendEncryptedMessage

sendEncryptedMessage:

sendMessage

sendMessage:

sendSameAmountToMultipleRecipients

sendSameAmountToMultipleRecipients:

setAccountInfo

setAccountInfo:

setAlias

setAlias:

setRewardRecipient

setRewardRecipient:

signAndBroadcastTransaction

signAndBroadcastTransaction:

transferAsset

transferAsset:

transferAssetOwnership

transferAssetOwnership:

transferMultipleAssets

transferMultipleAssets:

Functions

composeApi

  • Composes the API, i.e. setup the environment and mounts the API structure with its functions.

    const api = composeApi(new ApiSettings('https://europe.signum.network')), // one of the mainnet nodes

    Note, that this method mounts the entire API, i.e. all available methods. One may also customize the API composition using ApiComposer.

    Parameters

    Returns Api

    The complete API