الاستخدام ورصيد الائتمان
اقرأ استخدامك لواجهة API منذ بداية الشهر ورصيد ائتمانك الحالي.
GET /v1/usageيتطلّب مفتاح API صالحًا وعضويّة نشطة. وعلى خلاف نقاط نهاية البحث، هذه النقطة غير مشروطة بالائتمان — يمكنك دائمًا قراءة رصيدك، حتى حين يكون فارغًا — وهي لا تستهلك ائتمانًا.
معاملات الاستعلام
لا شيء.
الاستجابة
{
"period_start": "2026-06-01T00:00:00Z",
"requests": 1284,
"billable_units": 1310,
"credits": {
"balance_cents": 4250,
"balance": 42.50,
"currency": "usd",
"included_cents": 0,
"purchased_cents": 4250,
"estimated_requests_remaining": 2125,
"auto_reload_enabled": true
}
}
| الحقل | النوع | الوصف |
|---|---|---|
period_start |
string (ISO 8601, UTC) | بداية فترة استخدام الشهر الميلادي الجارية. |
requests |
integer | طلبات واجهة API المسجّلة حتى الآن في هذه الفترة. |
billable_units |
integer | الوحدات القابلة للفوترة المستهلكة في هذه الفترة (قد يفوتر طلب واحد أكثر من وحدة عندما ينتشر في عدّة عمليات جلب من المنبع). |
credits.balance_cents |
integer | إجمالي الرصيد المتبقّي، بوحدات العملة الصغرى. |
credits.balance |
number | إجمالي الرصيد المتبقّي، بالوحدات الكبرى. |
credits.currency |
string | رمز عملة ISO (مثل USD، GBP). |
credits.included_cents |
integer | الرصيد المتبقّي من المخصّص الشهري لعضويّتك. |
credits.purchased_cents |
integer | الرصيد المتبقّي من الائتمان الذي اشتريته. |
credits.estimated_requests_remaining |
integer | العدد التقريبي للطلبات الإضافية التي يغطّيها رصيدك. |
credits.auto_reload_enabled |
boolean | ما إذا كانت إعادة التعبئة التلقائية مفعَّلة في حسابك. |
أمثلة
curl "https://api.suede.io/v1/usage" \ -H "Authorization: Bearer $SUEDE_API_KEY"
using var http = new HttpClient(); http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY")); var json = await http.GetStringAsync("https://api.suede.io/v1/usage"); Console.WriteLine(json);
const res = await fetch("https://api.suede.io/v1/usage", { headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` }, }); const usage = await res.json(); console.log(`Balance: ${usage.credits.balance} ${usage.credits.currency}`);
يُعاد الرصيد نفسه في كلّ استجابة قابلة للفوترة عبر ترويستي X-Credits-Balance و
X-Credits-Requests-Remaining — راجع الأخطاء.