مصرف ماهانه

GET/v1/usage

برداشت‌های قطعی‌شده را به تفکیک ماه UTC، شبکه و دارایی می‌دهد. بی بازه، 12 ماه آخر را می‌دهد و حداکثر بازه 24 ماه است.

دسترسی لازم

read

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

120 برای هر کلید

درخواست

curl

curl 'https://api.romu.ir/v1/usage?from=2026-09&to=2026-10' \
  -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/usage", {
  query: "from=2026-09&to=2026-10",
});
console.log(res.status, res.body);

Go

status, body, err := client.Get("/v1/usage", "from=2026-09&to=2026-10")

Python

import romu

status, body = romu.get(
    "/v1/usage",
    query="from=2026-09&to=2026-10",
)
print(status, body)

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

پارامترهای query

fromstring

ماه شروع، YYYY-MM⁠.

tostring

ماه پایان، YYYY-MM⁠.

پاسخ

200مصرف.

فیلدها

planstringلازم

monthsobject[]لازم

months[].periodstring

YYYY-MM⁠.

months[].closed_atRFC 3339 | null

ماه باز null است.

months[].networksobject[]

months[].networks[].networkstring

months[].networks[].usd_amountstring

months[].networks[].unpriced_countinteger

months[].networks[].assetsobject[]

months[].networks[].assets[].assetstring

کد دارایی.

months[].networks[].assets[].confirmed_countinteger

months[].networks[].assets[].amount_sumstring

months[].networks[].assets[].usd_amountstring

months[].networks[].assets[].unpriced_countinteger

months[].networks[].assets[].failed_countinteger

address_usageobject[]لازم

address_usage[].periodstring

address_usage[].active_countinteger

خطاها

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

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

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

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

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

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