قانون‌های sweep

GET/v1/sweep-rules

قانون‌های sweep کیف پول‌های این کلید. گروه بی قانون sweep نمی‌شود.

دسترسی لازم: read
سقف نرخ در دقیقه: 120 برای هر کلید

درخواست

curl 'https://api.romu.ir/v1/sweep-rules' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE"

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

const res = await romu.get("/v1/sweep-rules");
console.log(res.status, res.body);

status, body, err := client.Get("/v1/sweep-rules", "")

import romu

status, body = romu.get(
    "/v1/sweep-rules",
)
print(status, body)

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

پارامترهای query

wallet_idUUID

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

group_idUUID

شناسه‌ی گروه.

پاسخ

200قانون‌ها.

فیلدها

rulesobject[]لازم

rules[].wallet_idstring

rules[].group_idstring

rules[].groupstring

rules[].enabledboolean

rules[].scheduleobject

rules[].schedule.kindstringلازم

intervaldailymanual

rules[].schedule.every_hoursinteger

1 تا 24، فقط برای interval⁠.

rules[].schedule.hoursinteger[]

1 تا 24 ساعت از 0 تا 23، مرتب و بی تکرار، فقط برای daily⁠.

rules[].schedule.timezonestring

نام IANA، فقط برای daily⁠.

rules[].min_amountsobject[]

rules[].min_amounts[].assetstring

rules[].min_amounts[].amountstring

rules[].excluded_assetsstring[]

rules[].versioninteger

rules[].updated_atRFC 3339 | null

rules[].last_run_atRFC 3339 | null

rules[].next_run_atRFC 3339 | null

خطاها

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

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

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

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

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

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