خلاصه‌ی موجودی کیف پول

GET/v1/wallets/balance-summary

موجودی کیف پول را در سه دسته می‌دهد. main آدرس اصلی، sweep آدرس‌های sweep، و unswept آدرس‌های واریز یعنی آنچه هنوز sweep نشده است.

دسترسی لازم

readیاwithdraw

سقف نرخ در دقیقه

120 برای هر کلید

درخواست

curl

curl 'https://api.romu.ir/v1/wallets/balance-summary?wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE"

TypeScript

import { romu } from "./romu.ts";

const res = await romu.get("/v1/wallets/balance-summary", {
  query: "wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
});
console.log(res.status, res.body);

Go

status, body, err := client.Get("/v1/wallets/balance-summary", "wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12")

Python

import romu

status, body = romu.get(
    "/v1/wallets/balance-summary",
    query="wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
)
print(status, body)

امضای درخواست را کتابخانه انجام می‌دهد؛ جزئیات: صفحه‌ی امضا

پارامترهای query

wallet_idUUIDلازم

شناسه‌ی کیف پول.

پاسخ

200سه دسته با یک شکل.

نمونه

{
  "main": {
    "total": {
      "usd_total": "100",
      "unpriced_count": 0,
      "oldest_read_at": "2026-10-14T07:10:00Z"
    },
    "assets": [],
    "address_count": 1,
    "unread_count": 0
  },
  "sweep": {
    "total": {
      "usd_total": "0",
      "unpriced_count": 0,
      "oldest_read_at": "2026-10-14T07:10:00Z"
    },
    "assets": [],
    "address_count": 1,
    "unread_count": 0
  },
  "unswept": {
    "total": {
      "usd_total": "125",
      "unpriced_count": 0,
      "oldest_read_at": "2026-10-13T08:00:00Z"
    },
    "assets": [
      {
        "asset": "TRON_USDT",
        "network": "TRON",
        "amount": "125",
        "usd_value": "125",
        "holder_count": 4
      }
    ],
    "address_count": 40,
    "unread_count": 2
  }
}

فیلدها

mainobjectلازم

main.totalobject

ارزش دلاری، فقط برای نمایش.

main.total.usd_totalstring | null

جمع ارزش دارایی‌های ارزش‌دار، رشته‌ی اعشاری. null یعنی هنوز خوانده نشده.

main.total.unpriced_countinteger

دارایی‌هایی که نرخ قابل استفاده ندارند.

main.total.oldest_read_atRFC 3339 | null

main.assetsobject[]

main.assets[].assetstring

main.assets[].networkstring

TRONBSC

main.assets[].amountstring

main.assets[].usd_valuestring | null

main.assets[].holder_countinteger

تعداد آدرس‌هایی که بیش از صفر دارند.

main.address_countinteger

main.unread_countinteger

آدرس‌هایی که هنوز خوانده نشده‌اند.

sweepobjectلازم

sweep.totalobject

ارزش دلاری، فقط برای نمایش.

sweep.total.usd_totalstring | null

جمع ارزش دارایی‌های ارزش‌دار، رشته‌ی اعشاری. null یعنی هنوز خوانده نشده.

sweep.total.unpriced_countinteger

دارایی‌هایی که نرخ قابل استفاده ندارند.

sweep.total.oldest_read_atRFC 3339 | null

sweep.assetsobject[]

sweep.assets[].assetstring

sweep.assets[].networkstring

TRONBSC

sweep.assets[].amountstring

sweep.assets[].usd_valuestring | null

sweep.assets[].holder_countinteger

تعداد آدرس‌هایی که بیش از صفر دارند.

sweep.address_countinteger

sweep.unread_countinteger

آدرس‌هایی که هنوز خوانده نشده‌اند.

unsweptobjectلازم

unswept.totalobject

ارزش دلاری، فقط برای نمایش.

unswept.total.usd_totalstring | null

جمع ارزش دارایی‌های ارزش‌دار، رشته‌ی اعشاری. null یعنی هنوز خوانده نشده.

unswept.total.unpriced_countinteger

دارایی‌هایی که نرخ قابل استفاده ندارند.

unswept.total.oldest_read_atRFC 3339 | null

unswept.assetsobject[]

unswept.assets[].assetstring

unswept.assets[].networkstring

TRONBSC

unswept.assets[].amountstring

unswept.assets[].usd_valuestring | null

unswept.assets[].holder_countinteger

تعداد آدرس‌هایی که بیش از صفر دارند.

unswept.address_countinteger

unswept.unread_countinteger

آدرس‌هایی که هنوز خوانده نشده‌اند.

خطاها

400invalid request یا malformed request body⁠: بدنه، پارامتر یا فیلد نادرست است، یا فیلد ناشناخته دارد.

401unauthenticated⁠: هر شکست احراز هویت همین پاسخ را دارد.

403permission denied⁠: کلید دسترسی این مسیر را ندارد.

404not found⁠: مسیر یا شیء پیدا نشد. خواندن کیف پولی بیرون از فهرست کلید هم همین است.

429too many requests⁠: بیش از سقف نرخ. پس از Retry-After ثانیه دوباره بفرستید.

503try again later⁠: سرویس موقتاً در دسترس نیست.

بدنه‌ی خطا همیشه {"error":"..."} است. راهنمای خطاها می‌گوید برای هر کد چه باید کرد.