API Reference Index

This page provides a comprehensive index of all Shamwari Network API endpoints organized by functionality.

API Tags

Based on APITag.java, endpoints are organized into the following categories:

Tag	Display Name	Description
ACCOUNTS	Accounts	Account queries and management
BLOCKS	Blocks	Block and chain information
TRANSACTIONS	Transactions	Transaction operations
TOKENS	Tokens	Token operations
AE	Asset Exchange	Totem creation, transfer, trading
MS	Banking	Monetary System (currencies)
CONTRACTS	Contracts	Smart contract operations
PHASING	Phasing	Phasing and time-locking
SHUFFLING	Shuffling	Privacy shuffles
NETWORK	Networking	Peer discovery and management
DEBUG	Debug	Administrative functions
UTILS	Utils	Utility functions
CERTIFICATE	Certificates	Digital certificate operations
SUBSCRIPTIONS	Subscriptions	Subscription services
AGENT_ATTESTATION	Agents	Agent identity and attestation
MESSAGES	Messages	Encrypted messaging
PAYMENTS	Payments	Currency payment operations
VS	Voting And Polling	Voting operations
ADDONS	Add-ons	Add-on operations
ACCOUNT_CONTROL	Account Ctrl	Account control settings
BETA_CHAIN_CONTROL	Chain Control	Beta chain control
BIP32	Bip32	BIP32 key derivation
CREATE_TRANSACTION	Transaction	Transaction creation
FORGING	Forging	Forging operations
INFO	Server Info	Server information

Endpoint Catalog

Accounts (ACCOUNTS)

Endpoint	HTTP Method	Description
getAccount	GET	Get account details
getAccountId	GET	Get account ID from passphrase
getBalance	GET	Get account balance
getEffectiveBalance	GET	Get effective balance
getGuaranteedBalance	GET	Get guaranteed balance
getAccountLessors	GET	Get account lessors
getAccountPublicKey	GET	Get account public key
getAccountLedger	GET	Get account ledger entries
getAccountLedgerEntry	GET	Get specific ledger entry
getAccountBlocks	GET	Get account blocks
getAccountBlockCount	GET	Get account block count
getAccountBlockIds	GET	Get account block IDs
getAccountProperties	GET	Get account properties
setAccountProperty	POST	Set account property
deleteAccountProperty	POST	Delete account property
getAccountCurrencies	GET	Get account currency holdings
getAccountCurrencyCount	GET	Get currency count
getAccountTotems	GET	Get account totem holdings
getAccountTotemCount	GET	Get totem count
getAccountCurrencyAccounts	GET	Get currency payment accounts
getAccountShufflings	GET	Get account shufflings
getAccountPhasedTransactions	GET	Get phased transactions
getVoterPhasedTransactions	GET	Get voter phased transactions
getLinkedPhasedTransactions	GET	Get linked phased transactions
getAccountPhasedTransactionCount	GET	Count phased transactions
getAccountExchangeRequests	GET	Get exchange requests
getAccountCurrentAskOrderIds	GET	Get current ask order IDs
getAccountCurrentBidOrderIds	GET	Get current bid order IDs
getAccountCurrentAskOrders	GET	Get current ask orders
getAccountCurrentBidOrders	GET	Get current bid orders
getShamwariQKP	GET	Get ShamwariQKP from passphrase
getAccountPermissions	GET	Get account permissions
addAccountPermission	POST	Add permission
removeAccountPermission	POST	Remove permission
registerAccountDomain	POST	Register account domain
deregisterAccountDomain	POST	Deregister account domain
transferAccountDomain	POST	Transfer account domain
getAccountDomain	GET	Get account domain
renewAccountDomain	POST	Renew account domain

Blocks (BLOCKS)

Endpoint	HTTP Method	Description
getBlockchainStatus	GET	Get blockchain status
getBlock	GET	Get block by ID/height
getBlockId	GET	Get block ID
getBlocks	GET	Get blocks by height range
getTime	GET	Get server time
getECBlock	GET	Get EC block
getEpochTime	GET	Get epoch time
getState	GET	Get node state
getNextBlockGenerators	GET	Get forging schedule

Transactions (TRANSACTIONS, CREATE_TRANSACTION)

Endpoint	HTTP Method	Description
sendCoin	POST	Send MTA
sendMessage	POST	Send message
signTransaction	POST	Sign transaction
createTransaction	POST	Create unsigned transaction
broadcastTransaction	POST	Broadcast transaction
getTransaction	GET	Get transaction by ID
getTransactionBytes	GET	Get transaction bytes
parseTransaction	GET	Parse transaction bytes
getUnconfirmedTransactions	GET	Get unconfirmed transactions
getUnconfirmedTransactionIds	GET	Get unconfirmed transaction IDs
getExpectedTransactions	GET	Get expected transactions
calculateFullHash	GET	Calculate transaction hash
calculateFee	GET	Calculate transaction fee
approveTransaction	POST	Approve conditional transaction
getAllBroadcastedTransactions	GET	Get all broadcasted transactions
getAllWaitingTransactions	GET	Get all waiting transactions

Totems / Asset Exchange (AE, CREATE_TRANSACTION)

Endpoint	HTTP Method	Description
issueTotem	POST	Issue new Totem
getTotem	GET	Get Totem by ID
getTotems	GET	Get multiple Totems
getAllTotems	GET	Get all Totems
getTotemIds	GET	Get Totem IDs
getTotemsByIssuer	GET	Get Totems by issuer
getTotemAccounts	GET	Get Totem holders
getTotemAccountCount	GET	Get Totem holder count
getTotemProperties	GET	Get Totem properties
setTotemProperty	POST	Set Totem property
deleteTotemProperty	POST	Delete Totem property
transferTotem	POST	Transfer Totem
increaseTotemShares	POST	Increase Totem shares
dividendPayment	POST	Pay Totem dividends
setPhasingTotemControl	POST	Set phasing control
getPhasingTotemControl	GET	Get phasing control
getTotemPhasedTransactions	GET	Get phased transactions
getTotemHistory	GET	Get Totem history
getTotemTransfers	GET	Get Totem transfers
getTotemDividends	GET	Get Totem dividends
searchTotems	GET	Search Totems
cancelAskOrder	POST	Cancel ask order
cancelBidOrder	POST	Cancel bid order
deleteTotemShares	POST	Delete Totem shares

Totem Approvals

Endpoint	HTTP Method	Description
requestTotemApproval	POST	Request approval
processTotemApproval	POST	Process approval
suspendTotemApproval	POST	Suspend approval
unsuspendTotemApproval	POST	Unsuspend approval
getTotemApprovalRequest	GET	Get approval request
getTotemApprovalStatus	GET	Get approval status
getTotemApprovalComplianceReport	GET	Get compliance report
getTotemApprovalAuditTrail	GET	Get audit trail

Monetary System (MS, AE)

Endpoint	HTTP Method	Description
issueCurrency	POST	Issue new currency
getCurrency	GET	Get currency by ID
getCurrencies	GET	Get currencies
getAllCurrencies	GET	Get all currencies
getCurrenciesByIssuer	GET	Get currencies by issuer
getCurrencyIds	GET	Get currency IDs
getCurrencyAccounts	GET	Get currency payment accounts
getCurrencyAccountCount	GET	Get currency account count
transferCurrency	POST	Transfer currency
currencyBuy	POST	Buy currency on DEX
currencySell	POST	Sell currency on DEX
getAskOrders	GET	Get ask orders
getBidOrders	GET	Get bid orders
getAskOrder	GET	Get ask order
getBidOrder	GET	Get bid order
getAskOrderIds	GET	Get ask order IDs
getBidOrderIds	GET	Get bid order IDs
getAllOpenAskOrders	GET	Get all open ask orders
getAllOpenBidOrders	GET	Get all open bid orders
getAvailableToBuy	GET	Get available to buy
getAvailableToSell	GET	Get available to sell
getBuyOffers	GET	Get buy offers
getSellOffers	GET	Get sell offers
getOffer	GET	Get offer
getExpectedBuyOffers	GET	Get expected buy offers
getExpectedSellOffers	GET	Get expected sell offers
getExchangeRequests	GET	Get exchange requests
getExchanges	GET	Get exchanges
getAllExchanges	GET	Get all exchanges
getLastExchanges	GET	Get last exchanges
getExchangesByOffer	GET	Get exchanges by offer
getExchangesByExchangeRequest	GET	Get exchanges by request
dividendPayment	POST	Pay dividends
currencyMint	POST	Mint currency
getMintingTarget	GET	Get minting target
getTotemDividends	GET	Get Totem dividends
currencyPayment	POST	Make currency payment
getCurrencyPayments	GET	Get currency payments
getExpectedCurrencyPayments	GET	Get expected payments
currencyBulkPayment	POST	Bulk currency payment
setChainTaxRates	POST	Set tax rates
getCurrencyTaxRecords	GET	Get tax records

Contracts (CONTRACTS)

Endpoint	HTTP Method	Description
uploadContractFile	POST	Upload contract file
downloadContractFile	GET	Download contract file
getContractFile	GET	Get contract file details
getContractFiles	GET	Search contract files
getAllContractFiles	GET	Get all contract files
getGroupContractFiles	GET	Get group contract files
getAccountContractFiles	GET	Get account contract files
setContractReference	POST	Link contract to account
deleteContractReference	POST	Delete contract reference
getContractReferences	GET	Get contract references
verifyContract	GET	Verify contract
searchContractFiles	GET	Search contract files

Phasing & Voting (PHASING, VS)

Endpoint	HTTP Method	Description
setPhasingOnlyControl	POST	Set account phasing control
getPhasingOnlyControl	GET	Get account phasing control
getAllPhasingOnlyControls	GET	Get all phasing controls
parsePhasingParams	GET	Parse phasing parameters
getPhasingPoll	GET	Get phasing poll
getPhasingPollVotes	GET	Get poll votes
getPhasingPollVote	GET	Get specific vote
getVoterPhasedTransactions	GET	Get voter phased transactions
getLinkedPhasedTransactions	GET	Get linked transactions
getHashedSecretPhasedTransactions	GET	Get hashed secret phasing

Shuffling (SHUFFLING)

Endpoint	HTTP Method	Description
shufflingCreate	POST	Create shuffling
shufflingRegister	POST	Register for shuffling
shufflingProcess	POST	Process shuffling
shufflingVerify	POST	Verify shuffling
shufflingCancel	POST	Cancel shuffling
getShuffling	GET	Get shuffling info
getShufflingParticipants	GET	Get participants
getAllShufflings	GET	Get all shufflings
getAccountShufflings	GET	Get account shufflings
getAssignedShufflings	GET	Get assigned shufflings
getHoldingShufflings	GET	Get holding shuffles
startShuffler	POST	Start shuffler
stopShuffler	POST	Stop shuffler
getShufflers	GET	Get all shufflers

Payments (PAYMENTS)

Endpoint	HTTP Method	Description
currencyPayment	POST	Make currency payment
getCurrencyPayments	GET	Get currency payments
getExpectedCurrencyPayments	GET	Get expected payments
currencyBulkPayment	POST	Bulk currency payment

Loans (MS)

Endpoint	HTTP Method	Description
loanApplication	POST	Apply for loan
lendCurrency	POST	Lend currency
loanRepayment	POST	Repay loan
rescueLoan	POST	Rescue loan
getLoan	GET	Get loan details
getLoanApplications	GET	Get loan applications
getOverdueLoans	GET	Get overdue loans
getPaidLoans	GET	Get paid loans
getActiveLoans	GET	Get active loans

Subscriptions (SUBSCRIPTIONS)

Endpoint	HTTP Method	Description
createSubscriptionService	POST	Create subscription service
subscriptionPayment	POST	Make subscription payment
updateSubscriptionPlans	POST	Update subscription plans
getSubscriptionServices	GET	Get subscription services
getSubscriptionService	GET	Get specific service
getSubscriptionPayments	GET	Get subscription payments
getAccountSubscriptions	GET	Get account subscriptions
searchSubscriptionServices	GET	Search subscription services

Certificates (CERTIFICATE)

Endpoint	HTTP Method	Description
issueDigitalCertificate	POST	Issue certificate
getDigitalCertificate	GET	Get certificate
getDigitalCertificates	GET	Get all certificates
verifyDigitalCertificate	GET	Verify certificate
downloadCertificate	GET	Download certificate

Agent Attestation (AGENT_ATTESTATION)

Endpoint	HTTP Method	Description
getAgentCertificate	GET	Get agent certificate
getActiveAgentCertificate	GET	Get active certificate
getAgentCertificates	GET	Get all certificates
issueAgentAttestation	POST	Issue attestation
verifyAgentAttestation	GET	Verify attestation
issueAgentToken	POST	Issue agent token
introspectAgentToken	GET	Introspect token
revokeAgentToken	POST	Revoke token
revokeCertificate	POST	Revoke certificate
agentOpenIdConfiguration	GET	Get OpenID config
signData	POST	Sign data

Messages

Endpoint	HTTP Method	Description
sendMessage	POST	Send message
readMessage	GET	Read message

Network (NETWORK)

Endpoint	HTTP Method	Description
getPeers	GET	Get peer list
getPeer	GET	Get specific peer
addPeer	POST	Add peer
blacklistPeer	POST	Blacklist peer
dumpPeers	GET	Dump peer list
managePeersNetworking	POST	Manage networking

Utilities (UTILS)

Endpoint	HTTP Method	Description
encryptTo	POST	Encrypt message
decryptFrom	GET	Decrypt message
generateToken	GET	Generate token
decodeToken	GET	Decode token
generateFileToken	GET	Generate file token
decodeFileToken	GET	Decode file token
decodeQRCode	GET	Decode QR code
encodeQRCode	POST	Encode QR code
hash	GET	Calculate hash
fullHashToId	GET	Convert hash to ID
rsConvert	GET	Convert RS address
hexConvert	GET	Convert hex
longConvert	GET	Convert long
detectMimeType	GET	Detect MIME type
evaluateExpression	POST	Evaluate expression
signData	POST	Sign data
verifySignature	GET	Verify signature
deriveAccountFromSeed	GET	Derive account from seed
deriveKeys	GET	Derive keys
splitSecret	POST	Split secret
combineSecret	GET	Combine secret
processVoucher	POST	Process voucher
calculateFee	GET	Calculate fee
calculateFullHash	GET	Calculate full hash
getTime	GET	Get server time
getEpochTime	GET	Get epoch time
getMyInfo	GET	Get node info
getPlugins	GET	Get plugins
getConfiguration	GET	Get configuration

Debug & Admin (DEBUG)

Endpoint	HTTP Method	Description
setConfiguration	POST	Update configuration
getConfiguration	GET	Get configuration
setLogging	POST	Set logging level
getLog	GET	Get log entries
getStackTraces	GET	Get stack traces
fullReset	POST	Full reset
popOff	POST	Pop blocks
scan	POST	Scan blockchain
shutdown	POST	Shutdown node
luceneReindex	POST	Reindex Lucene
clearUnconfirmedTransactions	POST	Clear pending transactions
requeueUnconfirmedTransactions	POST	Requeue transactions
rebroadcastUnconfirmedTransactions	POST	Rebroadcast transactions
getAllBroadcastedTransactions	GET	Get broadcasted transactions
getAllWaitingTransactions	GET	Get waiting transactions

Chain Control

Endpoint	HTTP Method	Description
setAutonomousAccountControl	POST	Set account control
updateAutonomousAccountControl	POST	Update control
getAutonomousAccountControl	GET	Get account control
setAccountInfo	POST	Set account info
setAccountProperty	POST	Set account property
deleteAccountProperty	POST	Delete account property

Binder & Fees (BINDINGS, FEES)

Endpoint	HTTP Method	Description
startBinder	POST	Start binder
stopBinder	POST	Stop binder
getBinders	GET	Get binders
bindTransactions	POST	Bind transactions
getBinderRates	GET	Get binder rates
getAllBinderRates	GET	Get all rates
blacklistBinder	POST	Blacklist binder
addBindingRule	POST	Add binding rule
getBindingOptions	GET	Get binding options

Forging (FORGING)

Endpoint	HTTP Method	Description
startForging	POST	Start forging
stopForging	POST	Stop forging
getForging	GET	Get forging status

JSON Response Models

Response data is structured according to JSONData.java:

• Account responses: Use JSONData.putAccount(), JSONData.balance()
• Totem responses: Use JSONData.totem(), JSONData.accountTotem()
• Currency responses: Use JSONData.currency(), JSONData.coin()
• Transaction responses: Use JSONData.transaction(), JSONData.unconfirmedTransaction()
• Block responses: Use JSONData.block()
• Shuffling responses: Use JSONData.shuffling(), JSONData.participant()
• Phasing responses: Use JSONData.phasingPoll(), JSONData.phasingPollVote()
• Certificate responses: Use JSONData.certificate()
• Contract responses: Use JSONData.contractFile(), JSONData.contractReference()

Related Documentation

• Features - Feature specifications
• Architecture - System architecture
• Developers - Developer guides