یک کیف پول یا فهرست کیف پول‌ها

GET/v1/wallets

با id یک کیف پول را برمی‌گرداند، با همه‌ی شبکه‌ها و آدرس هر کدام. بی id یک صفحه از کیف پول‌های همین کلید را می‌دهد. آماده بودن هر شبکه در readiness است.

دسترسی لازم

readیاwithdraw

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

120 برای هر کلید

درخواست

curl

curl 'https://api.romu.ir/v1/wallets?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/wallets", {
  query: "limit=50",
});
console.log(res.status, res.body);

Go

status, body, err := client.Get("/v1/wallets", "limit=50")

Python

import romu

status, body = romu.get(
    "/v1/wallets",
    query="limit=50",
)
print(status, body)

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

پارامترهای query

idUUID

شناسه‌ی کیف پول. با این پارامتر پاسخ فقط همان کیف پول است.

networkstring

فقط کیف پول‌هایی که روی این شبکه هستند.TRONBSC

cursorstring

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

limitinteger

1 تا 200.

پاسخ

200یک کیف پول (با id⁠) یا یک صفحه.

نمونه

{
  "wallets": [
    {
      "wallet_id": "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
      "name": "کیف پول گرم",
      "status": "active",
      "networks": [
        {
          "network": "TRON",
          "address": "TKyu1LVaqp8EAbcxBoRTvsm5cp7wpbBWdg",
          "readiness": "ready"
        },
        {
          "network": "BSC",
          "address": "0x6dD2A6f3b05fD15d901fBEeC61b87a34BdCFb843",
          "readiness": "ready"
        }
      ],
      "value": {
        "usd_total": "126.25",
        "unpriced_count": 0,
        "oldest_read_at": "2026-10-14T07:10:00Z"
      }
    }
  ],
  "next_cursor": ""
}

فیلدها با id

wallet_idUUIDلازم

namestringلازم

statusstringلازم

keygenawaiting_backup_confirmationactivefrozenretired

networksobject[]لازم

شبکه‌های کیف پول.

networks[].networkstringلازم

TRONBSC

networks[].addressstringلازم

آدرس اصلی کیف پول روی این شبکه. روی شبکه‌های EVM به شکل EIP-55. در حالت preparing خالی است.

networks[].readinessstringلازم

preparing یعنی شبکه تازه اضافه شده یا کیف پول هنوز در حال ساخت کلید است؛ آدرس خالی است و برداشت روی آن رد می‌شود.readypreparing

فیلدها بی id

walletsobject[]لازم

wallets[].wallet_idUUIDلازم

wallets[].namestringلازم

wallets[].statusstringلازم

keygenawaiting_backup_confirmationactivefrozenretired

wallets[].networksobject[]لازم

شبکه‌های کیف پول.

wallets[].networks[].networkstringلازم

TRONBSC

wallets[].networks[].addressstringلازم

آدرس اصلی کیف پول روی این شبکه. روی شبکه‌های EVM به شکل EIP-55. در حالت preparing خالی است.

wallets[].networks[].readinessstringلازم

preparing یعنی شبکه تازه اضافه شده یا کیف پول هنوز در حال ساخت کلید است؛ آدرس خالی است و برداشت روی آن رد می‌شود.readypreparing

wallets[].valueobject

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

wallets[].value.usd_totalstring | null

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

wallets[].value.unpriced_countinteger

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

wallets[].value.oldest_read_atRFC 3339 | null

next_cursorstringلازم

در صفحه‌ی آخر خالی است.

خطاها

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

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

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

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

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

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

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