موجودی هر آدرس

GET/v1/addresses/balances

یک صفحه از آدرس‌های کیف پول با موجودی هر کدام. مبلغ "0" یعنی آدرس چیزی ندارد و null یعنی موجودی هنوز معلوم نیست.

دسترسی لازم

read

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

120 برای هر کلید

درخواست

curl

curl 'https://api.romu.ir/v1/addresses/balances?wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12&sort=value&limit=50' \
  -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/addresses/balances", {
  query: "wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12&sort=value&limit=50",
});
console.log(res.status, res.body);

Go

status, body, err := client.Get("/v1/addresses/balances", "wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12&sort=value&limit=50")

Python

import romu

status, body = romu.get(
    "/v1/addresses/balances",
    query="wallet_id=0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12&sort=value&limit=50",
)
print(status, body)

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

پارامترهای query

wallet_idUUIDلازم

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

address_idUUID

فقط همین آدرس.

kindstring

maindepositsweep

assetstring

فقط آدرس‌هایی که از این دارایی بیش از صفر دارند، مثل TRON_USDT⁠.

sortstring

cursor یک ترتیب با ترتیب دیگر 400 است.valuelast_activity

networkstring

TRONBSC

qstring

بخشی از آدرس یا برچسب، 1 تا 64 نویسه.

nonzeroboolean

فقط آدرس‌هایی که چیزی دارند.

cursorstring

مقدار next_cursor پاسخ قبلی.

limitinteger

1 تا 200. پیش‌فرض 50.

پاسخ

200یک صفحه از آدرس‌ها.

نمونه

{
  "addresses": [
    {
      "address_id": "01926e00-0000-7000-8000-000000000411",
      "wallet_id": "01926e00-0000-7000-8000-000000000101",
      "kind": "deposit",
      "network": "TRON",
      "address": "TE48BLyVNUSHicSrpwaoRh4SQqXSkoG5S5",
      "label": "vip-customers",
      "status": "active",
      "group_id": "01926e00-0000-7000-8000-000000000201",
      "total": {
        "usd_total": "26.25",
        "unpriced_count": 0,
        "oldest_read_at": "2026-10-14T07:10:00Z"
      },
      "assets": [
        {
          "asset": "TRON_USDT",
          "network": "TRON",
          "amount": "25",
          "usd_value": "25",
          "rate_usd": "1",
          "read_at": "2026-10-14T07:10:00Z"
        }
      ],
      "last_activity_at": "2026-10-14T06:58:00Z"
    }
  ],
  "next_cursor": "",
  "total": 1
}

فیلدها

addressesobject[]لازم

addresses[].address_idstring

addresses[].wallet_idstring

addresses[].kindstring

maindepositsweep

addresses[].networkstring

TRONBSC

addresses[].addressstring | null

فقط وقتی watch برابر watched است پر است. در غیر این صورت null است.

addresses[].labelstring

addresses[].statusstring

activearchived

addresses[].group_idstring

addresses[].totalobject

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

addresses[].total.usd_totalstring | null

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

addresses[].total.unpriced_countinteger

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

addresses[].total.oldest_read_atRFC 3339 | null

addresses[].assetsobject[]

فقط دارایی‌های بیش از صفر.

addresses[].assets[].assetstringلازم

کد دارایی، مثل TRON_USDT⁠.

addresses[].assets[].networkstringلازم

TRONBSC

addresses[].assets[].amountstringلازم

رشته‌ی اعشاری در واحد خود دارایی، مثل 100.5⁠.

addresses[].assets[].usd_valuestring | null

ارزش دلاری، هرگز صفر به جای «بی نرخ».

addresses[].assets[].rate_usdstring | null

addresses[].assets[].read_atRFC 3339 | null

addresses[].last_activity_atRFC 3339 | null

addresses[].watchstring | null

همان watch آدرس (GET /v1/addresses⁠). اگر خوانده نشد null است و address هم null است.pendingwatched

next_cursorstringلازم

totalinteger | nullلازم

خطاها

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

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

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

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

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

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

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