API V2 Instruments

توضیحات کلی
فهرست عمومی تمام ابزارهای فعال (ارزها و شبکه‌ها) که برای تبادل در دسترس هستند را بازمی‌گرداند.

پارامترها

پارامترهای Query

هدرها

نمونه درخواست

curl -X GET "https://quickex.io/api/v2/instruments/public?providers" \
  -H "accept: application/json" \
  -H "X-Api-Public-Key: yourPublicKey" \
  -H "X-Api-Timestamp: 1691400000000" \
  -H "X-Api-Signature: yourHmacSignature"

نمونه پاسخ

[
  {
    "currencyTitle": "ADA",
    "networkTitle": "ADA",
    "currencyFriendlyTitle": "Cardano",
    "precisionDecimals": 11,
    "requiresMemo": false,
    "currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png",
    "instrumentType": "crypto"
  },
  {
    "currencyTitle": "USDT",
    "networkTitle": "TRC20",
    "currencyFriendlyTitle": "Tether USD",
    "precisionDecimals": 6,
    "requiresMemo": false,
    "currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/USDT.png",
    "instrumentType": "crypto"
  }
]

مورد استفاده

هنگام بارگذاری فرم تبادل در وب‌سایت، باید تمام ارزها و شبکه‌های موجود از ارائه‌دهندگان مشخص‌شده نمایش داده شوند. فرانت‌اند این متد را فراخوانی کرده و فهرست ارزها و شبکه‌ها را برای نمایش می‌سازد.

توضیحات کلی
اطلاعات یک ابزار فعال (ارز + شبکه) را از فهرست عمومی بازمی‌گرداند.

پارامترها

هدرها

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

نمونه درخواست

curl -X POST 'https://quickex.io/api/v2/instruments/public/one' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Public-Key: yourPublicKey' \
  -H 'X-Api-Timestamp: 1691400000000' \
  -H 'X-Api-Signature: yourHmacSignature' \
  -d '{
    "currencyTitle": "USDT",
    "networkTitle": "TRC20"
  }'

نمونه پاسخ‌ها

200 OK — ابزار یافت شد:

{
  "currencyTitle": "ADA",
  "networkTitle": "ADA",
  "currencyFriendlyTitle": "Cardano",
  "precisionDecimals": 11,
  "requiresMemo": false,
  "currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png",
  "instrumentType": "crypto",
  "bestChangeName": "USDTTRC20"
}

500 ERR_UNKNOWN — ابزار یافت نشد یا خطای داخلی:

{
  "status": "ERR_UNKNOWN",
  "message": "code=404, message=Not Found",
  "data": null
}

مورد استفاده

هنگام ایجاد سفارش، فرانت‌اند باید اطلاعات دقیق ابزار انتخاب‌شده را نمایش دهد: نام قابل‌نمایش، دقت اعشاری و نیاز به Memo/Tag. پس از انتخاب ارز و شبکه، این متد فراخوانی می‌شود و داده‌های بازگشتی برای اعتبارسنجی و نمایش فرم استفاده می‌گردد.

توضیحات کلی
درستی یک آدرس را برای ارز و شبکه مشخص‌شده بررسی می‌کند. اگر آدرس با فرمت و قوانین شبکه سازگار باشد true بازمی‌گرداند؛ در غیر این صورت false یا یک خطا.

پارامترها

هدرها

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

نمونه درخواست

curl -X POST 'https://quickex.io/api/v2/instruments/public/validate-address' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Public-Key: yourPublicKey' \
  -H 'X-Api-Timestamp: 1691400050000' \
  -H 'X-Api-Signature: yourHmacSignature' \
  -d '{
    "currencyTitle": "USDT",
    "networkTitle": "TRC20",
    "address": "THUmkPhry61edcTf79yTioV6292ccsuCjV"
  }'

نمونه پاسخ‌ها

200 OK — آدرس معتبر است:

true

400 ERR_INVALID_ADDRESS — آدرس با فرمت شبکه سازگار نیست:

false

500 ERR_UNKNOWN — ابزار یافت نشد یا خطای داخلی:

{
  "status": "ERR_UNKNOWN",
  "message": "code=404, message=Not Found",
  "data": null
}

مورد استفاده

قبل از ایجاد سفارش، فرانت‌اند آدرس واردشده توسط کاربر را بررسی می‌کند: اگر مقدار true بازگردد، فرم ادامه می‌یابد؛ در غیر این صورت پیام خطا نمایش داده شده و از کاربر خواسته می‌شود آدرس را بررسی کند.