"description":"Provides the balance for the current account, showing the balance for the transparent, Sapling and Orchard pools, both for confirmed notes and unconfirmed notes",
"params":[
{
"name":"accountId",
"summary":"The integer ID of the account to use",
"value":1
}
],
"result":{
"name":"GetBalance result",
"value":{
"confirmed":{
"orchard":22210259,
"sapling":0,
"transparent":0
},
"unconfirmed":{
"orchard":0,
"sapling":0,
"transparent":0
}
}
}
}
],
"errors":[
{"$ref":"#/components/errors/InvalidAccount"}
]
},
{
"name":"listreceived",
"summary":"List received transactions",
"description":"List transactions received by the given address.",
"description":"Send one transaction by specifying the source account, the privacy policy (optional, default 'Full') and an array of proposed outputs. Each output needs a recipient address, an amount and an optional shielded memo.",
"summary":"Shield all transparent notes into the Orchard pool for the given account",
"description":"Creates one or more transactions, grouping all the unspent transparent notes for the given account by their transparent address to avoid associating different transparent addresses. These notes are sent to the given account's internal change address as shielded Orchard notes.",
"description":"Shield the transparent notes in a given account",
"params":[
{
"name":"Account index",
"summary":"The index for the account to use",
"value":"3"
}
],
"result":{
"name":"ShieldNotes result",
"value":[
"ab350df0-9f57-44c0-9e0d-f7b8af1f4231",
"8c6f2656-22ef-4f9d-b465-80ddd13fc485"
]
}
},
{
"name":"No transparent funds",
"summary":"Shield transparent notes with no transparent funds",
"description":"Attempt to shield the transparent notes in a given account, when account has none",
"params":[
{
"name":"Account index",
"summary":"The index for the account to use",
"value":"3"
}
],
"result":{
"name":"ShieldNotes result",
"value":[
"InsufficientFunds"
]
}
}
],
"errors":[
{"$ref":"#/components/errors/ZebraNotAvailable"},
{"$ref":"#/components/errors/ZenithBusy"},
{"$ref":"#/components/errors/InvalidAccount"}
]
},
{
"name":"deshieldfunds",
"summary":"De-shield the given amount of ZEC from the given account",
"description":"Creates a new internal transaction with the requested amount of ZEC to the transparent pool. The fee is not included in the given amount.",
"summary":"The wallet's internal index used for unique identification",
"description":"An Integer value that uniquely identifies a wallet in Zenith",
"required":true,
"schema":{
"type":"integer"
}
},
"AccountId":{
"name":"Account ID",
"summary":"The account's internal index used for unique identification",
"description":"An Integer value that uniquely identifies an account in Zenith",
"required":true,
"schema":{
"type":"integer"
}
},
"Address":{
"name":"Address identifier",
"summary":"The address identifier",
"description":"A string that identifies a specific address, either by its index or the [ZIP-316](https://zips.z.cash/zip-0316) encoded address itself",
"description":"A string that represents an entity in Zenith, like a wallet, an account or an address.",
"required":true,
"schema":{
"type":"string"
}
},
"ExcludeSapling":{
"name":"ExcludeSapling",
"summary":"Setting that indicates that the new address requested should not contain a Sapling component",
"description":"When this parameter is present, Zenith will generate an address with no Sapling receiver",
"required":false,
"schema":{
"type":"string"
}
},
"ExcludeTransparent":{
"name":"ExcludeTransparent",
"summary":"Setting that indicates that the new address requested should not contain a Transparent component",
"description":"When this parameter is present, Zenith will generate an address with no Transparent receiver",
"required":false,
"schema":{
"type":"string"
}
},
"OperationId":{
"name":"Operation ID",
"summary":"A unique identifier for Zenith operations",
"description":"A [UUID](http://en.wikipedia.org/wiki/UUID) assigned to an operation (like sending a transaction) that can be used to query Zenith to see the status and outcome of the operation.",
"required":true,
"schema":{
"type":"string"
}
},
"TxRequestArray":{
"name":"Transaction Request Array",
"summary":"An array of proposed transactions",
"description":"An array of proposed new outgoing transactions, including the recipient's address, the amount in ZEC, the optional shielded memo, and the optional privacy level.",
"required":true,
"schema":{
"type":"array",
"items":{"$ref":"#/components/schemas/TxRequest"}
}
},
"PrivacyPolicy":{
"name":"Privacy Policy",
"summary":"The chosen privacy policy to use for the transaction",
"description":"The privacy policy to use for the transaction. `Full` policy allows shielded funds to be transferred within their shielded pools. `Medium` policy allows shielded funds to cross shielded pools. `Low` allows deshielding transactions into transparent receivers but not to exchange addresses. `None` allows for transparent funds to be spent to transparent addresses and exchange addresses.",
"start":{"type":"string","description":"The date and time the operation started"},
"end":{"type":["string","null"],"description":"The date and time the operation ended. If the operation is still running, this field is null"},
"status":{"type":"string","enum":["Processing","Failed","Successful"],"description":"If the operation has started it will show Processing, once it completes it will show Failed or Successful depending on the outcome"},
"result":{"type":["string","null"],"description":"For a succesful transaction operation, the transaction ID. For failed operations, the error message. For pending operations, this field is null."}
}
},
"TxRequest":{
"type":"object",
"properties":{
"address":{"type":"string","description":"Recipient's address (unified, Sapling or transparent)"},
"amount":{"type":"number","description":"The amount to send in ZEC"},
"memo":{"type":"string","description":"The shielded memo to include, if applicable"}
}
}
},
"examples":{},
"tags":{
"draft":{"name":"Draft"},
"wip":{"name":"WIP"}
},
"errors":{
"ZebraNotAvailable":{
"code":-32000,
"message":"Zebra not available"
},
"NoWallets":{
"code":-32001,
"message":"No wallets available. Please create one first"
},
"NoAccounts":{
"code":-32002,
"message":"No accounts available. Please create one first"
},
"NoAddress":{
"code":-32003,
"message":"No addresses available for this account. Please create one first"
},
"UnknownAddress":{
"code":-32004,
"message":"Address does not belong to the wallet"
},
"InvalidAddress":{
"code":-32005,
"message":"Unable to parse address"
},
"InvalidAccount":{
"code":-32006,
"message":"Account does not exist."
},
"DuplicateName":{
"code":-32007,
"message":"Entity with that name already exists."
},
"InvalidWallet":{
"code":-32008,
"message":"Wallet does not exist."
},
"OpNotFound":{
"code":-32009,
"message":"Operation ID not found."
},
"InternalError":{
"code":-32010,
"message":"Varies"
},
"InvalidRecipient":{
"code":-32011,
"message":"The provided recipient address is not valid."
},
"ZenithBusy":{
"code":-32012,
"message":"The Zenith server is syncing, please try again later."
