Zcash Payment API (z_ methods)

The Zcash-specific extension to the JSON-RPC interface that enables shielded (private) transaction operations using zero-knowledge proofs. Includes methods for managing shielded addresses (z-addrs), sending private transactions with encrypted memos, and key management for the Sapling and Orchard shielded pools.

API entry from apis.yml

apis.yml Raw ↑
name: Zcash Payment API (z_ methods)
description: The Zcash-specific extension to the JSON-RPC interface that enables shielded (private) transaction
  operations using zero-knowledge proofs. Includes methods for managing shielded addresses (z-addrs),
  sending private transactions with encrypted memos, and key management for the Sapling and Orchard shielded
  pools.
humanURL: https://github.com/zcash/zcash/blob/master/doc/payment-api.md
baseURL: http://127.0.0.1:8232/
tags:
- JSON-RPC
- Shielded Transactions
- Privacy
- Zero-Knowledge Proofs
- Sapling
- Orchard
properties:
- type: Documentation
  url: https://github.com/zcash/zcash/blob/master/doc/payment-api.md
- type: ReferenceDocumentation
  url: https://zcash.github.io/rpc/
operations:
- label: Shielded Address Management
  maturity: stable
  methods:
  - z_getnewaddress
  - z_listaddresses
  - z_validateaddress
- label: Shielded Balances
  maturity: stable
  methods:
  - z_getbalance
  - z_gettotalbalance
- label: Shielded Key Management
  maturity: stable
  methods:
  - z_exportkey
  - z_importkey
  - z_exportwallet
  - z_importwallet
  - z_exportviewingkey
  - z_importviewingkey
- label: Shielded Payments
  maturity: stable
  methods:
  - z_sendmany
  - z_shieldcoinbase
  - z_listreceivedbyaddress
  - z_listunspent
- label: Async Operations
  maturity: stable
  methods:
  - z_getoperationresult
  - z_getoperationstatus
  - z_listoperationids