sweep همین الان

POST/v1/sweeps

یک گروه یا یک آدرس را طبق قانون گروه همین الان sweep می‌کند. دقیقاً یکی از group_id و address_id را بفرستید. اگر درخواست قبلی همان هدف هنوز باز باشد، همان برمی‌گردد.

دسترسی لازم

sweep

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

6 برای هر کلید

درخواست

curl

curl -X POST 'https://api.romu.ir/v1/sweeps' \
  -H "X-Custody-Key-Id: $KEY_ID" \
  -H "X-Custody-Timestamp: $TIMESTAMP" \
  -H "X-Custody-Nonce: $NONCE" \
  -H "X-Custody-Signature: $SIGNATURE" \
  -H "Content-Type: application/json" \
  -d '{
    "group_id": "01926e00-0000-7000-8000-000000000201"
  }'

TypeScript

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

const res = await romu.post("/v1/sweeps", {
  json: {
    "group_id": "01926e00-0000-7000-8000-000000000201"
  },
});
console.log(res.status, res.body);

Go

status, body, err := client.Do("POST", "/v1/sweeps", "", []byte(`{"group_id":"01926e00-0000-7000-8000-000000000201"}`), "")

Python

import romu

status, body = romu.post(
    "/v1/sweeps",
    json={
      "group_id": "01926e00-0000-7000-8000-000000000201"
    },
)
print(status, body)

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

بدنه

group_idUUID

address_idUUID

فیلد ناشناخته در بدنه 400 می‌گیرد.

پاسخ

200درخواست قبلی هنوز باز است و همان برگشت (created برابر false⁠).

201درخواست تازه ثبت شد.

فیلدها

createdbooleanلازم

requestobjectلازم

request.idstring

request.wallet_idstring

request.group_idstring

request.address_idstring | null

request.doneboolean

request.sweeps_madeinteger

request.created_atRFC 3339

request.done_atRFC 3339 | null

خطاها

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

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

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

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

409failed precondition⁠: این کار در وضعیت فعلی ممکن نیست.

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

503try again later⁠، org_paused (سازمان موقتاً متوقف شده، با Retry-After: 60⁠)، یا در ثبت برداشت suspension_unknown (با Retry-After: 5⁠). همان درخواست را با همان Idempotency-Key دوباره بفرستید.

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