مقدمه

والکس به عنوان یکی از پیشروترین پلتفرم‌های مبادله ارزهای دیجیتال در ایران، خدمات متنوعی مانند معاملات اسپات (Spot)، معاملات تعهدی (Margin)، اعتبار معاملاتی و سایر ابزارهای مالی را در اختیار کاربران حرفه‌ای و توسعه‌دهندگان قرار می‌دهد.

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

این مستند برای توسعه‌دهندگان، تریدرها و تیم‌های فنی طراحی شده که قصد دارند به‌صورت مستقیم و اتوماتیک با زیرساخت معاملاتی والکس تعامل داشته باشند.

در ادامه با ساختار کلی APIها، نحوه احراز هویت، ساختار Request-Body و Response-Body، لیست APIها و مثال‌های کاربردی آشنا خواهید شد.

پیش نیاز ها

  • تمامی APIها تنها از طریق دامنه رسمی https://api.wallex.ir در دسترس هستند.
  • تمامی Response-Body ها در قالب استاندارد JSON ارائه می‌شود.
  • APIهایی که به اطلاعات شخصی کاربران دسترسی دارند یا امکان انجام تراکنش را فراهم می‌کنند، با استفاده از کلیدهای API و مکانیسم‌های امنیتی محافظت شده‌اند.

انواع داده های مورد استفاده

ExampleDefinitionData Type
28.4عدد اعشاری یا صحیحnumber
"13.78"عددی که به صورت رشته ارسال میشودnumber string
"BTC"رشته متنیstring
"2024-05-01T12:34:56Z"تاریخ و زمان در قالب استاندارد ISO-8601datetime
1714563456زمان یونیکس (ثانیه از 1970)timestamp
true / falseمقادیر بولینboolean

شیوه ارسال درخواست

  • دقت داشته باشید که Request-Body باید به‌صورت JSON ارسال شود
  • در تمامی درخواست ها Content-Type:application/json باید در Request-Header قرار بگیرد.