JSON-RPC API
Omni Core 是 Bitcoin Core 的一个分支，在上面添加了 Omni 协议功能支持作为一个新的功能层。因此，与 API 的交互以与比特币核心相同的方式 (JSON-RPC) 完成，只需使用额外的 RPC 即可利用 Omni 协议功能。
由于所有现有的比特币核心功能都是 Omni Core 固有的，默认情况下 RPC 端口保持与8332比特币核心相同。如果您希望将 Omni Core 与 Bitcoin Core 一起运行（例如，通过单独的数据目录），您可以使用-rpcport指定替代端口号的选项。
可以使用 列出所有可用命令"help"，可以使用 检索有关特定命令的信息"help "。
请注意：本文档可能并不总是最新的。可能存在错误、遗漏或不准确之处。
目录- Transaction creation 交易创建
- omni_send
- omni_sendnewdexorder
- omni_sendupdatedexorder
- omni_sendcanceldexorder
- omni_senddexaccept
- omni_senddexpay
- omni_sendissuancecrowdsale
- omni_sendissuancefixed
- omni_sendissuancemanaged
- omni_sendsto
- omni_sendgrant
- omni_sendrevoke
- omni_sendclosecrowdsale
- omni_sendtrade
- omni_sendcanceltradesbyprice
- omni_sendcanceltradesbypair
- omni_sendcancelalltrades
- omni_sendchangeissuer
- omni_sendall
- omni_sendenablefreezing
- omni_senddisablefreezing
- omni_sendfreeze
- omni_sendunfreeze
- omni_sendadddelegate
- omni_sendremovedelegate
- omni_sendanydata
- omni_sendrawtx
- omni_funded_send
- omni_funded_sendall
- omni_sendnonfungible
- omni_setnonfungibledata
- Data retrieval 数据检索
- omni_getinfo
- omni_getbalance
- omni_getallbalancesforid
- omni_getallbalancesforaddress
- omni_getwalletbalances
- omni_getwalletaddressbalances
- omni_gettransaction
- omni_listtransactions
- omni_listblocktransactions
- omni_listblockstransactions
- omni_listpendingtransactions
- omni_getactivedexsells
- omni_listproperties
- omni_getproperty
- omni_getactivecrowdsales
- omni_getcrowdsale
- omni_getgrants
- omni_getsto
- omni_gettrade
- omni_getorderbook
- omni_gettradehistoryforpair
- omni_gettradehistoryforaddress
- omni_getactivations
- omni_getpayload
- omni_getseedblocks
- omni_getcurrentconsensushash
- omni_getnonfungibletokens
- omni_getnonfungibletokendata
- omni_getnonfungibletokenranges
- Data retrieval (address index) 数据检索(地址索引)
- getaddresstxids
- getaddressdeltas
- getaddressbalance
- getaddressutxos
- getaddressmempool
- getblockhashes
- getspentinfo
- Raw transactions 原始交易
- omni_decodetransaction
- omni_createrawtx_opreturn
- omni_createrawtx_multisig
- omni_createrawtx_input
- omni_createrawtx_reference
- omni_createrawtx_change
- omni_createpayload_simplesend
- omni_createpayload_sendall
- omni_createpayload_dexsell
- omni_createpayload_dexaccept
- omni_createpayload_sto
- omni_createpayload_issuancefixed
- omni_createpayload_issuancecrowdsale
- omni_createpayload_issuancemanaged
- omni_createpayload_closecrowdsale
- omni_createpayload_grant
- omni_createpayload_revoke
- omni_createpayload_changeissuer
- omni_createpayload_trade
- omni_createpayload_canceltradesbyprice
- omni_createpayload_canceltradesbypair
- omni_createpayload_cancelalltrades
- omni_createpayload_enablefreezing
- omni_createpayload_disablefreezing
- omni_createpayload_freeze
- omni_createpayload_unfreeze
- omni_createpayload_adddelegate
- omni_createpayload_removedelegate
- omni_createpayload_anydata
- omni_createpayload_sendnonfungible
- omni_createpayload_setnonfungibledata
- Fee system 手续费制度
- omni_getfeecache
- omni_getfeetrigger
- omni_getfeeshare
- omni_getfeedistribution
- omni_getfeedistributions
- Configuration 配置
- omni_setautocommit
- Deprecated API calls 已弃用的API调用
The RPCs for transaction creation can be used to create and broadcast Omni Protocol transactions.
A hash of the broadcasted transaction is returned as result.
omni_sendCreate and broadcast a simple send transaction.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromtoaddressstringrequiredthe address of the receiverpropertyidnumberrequiredthe identifier of the tokens to sendamountstringrequiredthe amount to sendredeemaddressstringoptionalan address that can spend the transaction dust (sender by default)referenceamountstringoptionala bitcoin amount that is sent to the receiver (minimal by default)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_send" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "100.0"
Place, update or cancel a sell offer on the distributed token/BTC exchange.
Please note: this RPC is replaced by:
- omni_sendnewdexorder
- omni_sendupdatedexorder
- omni_sendcanceldexorder
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send frompropertyidforsalenumberrequiredthe identifier of the tokens to list for saleamountforsalestringrequiredthe amount of tokens to list for saleamountdesiredstringrequiredthe amount of bitcoins desiredpaymentwindownumberrequireda time limit in blocks a buyer has to pay following a successful accepting orderminacceptfeestringrequireda minimum mining fee a buyer has to pay to accept the offeractionnumberrequiredthe action to take (1 for new offers, 2 to update, 3 to cancel)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddexsell" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "1.5" "0.75" 25 "0.0001" 1
Creates a new sell offer on the distributed token/BTC exchange.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send frompropertyidforsalenumberrequiredthe identifier of the tokens to list for saleamountforsalestringrequiredthe amount of tokens to list for saleamountdesiredstringrequiredthe amount of bitcoins desiredpaymentwindownumberrequireda time limit in blocks a buyer has to pay following a successful accepting orderminacceptfeestringrequireda minimum mining fee a buyer has to pay to accept the offer
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendnewdexorder" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "1.5" "0.75" 50 "0.0001"
Updates an existing sell offer on the distributed token/BTC exchange.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send frompropertyidforsalenumberrequiredthe identifier of the tokens to updateamountforsalestringrequiredthe new amount of tokens to list for saleamountdesiredstringrequiredthe new amount of bitcoins desiredpaymentwindownumberrequireda new time limit in blocks a buyer has to pay following a successful accepting orderminacceptfeestringrequireda new minimum mining fee a buyer has to pay to accept the offer
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendupdatedexorder" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "1.0" "1.75" 50 "0.0001"
Cancels existing sell offer on the distributed token/BTC exchange.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send frompropertyidforsalenumberrequiredthe identifier of the tokens to cancel
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcanceldexorder" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1
Create and broadcast an accept offer for the specified token and amount.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromtoaddressstringrequiredthe address of the sellerpropertyidnumberrequiredthe identifier of the token to purchaseamountstringrequiredthe amount to acceptoverridebooleanrequiredoverride minimum accept fee and payment window checks (use with caution!)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddexaccept" \
"35URq1NN3xL6GeRKUP6vzaQVcxoJiiJKd8" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "15.0"
Create and broadcast payment for an accept offer.
Please note: Partial purchases are not possible and the whole accepted amount must be paid.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromtoaddressstringrequiredthe address of the sellerpropertyidnumberrequiredthe identifier of the token to purchaseamountstringrequiredthe Bitcoin amount to send
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddexpay" \
"35URq1NN3xL6GeRKUP6vzaQVcxoJiiJKd8" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 1 "15.0"
Create new tokens as crowdsale.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromecosystemnumberrequiredthe ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem)typenumberrequiredthe type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens)previousidnumberrequiredan identifier of a predecessor token (0 for new crowdsales)categorystringrequireda category for the new tokens (can be "")subcategorystringrequireda subcategory for the new tokens (can be "")namestringrequiredthe name of the new tokens to createurlstringrequiredan URL for further information about the new tokens (can be "")datastringrequireda description for the new tokens (can be "")propertyiddesirednumberrequiredthe identifier of a token eligible to participate in the crowdsaletokensperunitstringrequiredthe amount of tokens granted per unit invested in the crowdsaledeadlinenumberrequiredthe deadline of the crowdsale as Unix timestampearlybonusnumberrequiredan early bird bonus for participants in percent per weekissuerpercentagenumberrequireda percentage of tokens that will be granted to the issuer
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendissuancecrowdsale" \
"3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo" 2 1 0 "Companies" "Bitcoin Mining" \
"Quantum Miner" "" "" 2 "100" 1483228800 30 2
Create new tokens with fixed supply.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromecosystemnumberrequiredthe ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem)typenumberrequiredthe type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens)previousidnumberrequiredan identifier of a predecessor token (0 for new tokens)categorystringrequireda category for the new tokens (can be "")subcategorystringrequireda subcategory for the new tokens (can be "")namestringrequiredthe name of the new tokens to createurlstringrequiredan URL for further information about the new tokens (can be "")datastringrequireda description for the new tokens (can be "")amountstringrequiredthe number of tokens to create
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendissuancefixed" \
"3Ck2kEGLJtZw9ENj2tameMCtS3HB7uRar3" 2 1 0 "Companies" "Bitcoin Mining" \
"Quantum Miner" "" "" "1000000"
Create new tokens with manageable supply.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromecosystemnumberrequiredthe ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem)typenumberrequiredthe type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens, 5 for NFTs)previousidnumberrequiredan identifier of a predecessor token (0 for new tokens)categorystringrequireda category for the new tokens (can be "")subcategorystringrequireda subcategory for the new tokens (can be "")namestringrequiredthe name of the new tokens to createurlstringrequiredan URL for further information about the new tokens (can be "")datastringrequireda description for the new tokens (can be "")
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendissuancemanaged" \
"3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" ""
Create and broadcast a send-to-owners transaction.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send frompropertyidnumberrequiredthe identifier of the tokens to distributeamountstringrequiredthe amount to distributeredeemaddressstringoptionalan address that can spend the transaction dust (sender by default)distributionpropertynumberoptionalthe identifier of the property holders to distribute to
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendsto" \
"32Z3tJccZuqQZ4PhJR2hxHC3tjgjA8cbqz" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 3 "5000"
Issue or grant new units of managed tokens.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromtoaddressstringrequiredthe receiver of the tokens (sender by default, can be "")propertyidnumberrequiredthe identifier of the tokens to grantamountstringrequiredthe amount of tokens to creategrantdatastringoptionalNFT only: data set in all NFTs created in this grant (default: empty)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendgrant" "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" "" 51 "7000"
Revoke units of managed tokens.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send frompropertyidnumberrequiredthe identifier of the tokens to revokeamountstringrequiredthe amount of tokens to revokememostringoptionala text note attached to this transaction (none by default)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendrevoke" "3HsJvhr9qzgRe3ss97b1QHs38rmaLExLcH" "" 51 "100"
Manually close a crowdsale.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address associated with the crowdsale to closepropertyidnumberrequiredthe identifier of the crowdsale to close
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendclosecrowdsale" "3JYd75REX3HXn1vAU83YuGfmiPXW7BpYXo" 70
Place a trade offer on the distributed token exchange.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to trade withpropertyidforsalenumberrequiredthe identifier of the tokens to list for saleamountforsalestringrequiredthe amount of tokens to list for salepropertiddesirednumberrequiredthe identifier of the tokens desired in exchangeamountdesiredstringrequiredthe amount of tokens desired in exchange
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendtrade" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 31 "250.0" 1 "10.0"
Cancel offers on the distributed token exchange with the specified price.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to trade withpropertyidforsalenumberrequiredthe identifier of the tokens listed for saleamountforsalestringrequiredthe amount of tokens to listed for salepropertiddesirednumberrequiredthe identifier of the tokens desired in exchangeamountdesiredstringrequiredthe amount of tokens desired in exchange
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcanceltradesbyprice" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 31 "100.0" 1 "5.0"
Cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to trade withpropertyidforsalenumberrequiredthe identifier of the tokens listed for salepropertiddesirednumberrequiredthe identifier of the tokens desired in exchange
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcanceltradesbypair" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1 31
Cancel all offers on the distributed token exchange.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to trade withecosystemnumberrequiredthe ecosystem of the offers to cancel (1 for main ecosystem, 2 for test ecosystem)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendcancelalltrades" "3BydPiSLPP3DR5cf726hDQ89fpqWLxPKLR" 1
Change the issuer on record of the given tokens.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address associated with the tokenstoaddressstringrequiredthe address to transfer administrative control topropertyidnumberrequiredthe identifier of the tokens
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendchangeissuer" \
"1ARjWDkZ7kT9fwjPrjcQyvbXDkEySzKHwu" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 3
Transfers all available tokens in the given ecosystem to the recipient.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromtoaddressstringrequiredthe address of the receiverecosystemnumberrequiredthe ecosystem of the tokens to send (1 for main ecosystem, 2 for test ecosystem)redeemaddressstringoptionalan address that can spend the transaction dust (sender by default)referenceamountstringoptionala bitcoin amount that is sent to the receiver (minimal by default)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendall" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 2
Enables address freezing for a centrally managed property.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send from (must be issuer of a managed property)propertyidnumberrequiredthe identifier of the tokens
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendenablefreezing" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" 2
Disables address freezing for a centrally managed property.
IMPORTANT NOTE: Disabling freezing for a property will UNFREEZE all frozen addresses for that property!
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send from (must be issuer of a managed property)propertyidnumberrequiredthe identifier of the tokens
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_senddisablefreezing" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" 2
Freeze an address for a centrally managed token.
Note: Only the issuer may freeze tokens, and only if the token is of the managed type with the freezing option enabled.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send from (must be delegate or issuer of a managed property with freezing enabledtoaddressstringrequiredthe address to freezepropertyidnumberrequiredthe identifier of the tokens to freezeamountstringrequiredthe amount to freeze (note: currently unused, frozen addresses cannot transact the property)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendfreeze" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 2 1000
Unfreeze an address for a centrally managed token.
Note: Only the issuer may unfreeze tokens
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send from (must be delegate or issuer of a managed property with freezing enabledtoaddressstringrequiredthe address to unfreezepropertyidnumberrequiredthe identifier of the tokens to unfreezeamountstringrequiredthe amount to unfreeze (note: currently unused
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendunfreeze" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 2 1000
Adds a delegate for the issuance of tokens of a managed property.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe issuer of the tokenspropertyidnumberrequiredthe identifier of the tokensdelegateaddressstringrequiredthe new delegate
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendadddelegate" "12GftZCQ3vwubWmRCmnfZAHdDWXj6ujenx" 21 "14TG9NsTxk2fvH8iGiFcVbquC5NPhHcFjh"
Removes a delegate for the issuance of tokens of a managed property.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe issuer or delegate of the tokenspropertyidnumberrequiredthe identifier of the tokensdelegateaddressstringrequiredthe delegate to be removed
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendremovedelegate" "12GftZCQ3vwubWmRCmnfZAHdDWXj6ujenx" 21 "14TG9NsTxk2fvH8iGiFcVbquC5NPhHcFjh"
Create and broadcast a transaction with an arbitrary payload.
When no receiver is specified, the sender is also considered as receiver.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromdatastringrequiredthe hex-encoded datatoaddressstringoptionalthe optional address of the receiver
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendanydata" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "646578782032303230"
$ omnicore-cli "omni_sendanydata" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "646578782032303230" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs"
Broadcasts a raw Omni Layer transaction.
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send fromrawtransactionstringrequiredthe hex-encoded raw transactionreferenceaddressstringoptionala reference address (none by default)redeemaddressstringoptionalan address that can spend the transaction dust (sender by default)referenceamountstringoptionala bitcoin amount that is sent to the receiver (minimal by default)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendrawtx" \
"1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8" "000000000000000100000000017d7840" \
"1EqTta1Rt8ixAA32DuC29oukbsSWU62qAV"
Creates and sends a funded simple send transaction.
All bitcoins from the sender are consumed and if there are bitcoins missing, they are taken from the specified fee source. Change is sent to the fee source!
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send the tokens fromtoaddressstringrequiredthe address of the receiverpropertyidnumberrequiredthe identifier of the tokens to sendamountstringrequiredthe amount to sendfeeaddressstringrequiredthe address that is used for change and to pay for fees, if needed
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_funded_send" "1DFa5bT6KMEr6ta29QJouainsjaNBsJQhH" \
"15cWrfuvMxyxGst2FisrQcvcpF48x6sXoH" 1 "100.0" \
"15Jhzz4omEXEyFKbdcccJwuVPea5LqsKM1"
Creates and sends a transaction that transfers all available tokens in the given ecosystem to the recipient.
All bitcoins from the sender are consumed and if there are bitcoins missing, they are taken from the specified fee source. Change is sent to the fee source!
Arguments:
NameTypePresenceDescriptionfromaddressstringrequiredthe address to send the tokens fromtoaddressstringrequiredthe address of the receiverecosystemnumberrequiredthe ecosystem of the tokens to send (1 for main ecosystem, 2 for test ecosystem)feeaddressstringrequiredthe address that is used for change and to pay for fees, if needed
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_funded_sendall" "1DFa5bT6KMEr6ta29QJouainsjaNBsJQhH" \
"15cWrfuvMxyxGst2FisrQcvcpF48x6sXoH" 1 "15Jhzz4omEXEyFKbdcccJwuVPea5LqsKM1"
Create and broadcast a non-fungible send transaction.
Arguments:
NameTypePresenceDescriptionaddressstringrequiredthe address to send fromtoaddressstringrequiredthe address of the receiverpropertyidnumberrequiredthe identifier of the tokens to sendtokenstartnumberrequiredthe first token in the range to sendtokenendnumberrequiredthe last token in the range to sendredeemaddressstringoptionalan address that can spend the transaction dust (sender by default)referenceamountstringoptionala bitcoin amount that is sent to the receiver (minimal by default)
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_sendnonfungible" "3M9qvHKtgARhqcMtM5cRT9VaiDJ5PSfQGY" "37FaKponF7zqoMLUjEiko25pDiuVH5YLEa" 70 1 1000
Sets either the issuer or holder data field in a non-fungible tokem. Holder data can only be updated by the token owner and issuer data can only be updated by address that created the tokens.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe property identifiertokenstartnumberrequiredthe first token in the range to set data ontokenendnumberrequiredthe last token in the range to set data onissuerbooleanrequiredif true issuer data set, otherwise holder data setdatastringrequireddata set as in either issuer or holder fields
Result:
"hash" // (string) the hex-encoded transaction hash
Example:
$ omnicore-cli "omni_setnonfungibledata" 70 50 60 true "string data"
The RPCs for data retrieval can be used to get information about the state of the Omni ecosystem.
omni_getinfoReturns various state information of the client and protocol.
Arguments:
None
Result:
Result:
{
"omnicoreversion_int" : xxxxxxx, // (number) client version as integer
"omnicoreversion" : "x.x.x.x-xxx", // (string) client version
"mastercoreversion" : "x.x.x.x-xxx", // (string) client version (DEPRECATED)
"bitcoincoreversion" : "x.x.x", // (string) Bitcoin Core version
"commitinfo" : "xxxxxxx", // (string) build commit identifier
"block" : nnnnnn, // (number) index of the last processed block
"blocktime" : nnnnnnnnnn, // (number) timestamp of the last processed block
"blocktransactions" : nnnn, // (number) Omni transactions found in the last processed block
"totaltransactions" : nnnnnnnn, // (number) Omni transactions processed in total
"alerts" : [ // (array of JSON objects) active protocol alert (if any)
{
"alerttype" : n // (number) alert type as integer
"alerttype" : "xxx" // (string) alert type (can be "alertexpiringbyblock", "alertexpiringbyblocktime", "alertexpiringbyclientversion" or "error")
"alertexpiry" : "nnnnnnnnnn" // (string) expiration criteria (can refer to block height, timestamp or client version)
"alertmessage" : "xxx" // (string) information about the alert
},
...
]
}
Example:
$ omnicore-cli "omni_getinfo"
Returns the token balance for a given address and property.
Arguments:
NameTypePresenceDescriptionaddressstringrequiredthe addresspropertyidnumberrequiredthe property identifier
Result:
{
"balance" : "n.nnnnnnnn", // (string) the available balance of the address
"reserved" : "n.nnnnnnnn", // (string) the amount reserved by sell offers and accepts
"frozen" : "n.nnnnnnnn" // (string) the amount frozen by the issuer (applies to managed properties only)
}
Example:
$ omnicore-cli "omni_getbalance", "1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P" 1
Returns a list of token balances for a given currency or property identifier.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe property identifier
Result:
[ // (array of JSON objects)
{
"address" : "address", // (string) the address
"balance" : "n.nnnnnnnn", // (string) the available balance of the address
"reserved" : "n.nnnnnnnn", // (string) the amount reserved by sell offers and accepts
"frozen" : "n.nnnnnnnn" // (string) the amount frozen by the issuer (applies to managed properties only)
},
...
]
Example:
$ omnicore-cli "omni_getallbalancesforid" 1
Returns a list of all token balances for a given address.
Arguments:
NameTypePresenceDescriptionaddressstringrequiredthe address
Result:
[ // (array of JSON objects)
{
"propertyid" : n, // (number) the property identifier
"name" : "name", // (string) the name of the property
"balance" : "n.nnnnnnnn", // (string) the available balance of the address
"reserved" : "n.nnnnnnnn", // (string) the amount reserved by sell offers and accepts
"frozen" : "n.nnnnnnnn" // (string) the amount frozen by the issuer (applies to managed properties only)
},
...
]
Example:
$ omnicore-cli "omni_getallbalancesforaddress" "1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P"
Returns a list of the total token balances of the whole wallet.
Arguments:
NameTypePresenceDescriptionincludewatchonlybooleanoptionalinclude balances of watchonly addresses (default: false)
Result:
[ // (array of JSON objects)
{
"propertyid" : n, // (number) the property identifier
"name" : "name", // (string) the name of the token
"balance" : "n.nnnnnnnn", // (string) the total available balance for the token
"reserved" : "n.nnnnnnnn" // (string) the total amount reserved by sell offers and accepts
"frozen" : "n.nnnnnnnn" // (string) the total amount frozen by the issuer (applies to managed properties only)
},
...
]
Example:
$ omnicore-cli "omni_getwalletbalances"
Returns a list of all token balances for every wallet address.
Arguments:
NameTypePresenceDescriptionincludewatchonlybooleanoptionalinclude balances of watchonly addresses (default: false)
Result:
[ // (array of JSON objects)
{
"address" : "address", // (string) the address linked to the following balances
"balances" :
[
{
"propertyid" : n, // (number) the property identifier
"name" : "name", // (string) the name of the token
"balance" : "n.nnnnnnnn", // (string) the available balance for the token
"reserved" : "n.nnnnnnnn" // (string) the amount reserved by sell offers and accepts
"frozen" : "n.nnnnnnnn" // (string) the amount frozen by the issuer (applies to managed properties only)
},
...
]
},
...
]
Example:
$ omnicore-cli "omni_getwalletaddressbalances"
Get detailed information about an Omni transaction.
Arguments:
NameTypePresenceDescriptiontxidstringrequiredthe hash of the transaction to lookup
Result:
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", // (string) the Bitcoin address of the sender
"referenceaddress" : "address", // (string) a Bitcoin address used as reference (if any)
"ismine" : true|false, // (boolean) whether the transaction involes an address in the wallet
"confirmations" : nnnnnnnnnn, // (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, // (number) the timestamp of the block that contains the transaction
"valid" : true|false, // (boolean) whether the transaction is valid
"positioninblock" : n, // (number) the position (index) of the transaction within the block
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
[...] // (mixed) other transaction type specific properties
}
Example:
$ omnicore-cli "omni_gettransaction" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
List wallet transactions, optionally filtered by an address and block boundaries.
Arguments:
NameTypePresenceDescriptiontxidstringoptionaladdress filter (default: "*")countnumberoptionalshow at most n transactions (default: 10)skipnumberoptionalskip the first n transactions (default: 0)startblocknumberoptionalfirst block to begin the search (default: 0)endblocknumberoptionallast block to include in the search (default: 999999999)
Result:
[ // (array of JSON objects)
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", // (string) the Bitcoin address of the sender
"referenceaddress" : "address", // (string) a Bitcoin address used as reference (if any)
"ismine" : true|false, // (boolean) whether the transaction involves an address in the wallet
"confirmations" : nnnnnnnnnn, // (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, // (number) the timestamp of the block that contains the transaction
"valid" : true|false, // (boolean) whether the transaction is valid
"positioninblock" : n, // (number) the position (index) of the transaction within the block
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
[...] // (mixed) other transaction type specific properties
},
...
]
Example:
$ omnicore-cli "omni_listtransactions"
Lists all Omni transactions in a block.
Arguments:
NameTypePresenceDescriptionindexnumberrequiredthe block height or block index
Result:
[ // (array of string)
"hash", // (string) the hash of the transaction
...
]
Example:
$ omnicore-cli "omni_listblocktransactions" 279007
Lists all Omni transactions in a given range of blocks.
Note: the list of transactions is unordered and can contain invalid transactions!
Arguments:
NameTypePresenceDescriptionfirstblocknumberrequiredthe index of the first block to considerlastblocknumberrequiredthe index of the last block to consider
Result:
[ // (array of string)
"hash", // (string) the hash of the transaction
...
]
Example:
$ omnicore-cli "omni_omni_listblocktransactions" 279007 300000
Returns a list of unconfirmed Omni transactions, pending in the memory pool.
Note: the validity of pending transactions is uncertain, and the state of the memory pool may change at any moment. It is recommended to check transactions after confirmation, and pending transactions should be considered as invalid.
Arguments:
NameTypePresenceDescriptionaddressstringoptionalfilter results by address (default: "" for no filter)
Result:
[ // (array of JSON objects)
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", // (string) the Bitcoin address of the sender
"referenceaddress" : "address", // (string) a Bitcoin address used as reference (if any)
"ismine" : true|false, // (boolean) whether the transaction involes an address in the wallet
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
[...] // (mixed) other transaction type specific properties
},
...
]
Example:
$ omnicore-cli "omni_listpendingtransactions"
Returns currently active offers on the distributed exchange.
Arguments:
NameTypePresenceDescriptionaddressstringoptionaladdress filter (default: include any)
Result:
[ // (array of JSON objects)
{
"txid" : "hash", // (string) the hash of the transaction of this offer
"propertyid" : n, // (number) the identifier of the tokens for sale
"seller" : "address", // (string) the Bitcoin address of the seller
"amountavailable" : "n.nnnnnnnn", // (string) the number of tokens still listed for sale and currently available
"bitcoindesired" : "n.nnnnnnnn", // (string) the number of bitcoins desired in exchange
"unitprice" : "n.nnnnnnnn" , // (string) the unit price (BTC/token)
"timelimit" : nn, // (number) the time limit in blocks a buyer has to pay following a successful accept
"minimumfee" : "n.nnnnnnnn", // (string) the minimum mining fee a buyer has to pay to accept this offer
"amountaccepted" : "n.nnnnnnnn", // (string) the number of tokens currently reserved for pending "accept" orders
"accepts": [ // (array of JSON objects) a list of pending "accept" orders
{
"buyer" : "address", // (string) the Bitcoin address of the buyer
"block" : nnnnnn, // (number) the index of the block that contains the "accept" order
"blocksleft" : nn, // (number) the number of blocks left to pay
"amount" : "n.nnnnnnnn" // (string) the amount of tokens accepted and reserved
"amounttopay" : "n.nnnnnnnn" // (string) the amount in bitcoins needed finalize the trade
},
...
]
},
...
]
Example:
$ omnicore-cli "omni_getactivedexsells"
Lists all tokens or smart properties.
To get the total number of tokens, please use omni_getproperty.
Arguments:
None
Result:
[ // (array of JSON objects)
{
"propertyid" : n, // (number) the identifier of the tokens
"name" : "name", // (string) the name of the tokens
"category" : "category", // (string) the category used for the tokens
"subcategory" : "subcategory", // (string) the subcategory used for the tokens
"data" : "information", // (string) additional information or a description
"url" : "uri", // (string) an URI, for example pointing to a website
"divisible" : true|false // (boolean) whether the tokens are divisible
"issuer" : "address", // (string) the Bitcoin address of the issuer on record
"creationtxid" : "hash", // (string) the hex-encoded creation transaction hash
"fixedissuance" : true|false, // (boolean) whether the token supply is fixed
"managedissuance" : true|false, // (boolean) whether the token supply is managed by the issuer
},
...
]
Example:
$ omnicore-cli "omni_listproperties"
Returns details for about the tokens or smart property to lookup.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens or property
Result:
{
"propertyid" : n, // (number) the identifier
"name" : "name", // (string) the name of the tokens
"category" : "category", // (string) the category used for the tokens
"subcategory" : "subcategory", // (string) the subcategory used for the tokens
"data" : "information", // (string) additional information or a description
"url" : "uri", // (string) an URI, for example pointing to a website
"divisible" : true|false, // (boolean) whether the tokens are divisible
"issuer" : "address", // (string) the Bitcoin address of the issuer on record
"delegate" : "address", // (string) the Bitcoin address of the issuance delegate, if there is one
"creationtxid" : "hash", // (string) the hex-encoded creation transaction hash
"fixedissuance" : true|false, // (boolean) whether the token supply is fixed
"managedissuance" : true|false, // (boolean) whether the token supply is managed by the issuer
"freezingenabled" : true|false, // (boolean) whether freezing is enabled for the property (managed properties only)
"totaltokens" : "n.nnnnnnnn" // (string) the total number of tokens in existence
}
Example:
$ omnicore-cli "omni_getproperty" 3
Lists currently active crowdsales.
Arguments:
None
Result:
[ // (array of JSON objects)
{
"propertyid" : n, // (number) the identifier of the crowdsale
"name" : "name", // (string) the name of the tokens issued via the crowdsale
"issuer" : "address", // (string) the Bitcoin address of the issuer on record
"propertyiddesired" : n, // (number) the identifier of the tokens eligible to participate in the crowdsale
"tokensperunit" : "n.nnnnnnnn", // (string) the amount of tokens granted per unit invested in the crowdsale
"earlybonus" : n, // (number) an early bird bonus for participants in percent per week
"percenttoissuer" : n, // (number) a percentage of tokens that will be granted to the issuer
"starttime" : nnnnnnnnnn, // (number) the start time of the of the crowdsale as Unix timestamp
"deadline" : nnnnnnnnnn // (number) the deadline of the crowdsale as Unix timestamp
},
...
]
Example:
$ omnicore-cli "omni_getactivecrowdsales"
Returns information about a crowdsale.
Arguments:,
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the crowdsaleverbosebooleanoptionallist crowdsale participants (default: false)
Result:
{
"propertyid" : n, // (number) the identifier of the crowdsale
"name" : "name", // (string) the name of the tokens issued via the crowdsale
"active" : true|false, // (boolean) whether the crowdsale is still active
"issuer" : "address", // (string) the Bitcoin address of the issuer on record
"propertyiddesired" : n, // (number) the identifier of the tokens eligible to participate in the crowdsale
"tokensperunit" : "n.nnnnnnnn", // (string) the amount of tokens granted per unit invested in the crowdsale
"earlybonus" : n, // (number) an early bird bonus for participants in percent per week
"percenttoissuer" : n, // (number) a percentage of tokens that will be granted to the issuer
"starttime" : nnnnnnnnnn, // (number) the start time of the of the crowdsale as Unix timestamp
"deadline" : nnnnnnnnnn, // (number) the deadline of the crowdsale as Unix timestamp
"amountraised" : "n.nnnnnnnn", // (string) the amount of tokens invested by participants
"tokensissued" : "n.nnnnnnnn", // (string) the total number of tokens issued via the crowdsale
"issuerbonustokens" : "n.nnnnnnnn", // (string) the amount of tokens granted to the issuer as bonus
"addedissuertokens" : "n.nnnnnnnn", // (string) the amount of issuer bonus tokens not yet emitted
"closedearly" : true|false, // (boolean) whether the crowdsale ended early (if not active)
"maxtokens" : true|false, // (boolean) whether the crowdsale ended early due to reaching the limit of max. issuable tokens (if not active)
"endedtime" : nnnnnnnnnn, // (number) the time when the crowdsale ended (if closed early)
"closetx" : "hash", // (string) the hex-encoded hash of the transaction that closed the crowdsale (if closed manually)
"participanttransactions": [ // (array of JSON objects) a list of crowdsale participations (if verbose=true)
{
"txid" : "hash", // (string) the hex-encoded hash of participation transaction
"amountsent" : "n.nnnnnnnn", // (string) the amount of tokens invested by the participant
"participanttokens" : "n.nnnnnnnn", // (string) the tokens granted to the participant
"issuertokens" : "n.nnnnnnnn" // (string) the tokens granted to the issuer as bonus
},
...
]
}
Example:
$ omnicore-cli "omni_getcrowdsale" 3 true
Returns information about granted and revoked units of managed tokens.
Arguments:
None
Result:
{
"propertyid" : n, // (number) the identifier of the managed tokens
"name" : "name", // (string) the name of the tokens
"issuer" : "address", // (string) the Bitcoin address of the issuer on record
"creationtxid" : "hash", // (string) the hex-encoded creation transaction hash
"totaltokens" : "n.nnnnnnnn", // (string) the total number of tokens in existence
"issuances": [ // (array of JSON objects) a list of the granted and revoked tokens
{
"txid" : "hash", // (string) the hash of the transaction that granted tokens
"grant" : "n.nnnnnnnn" // (string) the number of tokens granted by this transaction
},
{
"txid" : "hash", // (string) the hash of the transaction that revoked tokens
"grant" : "n.nnnnnnnn" // (string) the number of tokens revoked by this transaction
},
...
]
}
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the managed tokens to lookup
Example:
$ omnicore-cli "omni_getgrants" 31
Get information and recipients of a send-to-owners transaction.
Arguments:
NameTypePresenceDescriptiontxidstringrequiredthe hash of the transaction to lookuprecipientfilterstringoptionala filter for recipients (wallet by default, "*" for all)
Result:
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction
"sendingaddress" : "address", // (string) the Bitcoin address of the sender
"ismine" : true|false, // (boolean) whether the transaction involes an address in the wallet
"confirmations" : nnnnnnnnnn, // (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, // (number) the timestamp of the block that contains the transaction
"valid" : true|false, // (boolean) whether the transaction is valid
"positioninblock" : n, // (number) the position (index) of the transaction within the block
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
"propertyid" : n, // (number) the identifier of sent tokens
"divisible" : true|false, // (boolean) whether the sent tokens are divisible
"amount" : "n.nnnnnnnn", // (string) the number of tokens sent to owners
"totalstofee" : "n.nnnnnnnn", // (string) the fee paid by the sender, nominated in OMN or TOMN
"recipients": [ // (array of JSON objects) a list of recipients
{
"address" : "address", // (string) the Bitcoin address of the recipient
"amount" : "n.nnnnnnnn" // (string) the number of tokens sent to this recipient
},
...
]
}
Example:
$ omnicore-cli "omni_getsto" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" "*"
Get detailed information and trade matches for orders on the distributed token exchange.
Arguments:
NameTypePresenceDescriptiontxidstringrequiredthe hash of the order to lookup
Result:
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction of the order
"sendingaddress" : "address", // (string) the Bitcoin address of the trader
"ismine" : true|false, // (boolean) whether the order involes an address in the wallet
"confirmations" : nnnnnnnnnn, // (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, // (number) the timestamp of the block that contains the transaction
"valid" : true|false, // (boolean) whether the transaction is valid
"positioninblock" : n, // (number) the position (index) of the transaction within the block
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
"propertyidforsale" : n, // (number) the identifier of the tokens put up for sale
"propertyidforsaleisdivisible" : true|false, // (boolean) whether the tokens for sale are divisible
"amountforsale" : "n.nnnnnnnn", // (string) the amount of tokens initially offered
"propertyiddesired" : n, // (number) the identifier of the tokens desired in exchange
"propertyiddesiredisdivisible" : true|false, // (boolean) whether the desired tokens are divisible
"amountdesired" : "n.nnnnnnnn", // (string) the amount of tokens initially desired
"unitprice" : "n.nnnnnnnnnnn..." // (string) the unit price (shown in the property desired)
"status" : "status" // (string) the status of the order ("open", "cancelled", "filled", ...)
"canceltxid" : "hash", // (string) the hash of the transaction that cancelled the order (if cancelled)
"matches": [ // (array of JSON objects) a list of matched orders and executed trades
{
"txid" : "hash", // (string) the hash of the transaction that was matched against
"block" : nnnnnn, // (number) the index of the block that contains this transaction
"address" : "address", // (string) the Bitcoin address of the other trader
"amountsold" : "n.nnnnnnnn", // (string) the number of tokens sold in this trade
"amountreceived" : "n.nnnnnnnn" // (string) the number of tokens traded in exchange
},
...
]
}
Example:
$ omnicore-cli "omni_gettrade" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
List active offers on the distributed token exchange.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredfilter orders by propertyid for salepropertyiddesirednumberoptionalfilter orders by propertyiddesired
Result:
[ // (array of JSON objects)
{
"address" : "address", // (string) the Bitcoin address of the trader
"txid" : "hash", // (string) the hex-encoded hash of the transaction of the order
"ecosystem" : "main"|"test", // (string) the ecosytem in which the order was made (if "cancel-ecosystem")
"propertyidforsale" : n, // (number) the identifier of the tokens put up for sale
"propertyidforsaleisdivisible" : true|false, // (boolean) whether the tokens for sale are divisible
"amountforsale" : "n.nnnnnnnn", // (string) the amount of tokens initially offered
"amountremaining" : "n.nnnnnnnn", // (string) the amount of tokens still up for sale
"propertyiddesired" : n, // (number) the identifier of the tokens desired in exchange
"propertyiddesiredisdivisible" : true|false, // (boolean) whether the desired tokens are divisible
"amountdesired" : "n.nnnnnnnn", // (string) the amount of tokens initially desired
"amounttofill" : "n.nnnnnnnn", // (string) the amount of tokens still needed to fill the offer completely
"action" : n, // (number) the action of the transaction: (1) "trade", (2) "cancel-price", (3) "cancel-pair", (4) "cancel-ecosystem"
"block" : nnnnnn, // (number) the index of the block that contains the transaction
"blocktime" : nnnnnnnnnn // (number) the timestamp of the block that contains the transaction
},
...
]
Example:
$ omnicore-cli "omni_getorderbook" 2
Retrieves the history of trades on the distributed token exchange for the specified market.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe first side of the traded pairpropertyidsecondnumberrequiredthe second side of the traded paircountnumberoptionalnumber of trades to retrieve (default: 10)
Result:
[ // (array of JSON objects)
{
"block" : nnnnnn, // (number) the index of the block that contains the trade match
"unitprice" : "n.nnnnnnnnnnn..." , // (string) the unit price used to execute this trade (received/sold)
"inverseprice" : "n.nnnnnnnnnnn...", // (string) the inverse unit price (sold/received)
"sellertxid" : "hash", // (string) the hash of the transaction of the seller
"address" : "address", // (string) the Bitcoin address of the seller
"amountsold" : "n.nnnnnnnn", // (string) the number of tokens sold in this trade
"amountreceived" : "n.nnnnnnnn", // (string) the number of tokens traded in exchange
"matchingtxid" : "hash", // (string) the hash of the transaction that was matched against
"matchingaddress" : "address" // (string) the Bitcoin address of the other party of this trade
},
...
]
Example:
$ omnicore-cli "omni_gettradehistoryforpair" 1 12 500
Retrieves the history of orders on the distributed exchange for the supplied address.
Arguments:
NameTypePresenceDescriptionaddressstringrequiredaddress to retrieve history forcountnumberoptionalnumber of orders to retrieve (default: 10)propertyidnumberoptionalfilter by propertyid transacted (default: no filter)
Result:
[ // (array of JSON objects)
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction of the order
"sendingaddress" : "address", // (string) the Bitcoin address of the trader
"ismine" : true|false, // (boolean) whether the order involes an address in the wallet
"confirmations" : nnnnnnnnnn, // (number) the number of transaction confirmations
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"blocktime" : nnnnnnnnnn, // (number) the timestamp of the block that contains the transaction
"valid" : true|false, // (boolean) whether the transaction is valid
"positioninblock" : n, // (number) the position (index) of the transaction within the block
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
"propertyidforsale" : n, // (number) the identifier of the tokens put up for sale
"propertyidforsaleisdivisible" : true|false, // (boolean) whether the tokens for sale are divisible
"amountforsale" : "n.nnnnnnnn", // (string) the amount of tokens initially offered
"propertyiddesired" : n, // (number) the identifier of the tokens desired in exchange
"propertyiddesiredisdivisible" : true|false, // (boolean) whether the desired tokens are divisible
"amountdesired" : "n.nnnnnnnn", // (string) the amount of tokens initially desired
"unitprice" : "n.nnnnnnnnnnn..." // (string) the unit price (shown in the property desired)
"status" : "status" // (string) the status of the order ("open", "cancelled", "filled", ...)
"canceltxid" : "hash", // (string) the hash of the transaction that cancelled the order (if cancelled)
"matches": [ // (array of JSON objects) a list of matched orders and executed trades
{
"txid" : "hash", // (string) the hash of the transaction that was matched against
"block" : nnnnnn, // (number) the index of the block that contains this transaction
"address" : "address", // (string) the Bitcoin address of the other trader
"amountsold" : "n.nnnnnnnn", // (string) the number of tokens sold in this trade
"amountreceived" : "n.nnnnnnnn" // (string) the number of tokens traded in exchange
},
...
]
},
...
]
Example:
$ omnicore-cli "omni_gettradehistoryforaddress" "1MCHESTptvd2LnNp7wmr2sGTpRomteAkq8"
Returns pending and completed feature activations.
Result:
{
"pendingactivations": [ // (array of JSON objects) a list of pending feature activations
{
"featureid" : n, // (number) the id of the feature
"featurename" : "xxxxxxxx", // (string) the name of the feature
"activationblock" : n, // (number) the block the feature will be activated
"minimumversion" : n // (number) the minimum client version needed to support this feature
},
...
]
"completedactivations": [ // (array of JSON objects) a list of completed feature activations
{
"featureid" : n, // (number) the id of the feature
"featurename" : "xxxxxxxx", // (string) the name of the feature
"activationblock" : n, // (number) the block the feature will be activated
"minimumversion" : n // (number) the minimum client version needed to support this feature
},
...
]
}
Example:
$ omnicore-cli "omni_getactivations"
Get the payload for an Omni transaction.
Arguments:
NameTypePresenceDescriptiontxidstringrequiredthe hash of the transaction to retrieve payload
Result:
{
"payload" : "payloadmessage", // (string) the decoded Omni payload message
"payloadsize" : n // (number) the size of the payload
}
Example:
$ omnicore-cli "omni_getpayload" "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
Returns a list of blocks containing Omni transactions for use in seed block filtering.
WARNING: The Exodus crowdsale is not stored in LevelDB, thus this is currently only safe to use to generate seed blocks after block 255365.
Arguments:
NameTypePresenceDescriptionstartblocknumberrequiredthe first block to look for Omni transactions (inclusive)endblocknumberrequiredthe last block to look for Omni transactions (inclusive)
Result:
[ // (array of numbers) a list of seed blocks
nnnnnnn, // the block height of the seed block
...
]
Example:
$ omnicore-cli "omni_getseedblocks" 290000 300000
Returns the consensus hash covering the state of the current block.
Arguments:
None
Result:
{
"block" : nnnnnn, // (number) the index of the block this consensus hash applies to
"blockhash" : "hash", // (string) the hash of the corresponding block
"consensushash" : "hash" // (string) the consensus hash for the block
}
Example:
$ omnicore-cli "omni_getcurrentconsensushash"
Returns the non-fungible tokens for a given address. Optional property ID filter.
Arguments:
NameTypePresenceDescriptionaddressstringrequiredthe addresspropertyidnumberoptionalthe property identifier
Result:
[
{
"propertyid" : n,
"tokens" : [
{
"tokenstart" : n, // (number) the first token in this range
"tokenend" : n, // (number) the last token in this range
"amount" : n, // (number) the amount of tokens in the range
}...
]
}...
]
Example:
$ omnicore-cli "omni_getnonfungibletokens 1EXoDusjGwvnjZUyKkxZ4UHEf77z6A5S4P 1"
Returns owner and all data set in a non-fungible token.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe property identifiertokenidstartnumberrequiredthe first non-fungible token in rangetokenidendnumberrequiredthe last non-fungible token in range
Result:
{
"index" : n, // (number) the unique index of the token
"owner" : "owner", // (string) the Bitcoin address of the owner
"grantdata" : "grantdata", // (string) contents of the grant data field
"issuerdata" : "issuerdata", // (string) contents of the issuer data field
"holderdata" : "holderdata", // (string) contents of the holder data field
}
Example:
$ omnicore-cli "omni_getnonfungibletokendata 1 10 20"
Returns the ranges and their addresses for a non-fungible token property.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe property identifier
Result:
{
"address" : "address", // (string) the address
"tokenstart" : n, // (number) the first token in this range
"tokenend" : n, // (number) the last token in this range
"amount" : n.nnnnnnnn, // (number) the amount of tokens in the range
}
Example:
$ omnicore-cli "omni_getnonfungibletokenranges 1"
The following RPCs can be used to obtain information about non-wallet balances and transactions. The address index must be enabled to use them.
getaddresstxidsReturns the txids for one or more addresses (requires addressindex to be enabled).
Arguments:
NameTypePresenceDescriptionaddressesobjectrequiredan object with addresses and optional start and end blocks
Result:
[ // (array of txids) a list of transaction hashes
"hash", // (string) the transaction identifier
...
]
Example:
$ omnicore-cli getaddresstxids '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"]}'
$ omnicore-cli getaddresstxids '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"], "start": 380, "end": 400}'
Returns all changes for an address (requires addressindex to be enabled).
Arguments:
NameTypePresenceDescriptionaddressesobjectrequiredan object with addresses and optional start and end blocks
Result:
[
{
"satoshis": n, // (number) the difference of satoshis
"txid": "hash", // (string) the related txid
"index": n, // (number) the related input or output index
"height": n, // (number) the block height
"address": "base58address", // (string) the address
},
...
]
Example:
$ omnicore-cli getaddressdeltas '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"]}'
$ omnicore-cli getaddressdeltas '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"], "start": 380, "end": 400, "chainInfo": false}'
Returns the balance for one or more addresses (requires addressindex to be enabled).
Arguments:
NameTypePresenceDescriptionaddressesobjectrequiredan array of addresses
Result:
{
"balance": n, // (number) the current balance in satoshis
"received": n, // (number) the total number of satoshis received (including change)
"immature": n // (number) the total number of non-spendable mining satoshis received
}
Example:
$ omnicore-cli getaddressbalance '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"]}'
$ omnicore-cli getaddressbalance '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj", "2N2Hca6QvczCnSJ1ZkFfjqDvmgPiWifFF8Q"]}'
Returns all unspent outputs for an address (requires addressindex to be enabled).
Arguments:
NameTypePresenceDescriptionaddressesobjectrequiredan array of addresses
Result:
{
"utxos": [
{
"address": "base58address", // (string) The address
"txid": "hash" // (string) The output txid
"outputIndex": n, // (number) The block height
"script": "hex", // (string) The script hex encoded
"satoshis": n, // (number) The number of satoshis of the output
"height": 301, // (number) The block height
"coinbase": true // (boolean) Whether it's a coinbase transaction
},
...
],
"hash": "hash", // (string) The current block hash
"height": n // (string) The current block height
}
Example:
$ omnicore-cli getaddressbalance '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"]}'
$ omnicore-cli getaddressbalance '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"], "chainInfo": true}'
Returns all mempool deltas for an address (requires addressindex to be enabled).
Arguments:
NameTypePresenceDescriptionaddressesobjectrequiredan array of addresses
Result:
[
{
"address": "base58address", // (string) The address
"txid": "hash" // (string) The related txid
"index": n, // (number) The related input or output index
"satoshis": n, // (number) The difference of satoshis
"timestamp": n, // (number) The time the transaction entered the mempool (seconds)
"prevtxid": "hash", // (string) The previous txid (if spending)
"prevout": n // (number) The previous transaction output index (if spending)
},
...
]
Example:
$ omnicore-cli getaddressmempool '{"addresses": ["2NDaa1MvFcpc2CAbFvG5g9dDxzrRyDnKnsj"]}'
Returns array of hashes of blocks within the timestamp range provided.
Arguments:
NameTypePresenceDescriptionhighnumberrequiredthe newer block timestamplownumberrequiredthe older block timestampoptionsobjectoptionalan object with options
Result:
[
"hash", // (string) The block hash
...
]
[
{
"blockhash": "hash", // (string) The block hash
"logicalts": n // (number) The logical timestamp
},
...
]
Example:
$ omnicore-cli getblockhashes 1902163557 1602163557
$ omnicore-cli getblockhashes 1902163557 1602163557 '{"noOrphans":false, "logicalTimes":true}'
Returns the txid and index where an output is spent.
Returns array of hashes of blocks within the timestamp range provided.
Arguments:
NameTypePresenceDescriptiondataobjectrequiredTransaction data
Result:
{
"txid": "hash", // (string) The transaction id
"index": n, // (number) The spending input index
"height": n // (number) The block height
}
Example:
getspentinfo '{"txid": "f5ea8842e96933cbb4d6f07c6dd33902bf3abb2f46cd84ff681ecd288214ea72", "index": 0}'
The RPCs for raw transactions/payloads can be used to decode or create raw Omni transactions.
Raw transactions need to be signed with "signrawtransaction" and then broadcasted with "sendrawtransaction".
Decodes an Omni transaction.
If the inputs of the transaction are not in the chain, then they must be provided, because the transaction inputs are used to identify the sender of a transaction.
A block height can be provided, which is used to determine the parsing rules.
Arguments:
NameTypePresenceDescriptionrawtxstringrequiredthe raw transaction to decodeprevtxsstringoptionala JSON array of transaction inputs (default: none)heightnumberoptionalthe parsing block height (default: 0 for chain height)
The format of prevtxs is as following:
[
{
"txid" : "hash", // (string, required) the transaction hash
"vout" : n, // (number, required) the output number
"scriptPubKey" : "hex", // (string, required) the output script
"value" : n.nnnnnnnn // (number, required) the output value
}
,...
]
Result:
{
"txid" : "hash", // (string) the hex-encoded hash of the transaction
"fee" : "n.nnnnnnnn", // (string) the transaction fee in bitcoins
"sendingaddress" : "address", // (string) the Bitcoin address of the sender
"referenceaddress" : "address", // (string) a Bitcoin address used as reference (if any)
"ismine" : true|false, // (boolean) whether the transaction involes an address in the wallet
"version" : n, // (number) the transaction version
"type_int" : n, // (number) the transaction type as number
"type" : "type", // (string) the transaction type as string
[...] // (mixed) other transaction type specific properties
}
Example:
$ omnicore-cli "omni_decodetransaction" "010000000163af14ce6d477e1c793507e32a5b7696288fa89705c0d02a3f66beb3c \
5b8afee0100000000ffffffff02ac020000000000004751210261ea979f6a06f9dafe00fb1263ea0aca959875a7073556a088cdf \
adcd494b3752102a3fd0a8a067e06941e066f78d930bfc47746f097fcd3f7ab27db8ddf37168b6b52ae22020000000000001976a \
914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000" \
"[{\"txid\":\"eeafb8c5b3be663f2ad0c00597a88f2896765b2ae30735791c7e476dce14af63\",\"vout\":1, \
\"scriptPubKey\":\"76a9149084c0bd89289bc025d0264f7f23148fb683d56c88ac\",\"value\":0.0001123}]"
Adds a payload with class C (op-return) encoding to the transaction.
If no raw transaction is provided, a new transaction is created.
If the data encoding fails, then the transaction is not modified.
Arguments:
NameTypePresenceDescriptionrawtxstringrequiredthe raw transaction to extend (can be null)payloadstringrequiredthe hex-encoded payload to add
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_opreturn" "01000000000000000000" "00000000000000020000000006dac2c0"
Adds a payload with class B (bare-multisig) encoding to the transaction.
If no raw transaction is provided, a new transaction is created.
If the data encoding fails, then the transaction is not modified.
Arguments:
NameTypePresenceDescriptionrawtxstringrequiredthe raw transaction to extend (can be null)payloadstringrequiredthe hex-encoded payload to addseedstringrequiredthe seed for obfuscationpayloadstringrequireda public key or address for dust redemption
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_multisig" \
"0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff01aa0a00000 \
00000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac00000000" \
"00000000000000020000000000989680"
"1LifmeXYHeUe2qdKWBGVwfbUCMMrwYtoMm" \
"0252ce4bdd3ce38b4ebbc5a6e1343608230da508ff12d23d85b58c964204c4cef3"
Adds a transaction input to the transaction.
If no raw transaction is provided, a new transaction is created.
Arguments:
NameTypePresenceDescriptionrawtxstringrequiredthe raw transaction to extend (can be null)txidstringrequiredthe hash of the input transactionnnumberrequiredthe index of the transaction output used as input
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_input" \
"01000000000000000000" "b006729017df05eda586df9ad3f8ccfee5be340aadf88155b784d1fc0e8342ee" 0
Adds a reference output to the transaction.
If no raw transaction is provided, a new transaction is created.
The output value is set to at least the dust threshold.
Arguments:
NameTypePresenceDescriptionrawtxstringrequiredthe raw transaction to extend (can be null)destinationstringrequiredthe reference address or destinationreferenceamountnumberoptionalthe optional reference amount (minimal by default)
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_reference" \
"0100000001a7a9402ecd77f3c9f745793c9ec805bfa2e14b89877581c734c774864247e6f50400000000ffffffff03aa0a00000
00000001976a9146d18edfe073d53f84dd491dae1379f8fb0dfe5d488ac5c0d0000000000004751210252ce4bdd3ce38b4ebbc5a
6e1343608230da508ff12d23d85b58c964204c4cef3210294cc195fc096f87d0f813a337ae7e5f961b1c8a18f1f8604a909b3a51
21f065b52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2339d24288ac00000000" \
"1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" \
0.005
Adds a change output to the transaction.
The provided inputs are not added to the transaction, but only used to determine the change. It is assumed that the inputs were previously added, for example via "createrawtransaction".
Optionally a position can be provided, where the change output should be inserted, starting with 0. If the number of outputs is smaller than the position, then the change output is added to the end. Change outputs should be inserted before reference outputs, and as per default, the change output is added to the`first position.
If the change amount would be considered as dust, then no change output is added.
Arguments:
NameTypePresenceDescriptionrawtxstringrequiredthe raw transaction to extendprevtxsstringrequireda JSON array of transaction inputsdestinationstringrequiredthe destination for the changefeenumberrequiredthe desired transaction feespositionnumberoptionalthe position of the change output (default: first position)
The format of prevtxs is as following:
[
{
"txid" : "hash", // (string, required) the transaction hash
"vout" : n, // (number, required) the output number
"scriptPubKey" : "hex", // (string, required) the output script
"value" : n.nnnnnnnn // (number, required) the output value
}
,...
]
Result:
"rawtx" // (string) the hex-encoded modified raw transaction
Example:
$ omnicore-cli "omni_createrawtx_change" \
"0100000001b15ee60431ef57ec682790dec5a3c0d83a0c360633ea8308fbf6d5fc10a779670400000000ffffffff025c0d00000 \
000000047512102f3e471222bb57a7d416c82bf81c627bfcd2bdc47f36e763ae69935bba4601ece21021580b888ff56feb27f17f \
08802ebed26258c23697d6a462d43fc13b565fda2dd52aeaa0a0000000000001976a914946cb2e08075bcbaf157e47bcb67eb2b2 \
339d24288ac00000000" \
"[{\"txid\":\"6779a710fcd5f6fb0883ea3306360c3ad8c0a3c5de902768ec57ef3104e65eb1\",\"vout\":4, \
\"scriptPubKey\":\"76a9147b25205fd98d462880a3e5b0541235831ae959e588ac\",\"value\":0.00068257}]" \
"1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" 0.000035 1
Create the payload for a simple send transaction.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens to sendamountstringrequiredthe amount to send
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_simplesend" 1 "100.0"
Create the payload for a send all transaction.
Arguments:
NameTypePresenceDescriptionecosystemnumberrequiredthe ecosystem of the tokens to send (1 for main ecosystem, 2 for test ecosystem)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_sendall" 2
Create a payload to place, update or cancel a sell offer on the traditional distributed OMNI/BTC exchange.
Arguments:
NameTypePresenceDescriptionpropertyidforsalenumberrequiredthe identifier of the tokens to list for sale (must be 1 for OMN or 2 for TOMN)amountforsalestringrequiredthe amount of tokens to list for saleamountdesiredstringrequiredthe amount of bitcoins desiredpaymentwindownumberrequireda time limit in blocks a buyer has to pay following a successful accepting orderminacceptfeestringrequireda minimum mining fee a buyer has to pay to accept the offeractionnumberrequiredthe action to take (1 for new offers, 2 to update", 3 to cancel)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_dexsell" 1 "1.5" "0.75" 25 "0.0005" 1
Create the payload for an accept offer for the specified token and amount.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the token to purchaseamountstringrequiredthe amount to accept
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_dexaccept" 1 "15.0"
Creates the payload for a send-to-owners transaction.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the token to distributeamountstringrequiredthe amount to distributedistributionpropertynumberoptionalthe identifier of the property holders to distribute to
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_sto" 3 "5000"
Creates the payload for a new tokens issuance with fixed supply.
Arguments:
NameTypePresenceDescriptionecosystemnumberrequiredthe ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem)typenumberrequiredthe type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens)previousidnumberrequiredan identifier of a predecessor token (use 0 for new tokens)categorystringrequireda category for the new tokens (can be “”)subcategorystringrequireda subcategory for the new tokens (can be “”)namestringrequiredthe name of the new tokens to createurlstringrequiredan URL for further information about the new tokens (can be “”)datastringrequireda description for the new tokens (can be “”)amountstringrequiredthe number of tokens to create
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_issuancefixed" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" "1000000"
Creates the payload for a new tokens issuance with crowdsale.
Arguments:
NameTypePresenceDescriptionecosystemnumberrequiredthe ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem)typenumberrequiredthe type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens)previousidnumberrequiredan identifier of a predecessor token (use 0 for new tokens)categorystringrequireda category for the new tokens (can be “”)subcategorystringrequireda subcategory for the new tokens (can be “”)namestringrequiredthe name of the new tokens to createurlstringrequiredan URL for further information about the new tokens (can be “”)datastringrequireda description for the new tokens (can be “”)propertyiddesirednumberrequiredthe identifier of a token eligible to participate in the crowdsaletokensperunitstringrequiredthe amount of tokens granted per unit invested in the crowdsaledeadlinenumberrequiredthe deadline of the crowdsale as Unix timestampearlybonusnumberrequiredan early bird bonus for participants in percent per weekissuerpercentagenumberrequireda percentage of tokens that will be granted to the issuer
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_issuancecrowdsale" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" "" 2 "100" 1483228800 30 2
Creates the payload for a new tokens issuance with manageable supply.
Arguments:
NameTypePresenceDescriptionecosystemnumberrequiredthe ecosystem to create the tokens in (1 for main ecosystem, 2 for test ecosystem)typenumberrequiredthe type of the tokens to create: (1 for indivisible tokens, 2 for divisible tokens)previousidnumberrequiredan identifier of a predecessor token (use 0 for new tokens)categorystringrequireda category for the new tokens (can be “”)subcategorystringrequireda subcategory for the new tokens (can be “”)namestringrequiredthe name of the new tokens to createurlstringrequiredan URL for further information about the new tokens (can be “”)datastringrequireda description for the new tokens (can be “”)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_issuancemanaged" 2 1 0 "Companies" "Bitcoin Mining" "Quantum Miner" "" ""
Creates the payload to manually close a crowdsale.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the crowdsale to close
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_closecrowdsale" 70
Creates the payload to issue or grant new units of managed tokens.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens to grantamountstringrequiredthe amount of tokens to creategrantdatastringoptionalNFT only: data set in all NFTs created in this grant (default: empty)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_grant" 51 "7000"
Creates the payload to revoke units of managed tokens.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!f
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens to revokeamountstringrequiredthe amount of tokens to revokememostringoptionala text note attached to this transaction (none by default)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_revoke" 51 "100"
Creates the payload to change the issuer on record of the given tokens.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_changeissuer" 3
Creates the payload to place a trade offer on the distributed token exchange.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptionpropertyidforsalenumberrequiredthe identifier of the tokens to list for saleamountforsalestringrequiredthe amount of tokens to list for salepropertyiddesirednumberrequiredthe identifier of the tokens desired in exchangeamountdesiredstringrequiredthe amount of tokens desired in exchange
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_trade" 31 "250.0" 1 "10.0"
Creates the payload to cancel offers on the distributed token exchange with the specified price.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptionpropertyidforsalenumberrequiredthe identifier of the tokens to list for saleamountforsalestringrequiredthe amount of tokens to list for salepropertyiddesirednumberrequiredthe identifier of the tokens desired in exchangeamountdesiredstringrequiredthe amount of tokens desired in exchange
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_canceltradesbyprice" 31 "100.0" 1 "5.0"
Creates the payload to cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
NameTypePresenceDescriptionpropertyidforsalenumberrequiredthe identifier of the tokens to list for salepropertyiddesirednumberrequiredthe identifier of the tokens desired in exchange
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_canceltradesbypair" 1 31
Creates the payload to cancel all offers on the distributed token exchange with the given currency pair.
Arguments:
NameTypePresenceDescriptionecosystemnumberrequiredthe ecosystem of the offers to cancel (1 for main ecosystem, 2 for test ecosystem)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_cancelalltrades" 1
Creates the payload to enable address freezing for a centrally managed property.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_enablefreezing" 3
Creates the payload to disable address freezing for a centrally managed property.
IMPORTANT NOTE: Disabling freezing for a property will UNFREEZE all frozen addresses for that property!
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_disablefreezing" 3
Creates the payload to freeze an address for a centrally managed token.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptiontoaddressstringrequiredthe address to freeze tokens forpropertyidnumberrequiredthe property to freeze tokens for (must be managed type and have freezing option enabled)amountstringrequiredthe amount of tokens to freeze (note: this is unused - once frozen an address cannot send any transactions)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_freeze" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 31 "100"
Creates the payload to unfreeze an address for a centrally managed token.
Note: if the server is not synchronized, amounts are considered as divisible, even if the token may have indivisible units!
Arguments:
NameTypePresenceDescriptiontoaddressstringrequiredthe address to unfreeze tokens forpropertyidnumberrequiredthe property to unfreeze tokens for (must be managed type and have freezing option enabled)amountstringrequiredthe amount of tokens to unfreeze (note: this is unused)
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_unfreeze" "3HTHRxu3aSDV4deakjC7VmsiUp7c6dfbvs" 31 "100"
Creates the payload to add a delegate for the issuance of tokens of a managed property.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_adddelegate" 21
Creates the payload to remove a delegate for the issuance of tokens of a managed property.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_removedelegate" 21
---
### omni_createpayload_anydata
Creates the payload to embed arbitrary data.
**Arguments:**
| Name | Type | Presence | Description |
|---------------------|---------|----------|----------------------------------------------------------------------------------------------|
| `data` | string | required | the hex-encoded data |
**Result:**
```js
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_anydata" "646578782032303230"
Create the payload for a non-fungible send transaction.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens to sendtokenstartnumberrequiredthe first token in the range to sendtokenendnumberrequiredthe last token in the range to send
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_sendnonfungible" 70 1 1000
Create the payload for a non-fungible token set data transaction.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the tokens to sendtokenstartnumberrequiredthe first token in the range to set data ontokenendnumberrequiredthe last token in the range to set data onissuerbooleanrequiredif true issuer data set, otherwise holder data setdatastringrequireddata set as in either issuer or holder fields
Result:
"payload" // (string) the hex-encoded payload
Example:
$ omnicore-cli "omni_createpayload_setnonfungibledata" 70 50 60 true "string data"
The RPCs for the fee system can be used to obtain data about the fee system and fee distributions.
omni_getfeecacheObtains the current amount of fees cached (pending distribution).
If a property ID is supplied the results will be filtered to show this property ID only. If no property ID is supplied the results will contain all properties that currently have fees cached pending distribution.
Arguments:
NameTypePresenceDescriptionpropertyidnumberoptionalthe identifier of the property to filter results on
Result:
[ // (array of JSON objects)
{
"propertyid" : nnnnnnn, // (number) the property id
"cachedfees" : "n.nnnnnnnn", // (string) the amount of fees cached for this property
},
...
]
Example:
$ omnicore-cli "omni_getfeecache" 31
Obtains the amount at which cached fees will be distributed.
If a property ID is supplied the results will be filtered to show this property ID only. If no property ID is supplied the results will contain all properties.
Arguments:
NameTypePresenceDescriptionpropertyidnumberoptionalthe identifier of the property to filter results on
Result:
[ // (array of JSON objects)
{
"propertyid" : nnnnnnn, // (number) the property id
"feetrigger" : "n.nnnnnnnn", // (string) the amount of fees required to trigger distribution
},
...
]
Example:
$ omnicore-cli "omni_getfeetrigger" 31
Obtains the current percentage share of fees addresses would receive if a distribution were to occur.
If an address is supplied the results will be filtered to show this address only. If no address is supplied the results will be filtered to show wallet addresses only. If a wildcard is provided ("*") the results will contain all addresses that would receive a share.
If an ecosystem is supplied the results will reflect the fee share for that ecosystem (main or test). If no ecosystem is supplied the results will reflect the main ecosystem.
Arguments:
NameTypePresenceDescriptionaddressstringoptionalthe address to filter results onecosystemnumberoptionalthe ecosystem to obtain the current percentage fee share (1 = main, 2 = test)
Result:
[ // (array of JSON objects)
{
"address" : "address" // (string) the address that would receive a share of fees
"feeshare" : "n.nnnn%", // (string) the percentage of fees this address will receive based on the current state
},
...
]
Example:
$ omnicore-cli "omni_getfeeshare" "1CE8bBr1dYZRMnpmyYsFEoexa1YoPz2mfB" 1
Obtains data for a past distribution of fees.
A distribution ID must be supplied to identify the distribution to obtain data for.
Arguments:
NameTypePresenceDescriptiondistributionidnumberrequiredthe identifier of the distribution to obtain data for
Result:
{
"distributionid" : n, // (number) the distribution id
"propertyid" : n, // (number) the property id of the distributed tokens
"block" : n, // (number) the block the distribution occurred
"amount" : "n.nnnnnnnn", // (string) the amount that was distributed
"recipients": [ // (array of JSON objects) a list of recipients
{
"address" : "address", // (string) the address of the recipient
"amount" : "n.nnnnnnnn" // (string) the amount of fees received by the recipient
},
...
]
}
Example:
$ omnicore-cli "omni_getfeedistribution" 1
Obtains data for past distributions of fees for a property.
A property ID must be supplied to retrieve past distributions for.
Arguments:
NameTypePresenceDescriptionpropertyidnumberrequiredthe identifier of the property to retrieve past distributions for
Result:
[ // (array of JSON objects)
{
"distributionid" : n, // (number) the distribution id
"propertyid" : n, // (number) the property id of the distributed tokens
"block" : n, // (number) the block the distribution occurred
"amount" : "n.nnnnnnnn", // (string) the amount that was distributed
"recipients": [ // (array of JSON objects) a list of recipients
{
"address" : "address", // (string) the address of the recipient
"amount" : "n.nnnnnnnn" // (string) the amount of fees received by the recipient
},
...
]
},
...
]
Example:
$ omnicore-cli "omni_getfeedistributions" 31
The RPCs for the configuration can be used to alter Omni Core settings.
omni_setautocommitSets the global flag that determines whether transactions are automatically committed and broadcasted.
Arguments:
NameTypePresenceDescriptionflagbooleanrequiredthe flag
Result:
true|false // (boolean) the updated flag status
Example:
$ omnicore-cli "omni_setautocommit" false
To ensure backwards compatibility, deprecated RPCs are kept for at least one major version.
The following calls are replaced in Omni Core 0.0.10, and queries with the old command are forwarded.
send_MPbyomni_sendsendtoowners_MPbyomni_sendstosendrawtx_MPbyomni_sendrawtxgetinfo_MPbyomni_getinfogetbalance_MPbyomni_getbalancegetallbalancesforid_MPbyomni_getallbalancesforidgetallbalancesforaddress_MPbyomni_getallbalancesforaddressgettransaction_MPbyomni_gettransactionlisttransactions_MPbyomni_listtransactionslistblocktransactions_MPbyomni_listblocktransactionsgetactivedexsells_MPbyomni_getactivedexsellslistproperties_MPbyomni_listpropertiesgetproperty_MPbyomni_getpropertygetactivecrowdsales_MPbyomni_getactivecrowdsalesgetcrowdsale_MPbyomni_getcrowdsalegetgrants_MPbyomni_getgrantsgetsto_MPbyomni_getstooromni_gettransaction
