وب سرویس بازار ارز دیجیتال (کیف پول)
در مقاله های قبل در مورد اطلاعات کاربری و احراز هویت وب سرویس ارز دیجیتال و همچنین وب سرویس اطلاعات بازار ارز دیجیتال صحبت کردیم در این مقاله در مورد API بازار ارز دیجیتال (کیف پول) صحبت خواهیم کرد.
کیف پول‌های کاربر
لیست کیف پول ها
برای دریافت لیست کیف پول های کاربر از این نوع درخواست استفاده نمایید:
آدرس :
POST /users/wallets/list
curl ‘https://api.nobitex.ir/users/wallets/list’ \
-X POST \
–header “Authorization: Token e9282e56c83f93eb077043e5ad8b6cf5b3ff7568”
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
“status”: “ok”,
“wallets”: [
{
“activeBalance”: “10.2649975000”,
“blockedBalance”: “0”,
“user”: “name@example.com”,
“currency”: “ltc”,
“id”: 4159,
“balance”: “10.2649975000”,
“rialBalance”: 51322935,
“rialBalanceSell”: 52507310,
“depositAddress”: null
},
…
]
}
موجودی
برای دریافت آخرین آمار بازار نوبیتکس از این نوع درخواست استفاده نمایید:
آدرس :
POST /users/wallets/balance
پارامترها
| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
| currency | string | الزامی | نوع کیف پول(ارز) | ltc |
لیست تراکنش‌ها
برای دریافت آخرین آمار بازار نوبیتکس از این نوع درخواست استفاده نمایید:
آدرس :
POST /users/wallets/transactions/list
پارامترها
| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
| wallet | int | الزامی | شناسه کیف پول(id) | 4159 |
curl ‘https://api.nobitex.ir/users/wallets/transactions/list’ \
-X POST \
-H “Authorization: Token e9282e56c83f93eb077043e5ad8b6cf5b3ff7568” \
-H “content-type: application/json” \
–data ‘{“wallet”:”4159″}’
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
“transactions”: [
{
“currency”: “ltc”,
“created_at”: “2018-10-17T09:41:08.519151+00:00”,
“calculatedFee”: “0”,
“id”: 99050,
“amount”: “4.3802000000”,
“description”: “خرید 4.400 LTC به قیمت واحد ﷼7450000”
},
{
“currency”: “ltc”,
“created_at”: “2018-10-04T13:05:01.384902+00:00”,
“calculatedFee”: “0”,
“id”: 96541,
“amount”: “-1.0000000000”,
“description”: “Withdraw to \”Lgn1zc77mEjk72KvXPqyXq8K1mAfcDE6YR\””
},
…
],
“status”: “ok”
}
لیست واریزها و برداشت‌ها
برای دریافت لیست واریزها و برداشت‌ها از این نوع درخواست استفاده نمایید:
آدرس :
POST /users/wallets/deposits/list
پارامترها
| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
| wallet | string | all | شناسه کیف پول(id) | 4159 |
curl ‘https://api.nobitex.ir/users/wallets/deposits/list’ \
-X POST \
-H “Authorization: Token e9282e56c83f93eb077043e5ad8b6cf5b3ff7568” \
-H “content-type: application/json” \
–data ‘{“wallet”:”4159″}’
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
“status”: “ok”,
“deposits”: [
{
“txHash”: “c5d84268a0bf02307b5a0460a68b61987a9b3009d3a82a817e41558e619ec1d2”,
“address”: “32KfyTNh162UoKithfDrWHZPYq5uePGmf7”,
“confirmed”: true,
“transaction”: {
“id”: 10,
“amount”: “3.0000000000”,
“currency”: “btc”,
“description”: “Deposit – address:36n452uGq1x4mK7bfyZR8wgE47AnBb2pzi, tx:c5d84268a0bf02307b5a0460a68b61987a9b3009d3a82a817e41558e619ec1d2”,
“created_at”: “2018-11-06T03:56:18+00:00”,
“calculatedFee”: “0”
},
“currency”: “Bitcoin”,
“blockchainUrl”: “https://btc.com/c5d84268a0bf02307b5a0460a68b61987a9b3009d3a82a817e41558e619ec1d2”,
“confirmations”: 2,
“requiredConfirmations”: 3,
“amount”: “3.0000000000”
}
],
“withdraws”: [
{
“id”: 2398,
“blockchain_url”: “https://live.blockcypher.com/ltc/tx/c1ed4229e598d4cf81e99e79fb06294a70af39443e2639e22c69bc30d6ecda67/”,
“is_cancelable”: false,
“status”: “Done”,
“amount”: “1.0000000000”,
“createdAt”: “2018-10-04T12:59:38.196935+00:00”,
“wallet_id”: 4159,
“currency”: “ltc”,
“address”: “Lgn1zc77mEjk72KvXPqyXq8K1mAfcDE6YR”
}
]
}
تولید آدرس بلاکچین
برای تولید آدرس بلاکچین از این نوع درخواست استفاده نمایید:
آدرس :
POST /users/wallets/generate-address
پارامترها
| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
| wallet | string | الزامی | شناسه کیف پول(id) | 4159 |
curl ‘https://api.nobitex.ir/users/wallets/generate-address’ \
-X POST \
-H “Authorization: Token e9282e56c83f93eb077043e5ad8b6cf5b3ff7568” \
-H “content-type: application/json” \
–data ‘{“wallet”:”4159″}’
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
“status”: “ok”,
“address”: “LRf3vuTMy4UwD5b72G84hmkfGBQYJeTwUs”
}
محدودیت فراخوانی : 6 درخواست در ساعت
راهنمای اشکال‌یابی
- به نوع درخواست دقت کنید، احتمال دارد درخواست از نوع HTTP POST باشد و شما از GET استفاده کرده باشید.
- آدرس API را مجددا بررسی نمایید. همچنین به وجود یا عدم وجود / در انتهای آدرس دقت کنید.
اعتبارسنجی دو عاملی
در صورتی که اعتبارسنجی دو عاملی (2 Factor Authentication) را برای حساب خود فعال کرده باشید، باید در هنگام استفاده از برخی APIها، به خصوص در هنگام دریافت توکن از API لاگین، علاوه بر سایر پارامترها، رمز یک‌بار مصرف خود را نیز در هدرهای درخواست به این صورت ارسال نمایید: X-TOTP: 123456.
محدودیت‌های فراخوانی API
برخی از APIهای نوبیتکس دارای محدودیت تعداد فراخوانی در هر بازه‌ی زمانی هستند. با این حال اگر شما به صورت معمولی و مشابه استفاده‌ی متداول کاربران از API استفاده کنید، با این محدودیت‌ها مواجه نخواهید شد. محدودیت‌ها به ازای هر API مستقلا محاسبه و اعمال می‌شوند. محدودیت‌ها معمولا بر اساس آدرس IP درخواست دهنده و در موارد هم بر اساس کاربر (توکن) درخواست دهنده می‌باشند. در حالتی که به حد مجاز تعداد فراخوانی یک API رسیده باشید، پاسخ آن API به شما یک پیام خطا با کد 403 و دارای توضیحات مشخص در خصوص آن محدودیت خواهد بود.
در صورتی که به صورت موردی یا در حین تست کد خود به محدودیتی برخورد کردید، می‌توانید با منتظر ماندن (بین یک ساعت تا یک روز) آن محدودیت را برطرف کنید و دوباره امکان استفاده از API مد نظرتان را داشته باشید. اگر به صورت مداوم به محدودیتی برای یک API برخورد می‌کنید و فکر می‌کنید که بهتر است تعداد فراخوانی مجاز آن API افزایش یابد، حتما با ایجاد یک مورد در گیت‌هاب (لینک ایجاد مورد) مسئله را با ما مطرح نمایید.
توضیح پیام‌های خطا
| کد HTTP | توضیحات |
| 400 | Bad Request — پارامترهای درخواست نادرست یا ناکافی است |
| 403 | Forbidden — انجام این عملیات مجاز نمی‌باشد |
| 404 | Not Found — آدرس یا شی مد نظر وجود ندارد |
| 500 | Internal Server Error — مشکلی به صورت موقت در سرور نوبیتکس رخ داده است |