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

addCommitment

addCommitment:

broadcastTransaction

broadcastTransaction:

callContractMethod

callContractMethod:

cancelAskOrder

cancelAskOrder:

cancelBidOrder

cancelBidOrder:

cancelSubscription

cancelSubscription:

createSubscription

createSubscription:

generateSendTransactionQRCode

generateSendTransactionQRCode:

generateSendTransactionQRCodeAddress

generateSendTransactionQRCodeAddress:

getAccount

getAccount:

getAccountBalance

getAccountBalance:

getAccountBlockIds

getAccountBlockIds:

getAccountBlocks

getAccountBlocks:

getAccountSubscriptions

getAccountSubscriptions:

getAccountTransactions

getAccountTransactions:

getAliasById

getAliasById:

getAliasByName

getAliasByName:

getAliases

getAliases:

getAllAssets

getAllAssets:

getAllContractIds

getAllContractIds:

getAsset

getAsset:

getBlockByHeight

getBlockByHeight:

getBlockById

getBlockById:

getBlockByTimestamp

getBlockByTimestamp:

getBlockId

getBlockId:

getBlockchainStatus

getBlockchainStatus:

getBlocks

getBlocks:

getContract

getContract:

getContractsByAccount

getContractsByAccount:

getPeer

getPeer:

getPeers

getPeers:

getRewardRecipient

getRewardRecipient:

getServerStatus

getServerStatus:

getSubscription

getSubscription:

getSubscriptionsToAccount

getSubscriptionsToAccount:

getSuggestedFees

getSuggestedFees:

getTime

getTime:

getTransaction

getTransaction:

getUnconfirmedAccountTransactions

getUnconfirmedAccountTransactions:

getUnconfirmedTransactions

getUnconfirmedTransactions:

issueAsset

issueAsset:

placeAskOrder

placeAskOrder:

placeBidOrder

placeBidOrder:

publishContract

publishContract:

removeCommitment

removeCommitment:

sendAmountToMultipleRecipients

sendAmountToMultipleRecipients:

sendAmountToSingleRecipient

sendAmountToSingleRecipient:

sendEncryptedMessage

sendEncryptedMessage:

sendMessage

sendMessage:

sendSameAmountToMultipleRecipients

sendSameAmountToMultipleRecipients:

setAccountInfo

setAccountInfo:

setAlias

setAlias:

setRewardRecipient

setRewardRecipient:

signAndBroadcastTransaction

signAndBroadcastTransaction:

transferAsset

transferAsset:

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