API V1 Instruments

فهرستی از تمام ابزارهای فعال موجود برای مبادله در پلتفرم Quickex را بازمی‌گرداند.
یک ابزار نشان‌دهنده یک ارز مشخص و شبکه‌ای است که آن ارز روی آن عمل می‌کند
(برای مثال USDT (TRC20)، BTC (BTC)، EUR (SEPA)).
این داده‌ها می‌توانند برای نمایش فهرست ارزها در رابط کاربری مبادله استفاده شوند.

URL

https://quickex.io/api/v1/instruments/public

پارامترها

هیچ‌کدام

نمونه درخواست (cURL)

curl -X GET \
  'https://quickex.io/api/v1/instruments/public' \
  -H 'Accept: application/json'

نمونه پاسخ (200)

[
  {
    "currencyTitle": "GHS",
    "networkTitle": "GHS",
    "slug": "ghsghs",
    "currencyFriendlyTitle": "سدی غنا",
    "precisionDecimals": 2,
    "currencyLogoLink": "https://s2.coinmarketcap.com/static/img/coins/64x64/3540.png",
    "requiresMemo": false,
    "instrumentType": "fiat",
    "bestChangeName": ""
  },
  {
    "currencyTitle": "HUF",
    "networkTitle": "HUF",
    "slug": "hufhuf",
    "currencyFriendlyTitle": "فورینت مجارستان",
    "precisionDecimals": 2,
    "currencyLogoLink": "https://s2.coinmarketcap.com/static/img/coins/64x64/2793.png",
    "requiresMemo": false,
    "instrumentType": "fiat",
    "bestChangeName": ""
  }
]

فیلدهای پاسخ

• currencyTitle — نماد ارز (برای مثال: BTC، USDT، EUR).
• networkTitle — شبکه‌ای که ابزار روی آن عمل می‌کند (برای مثال: TRC20، ERC20، SEPA).
• currencyFriendlyTitle — نام قابل‌فهم برای ارز.
• precisionDecimals — تعداد رقم‌های اعشاری پشتیبانی‌شده در سیستم.
• currencyLogoLink — لینک آیکون ارز.
• requiresMemo — مشخص می‌کند آیا Memo/Tag برای انتقال لازم است یا خیر.
• instrumentType — نوع ابزار (crypto یا fiat).

اطلاعات عمومی مربوط به یک ابزار فعال در پلتفرم Quickex را بازمی‌گرداند.
این روش زمانی استفاده می‌شود که لازم باشد پارامترهای یک ارز خاص در شبکه موردنظر مشخص شود
(برای مثال، USDT در شبکه TRC20).

URL

https://quickex.io/api/v1/instruments/public/one

پارامترهای Query

نمونه درخواست (cURL)

curl -X GET \
  'https://quickex.io/api/v1/instruments/public/one?currencyTitle=USDT&networkTitle=TRC20' \
  -H 'Accept: application/json'

نمونه پاسخ (200)

{
  "currencyTitle": "USDT",
  "networkTitle": "TRC20",
  "okexCurrencyFriendlyTitle": "USDT",
  "precisionDecimals": 2,
  "requiresMemo": false,
  "currencyLogoLink": "https://static.coinall.ltd/cdn/oksupport/asset/currency/icon/usdt20230419113051.png"
}

نکات

• این متد اجازه می‌دهد ویژگی‌های یک ابزار را بدون نیاز به بارگذاری کل فهرست دریافت کنید.
• precisionDecimals نشان می‌دهد چه تعداد رقم اعشاری برای محاسبات این ارز پشتیبانی می‌شود.
• requiresMemo مشخص می‌کند آیا برای انتقال باید Memo/Tag وارد شود یا خیر (برای برخی شبکه‌ها مانند XRP یا XLM اهمیت دارد).
• برای اعتبارسنجی اولیه هنگام ساخت رابط انتخاب ارز و شبکه می‌تواند استفاده شود.

/api/v1/instruments/public/validate-address
POST

صحت یک آدرس مشخص‌شده برای ابزار انتخاب‌شده را بررسی می‌کند.
این متد کمک می‌کند اطمینان حاصل شود که آدرسی که کاربر وارد کرده با فرمت موردنیاز شبکه مطابقت دارد
(برای مثال، یک آدرس TRC20 برای USDT).
این روش قبل از ارسال تراکنش یا ایجاد سفارش استفاده می‌شود تا خطاهای احتمالی در وارد کردن آدرس به حداقل برسد.

URL

https://quickex.io/api/v1/instruments/public/validate-address

پارامترها

هیچ‌کدام (اطلاعات در بدنه درخواست ارسال می‌شود).

بدنه درخواست (JSON)

{
  "currencyTitle": "USDT",
  "networkTitle": "TRC20",
  "address": "THUmkPhry61edcTf79yTioV6292ccsuCjV"
}

نمونه درخواست (cURL)

curl -X POST \
  'https://quickex.io/api/v1/instruments/public/validate-address' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "currencyTitle": "USDT",
  "networkTitle": "TRC20",
  "address": "THUmkPhry61edcTf79yTioV6292ccsuCjV"
}'

نمونه پاسخ (201)

true

نکات

• پاسخ true به این معناست که آدرس معتبر است و می‌توان از آن در تراکنش استفاده کرد.
• پاسخ false زمانی بازگردانده می‌شود که آدرس با فرمت شبکه انتخاب‌شده مطابقت نداشته باشد.
• توصیه می‌شود این متد هنگام وارد کردن آدرس توسط کاربر فراخوانی شود تا از بروز خطا در هنگام ایجاد سفارش جلوگیری شود.