یک آدرس یا فهرست آدرس‌ها

GET/v1/addresses

با id یک آدرس را می‌دهد. بی id یک صفحه می‌دهد. total فقط در صفحه‌ی اول عدد است و در صفحه‌های بعد null⁠. فهرست به ازای هر رکورد آدرس صفحه‌بندی می‌شود و با next_cursor جلو می‌رود. هر رکورد برای هر شبکه حداکثر یک ورودی در addresses دارد، پس امروز حداکثر دو تا. اندازه‌ی صفحه پیش‌فرض 50 و حداکثر 200 است.

دسترسی لازم

read

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

120 برای هر کلید

درخواست

curl

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

Go

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

Python

import romu

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

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

پارامترهای query

idUUID

شناسه‌ی آدرس.

wallet_idUUID

شناسه‌ی کیف پول، مثل 0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12⁠.

groupstring

نام گروه.

labelstring

پیشوند برچسب.

statusstring

activearchived

kindstring

maindepositsweepfee

cursorstring

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

limitinteger

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

پاسخ

200یک آدرس (با id⁠) یا یک صفحه.

نمونه

{
  "addresses": [
    {
      "id": "0192f1b2-3333-7f3b-8a4e-6b7c8d9e0f01",
      "wallet_id": "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
      "group_id": "01926e00-0000-7000-8000-000000000201",
      "group": "users",
      "kind": "deposit",
      "label": "vip-customers",
      "status": "active",
      "addresses": [
        {
          "network": "TRON",
          "address": "TE48BLyVNUSHicSrpwaoRh4SQqXSkoG5S5"
        }
      ],
      "created_at": "2026-10-01T09:00:00Z",
      "archived_at": null
    }
  ],
  "next_cursor": "",
  "total": 1
}

فیلدها با id

addressobjectلازم

address.idUUIDلازم

address.wallet_idUUIDلازم

address.group_idstring

address.groupstring

address.kindstringلازم

maindepositsweepfee

address.labelstring

address.statusstringلازم

activearchived

address.addressesobject[]لازم

یک آدرس روی یک شبکه همه‌ی دارایی‌های آن شبکه را می‌گیرد. فهرست دارایی‌ها در GET /v1/assets است.

address.addresses[].networkstringلازم

TRONBSC

address.addresses[].addressstring | nullلازم

روی شبکه‌های EVM به شکل EIP-55. تا وقتی watch آدرس pending است null است: آدرس را تا ثبت شدنش در فهرست پایش نشان ندهید و پول به آن نفرستید.

address.created_atRFC 3339

address.archived_atRFC 3339 | null

address.watchstring

pending⁠: هنوز در فهرست پایش شبکه ثبت نشده (معمولاً چند ثانیه؛ رومو خودش دوباره تلاش می‌کند) و متن آدرس تا آن وقت null است. واریزی که در این فاصله برسد، پس از ثبت پیدا و ثبت می‌شود. watched⁠: پایش می‌شود.pendingwatched

فیلدها بی id

addressesobject[]لازم

addresses[].idUUIDلازم

addresses[].wallet_idUUIDلازم

addresses[].group_idstring

addresses[].groupstring

addresses[].kindstringلازم

maindepositsweepfee

addresses[].labelstring

addresses[].statusstringلازم

activearchived

addresses[].addressesobject[]لازم

یک آدرس روی یک شبکه همه‌ی دارایی‌های آن شبکه را می‌گیرد. فهرست دارایی‌ها در GET /v1/assets است.

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

TRONBSC

addresses[].addresses[].addressstring | nullلازم

روی شبکه‌های EVM به شکل EIP-55. تا وقتی watch آدرس pending است null است: آدرس را تا ثبت شدنش در فهرست پایش نشان ندهید و پول به آن نفرستید.

addresses[].created_atRFC 3339

addresses[].archived_atRFC 3339 | null

addresses[].watchstring

pending⁠: هنوز در فهرست پایش شبکه ثبت نشده (معمولاً چند ثانیه؛ رومو خودش دوباره تلاش می‌کند) و متن آدرس تا آن وقت null است. واریزی که در این فاصله برسد، پس از ثبت پیدا و ثبت می‌شود. watched⁠: پایش می‌شود.pendingwatched

next_cursorstringلازم

totalinteger | nullلازم

خطاها

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

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

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

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

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

500internal error⁠: آدرس نشان داده نشد. به رومو خبر دهید.

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

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