پرش به مطلب اصلی

کیف پول

این بخش از مستندات بهت اجازه می‌ده تا میزان موجودی کیف پول خودت رو برای ارزهای مختلف مشاهده کنی.
با استفاده از این API می‌تونی موجودی ارزها رو به تفکیک مشاهده کنی و بر اساس نیازت فیلترشون کنی.

🔗 Endpoint

GET /api/v1/wlt/wallets/

Rate Limit

اطلاعیه

60 درخواست در دقیقه

📨 Request

با استفاده از این درخواست و احراز هویت، موجودی کیف پول‌های خودت رو برای ارزهای مختلف بررسی کن:

curl --location --request GET 'https://api.bitpin.ir/api/v1/wlt/wallets/' \  
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi...k2WQfz8Gugx6DumU067k8wl--s'

🛠 Request Params

برای فیلتر کردن نتایج می‌تونی از پارامترهای زیر استفاده کنی:

ParameterDescriptionTypeRequired
assetsنام دارایی مثل: BTC, IRT, USDTStringخیر
serviceنام سرویس دارایی مثل: mainStringخیر
offsetشناسه‌هایی که از این مقدار کمتر باشهIntegerخیر
limitحداکثر تعداد شناسه‌های دریافتی (حداکثر 200)Integerخیر

💬 Success Response

اگه درخواست موفقیت‌آمیز باشه، پاسخ به شکل زیر خواهد بود:

[  
{
"id": 3108164,
"asset": "RIAL",
"balance": "1671.6",
"frozen": "0.0",
"service": "main"
},
{
"id": 3108166,
"asset": "CELR",
"balance": "5631.6",
"frozen": "0.0",
"service": "main"
}
]

📝 Response Keys

توضیح کلیدهای پاسخ:

  • id: شناسه دارایی
  • asset: نام دارایی (رمزارز)
  • balance: موجودی کل دارایی
  • frozen: موجودی مسدود شده (درگیر در سفارشات یا تراکنش‌های تایید نشده)
  • service: نام سرویس (مثلاً main)

Additional Notes

  • با استفاده از این API می‌تونی به‌راحتی موجودی کیف پول‌های مختلف خودت رو بررسی کنی و وضعیت مالی خودت رو به‌صورت دقیق کنترل کنی.