Skip to content

API reference

Platform

Supply and integrity figures.

get/api/v1/reconcile

Platform-wide supply integrity check

NOT your account statement. This compares on-chain totalSupply against every tracked wallet on the platform. It reads each wallet from chain, so latency grows with walletsChecked: call it on a schedule, never in a request path.

Responses

  • 200The comparison.Show fields
    • onChainSupplyTzsinteger

      Whole Tanzanian shillings. Never a decimal.

    • dbTotalBalanceTzsinteger

      Whole Tanzanian shillings. Never a decimal.

    • differenceinteger
    • isReconciledboolean

      True when |difference| is under 1 TZS.

    • walletsCheckedinteger
    • contractAddressstring
    • chainstring
  • 400Invalid request.CodeError
  • 401Missing, empty, or invalid API key. No machine-readable code is returned.BareError
  • 403Forbidden: a missing capability, unapproved KYB, a source IP outside your allowlist, or a frozen wallet.CodeError
  • 429Rate limited. Respect Retry-After and back off exponentially.CodeError
  • 503A rail or dependency is unavailable. Nothing moved; retry with backoff.CodeError
Request
curl "https://www.ntzs.co.tz/api/v1/reconcile" \
  -H "Authorization: Bearer $NTZS_API_KEY"
Response · 200
{
  "onChainSupplyTzs": 10000,
  "dbTotalBalanceTzs": 10000,
  "difference": 1,
  "isReconciled": true,
  "walletsChecked": 1,
  "contractAddress": "0x531B87EfdEBD19bfd05700DF6218d4786Cf2201C",
  "chain": "…"
}
get/api/v1/supply

Total nTZS in circulation

Responses

  • 200Circulating supply.object
  • 400Invalid request.CodeError
  • 401Missing, empty, or invalid API key. No machine-readable code is returned.BareError
  • 403Forbidden: a missing capability, unapproved KYB, a source IP outside your allowlist, or a frozen wallet.CodeError
  • 429Rate limited. Respect Retry-After and back off exponentially.CodeError
  • 503A rail or dependency is unavailable. Nothing moved; retry with backoff.CodeError
Request
curl "https://www.ntzs.co.tz/api/v1/supply" \
  -H "Authorization: Bearer $NTZS_API_KEY"