گروه‌های آدرس

GET/v1/address-groups

گروه‌های آدرس یک کیف پول. قانون sweep روی گروه تعریف می‌شود.

دسترسی لازم

read

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

120 برای هر کلید

درخواست

curl

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

Go

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

Python

import romu

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

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

پارامترهای query

wallet_idUUIDلازم

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

پاسخ

200گروه‌ها.

نمونه

{
  "groups": [
    {
      "id": "01926e00-0000-7000-8000-000000000201",
      "wallet_id": "0192f19f-1d2c-7f3b-8a4e-6b7c8d9e0f12",
      "name": "users",
      "status": "active",
      "created_at": "2026-10-01T09:00:00Z"
    }
  ]
}

فیلدها

groupsobject[]لازم

groups[].idUUID

groups[].wallet_idUUID

groups[].namestring

groups[].statusstring

activearchived

groups[].created_atRFC 3339

خطاها

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

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

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

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

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

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

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