نام در حال استفاده

یک برچسب در حال حاضر با نام شاخه ارائه شده وجود دارد. بسیاری از دستورات GIT نام برچسب و شاخه را می پذیرند ، بنابراین ایجاد این شاخه ممکن است باعث رفتار غیر منتظره شود. آیا مطمئن هستید که می خواهید این شاخه را ایجاد کنید؟

api-doc / bitmax-api-doc-v1. 2. md

• به پرونده T بروید
• به خط L بروید
• مسیر کپی
• پیوند ثابت را کپی کنید

این تعهد متعلق به هیچ شعبه ای در این مخزن نیست و ممکن است متعلق به یک چنگال در خارج از مخزن باشد.

• با دسک تاپ باز کنید
• مشاهده خام
• محتوای خام را کپی کنید و محتوای خام را کپی کنید

   

محتوای خام را کپی کنید

محتوای خام را کپی کنید

Bitmax |سند API v1. 2

مبادله Bitmax از 1 اوت 2020 به بعد پشتیبانی از این API ها را متوقف می کند.

API در این سند کاهش می یابد. مبادله Bitmax به حمایت از این API ها ادامه خواهد داد. با این حال ، هیچ توسعه جدیدی به جز رفع اشکال انجام نخواهد شد.

آخرین سند API را می توان در:

API های آرام: نمای چشم پرنده

API های حساب نقدی

API های حساب حاشیه

API های حساب نقدی و حاشیه

API های آرامش بخش عمومی

Exchange Exchange Format BaseAssetCode/quoteAssetCode برای نمادهای محصول. به عنوان مثال ، ETH/BTC = 0. 052 به معنای قیمت 1 ETH 0. 052 BTC است. به نظر نمی رسد که از ETH-BTC در مسیرهای API استفاده کنید تا از آلودگی رشته مسیر جلوگیری کنید.

نقطه ورود استراحت

نقطه ورود API RESTFUL عمومی: https://bitmax.io/api/. نقطه ورود API RESTful عمومی برای سایت آزمون: https://bitmax-test.io/api/.

لیست همه دارایی ها

API لیستی از شی را برمی گرداند ، هر یک شامل لیستی از زمینه های دارایی است:

لیست همه محصولات

پاسخ موفقیت آمیز: لیستی از کلیه اشیاء محصول. هر شیء محصول شامل سه بخش - محصول ، پایه و سهام است.

هزینه معاملات فعلی را دریافت کنید

نقل قول بازار (داده های کتاب سفارش سطح 1) یک محصول

پرس و جو یک پارامتر می گیرد

• نماد - یک نمونه معتبر. مثال: نماد = ETH-btc

عمق بازار (داده های کتاب سفارش سطح 2) یک محصول

پرس و جو دو پارامتر می گیرد:

• نماد - یک نماد معتبر. نماد مثال = ETH-btc
• n - تعداد سطوح مورد نیاز در کتاب سفارش. N در حال حاضر محدود به 100 یا کمتر است. مثال n = 10

پاسخ موفقیت آمیز: یک شیء شامل سطح پیشنهاد داخلی N و سطح Ask N (بالا از کتاب) است.

هر پیام عمق حاوی یک قسمت TIS TIS و یک قسمت دنباله SEQNUM است.

• Timestamp (TS) - جدول زمانی UTC در میلی ثانیه از آخرین به روزرسانی عمق موجود در پیام.
• شماره دنباله (SEQNUM) - شماره دنباله یک عدد عدد صحیح به شدت در حال افزایش برای هر به روزرسانی عمق است که توسط سرور اختصاص داده شده است. در پیام ، این آخرین بروزرسانی عمق است.

هر دو Timestamp و شماره دنباله برای هر نماد تنظیم شده اند. لطفاً مقادیر را از نمادهای تفاوت مقایسه نکنید. توجه داشته باشید که این زمینه ها تجربی هستند و ممکن است در آینده تغییر کنند.

پرس و جو دو پارامتر می گیرد:

• نماد - یک نماد معتبر. نماد مثال = ETH-btc
• N - تعداد معاملات در پاسخ گنجانده شده است. N در حال حاضر محدود به 100 یا کمتر است. مثال n = 10

پاسخ موفقیت آمیز: یک شیء حاوی لیستی از معاملات اخیر.

آمار نورد 24 ساعته از همه محصولات

پاسخ موفقیت آمیز: لیست اشیاء حاوی آمار نورد 24 ساعته برای همه محصولات.

آمار نورد 24 ساعته یک محصول

پرس و جو یک پارامتر را می گیرد:

• نماد - یک نماد معتبر. نماد مثال = ETH-btc

پاسخ موفقیت آمیز: آمار نورد 24 ساعته محصول مشخص شده.

اطلاعات تاریخ بار

پاسخ موفقیت آمیز: لیست تمام فواصل زمانی که در حال حاضر توسط مبادله پشتیبانی می شود.

داده های تاریخ نوار

درخواست بیش از 1000 میله ممکن است منجر به خطا شود.

پاسخ موفقیت آمیز: لیست میله ها از طریق:

قیمت مرجع (حاشیه)

قیمت مرجع توسط Bitmax برای محاسبه مشخصات ریسک حساب های حاشیه (از جمله مبلغ وام دارایی ، مبلغ قابل انتقال و اهرم حساب و غیره) استفاده می شود.

API های آرامش بخش معتبر

نقطه ورود API RESTFUL خصوصی: https://bitmax.io//api/ (برای جزئیات بیشتر به بخش ورودی API مراجعه کنید)

برای استفاده از API های معتبر RESTFUL ، ابتدا باید برای امضای پیام برای یک کلید API و یک کلید مخفی اقدام کنید. شما باید کلید API را در هر یک از درخواست خود به همراه امضا امضا شده با استفاده از کلید مخفی وارد کنید. لطفاً کلید مخفی را با کسی به اشتراک نگذارید.(لطفا برای به دست آوردن کلیدهای خود با ما تماس بگیرید.)

هر درخواست تأیید شده باید قسمتهای زیر را در هدر قرار دهد:

• X-Auth-Key-کلید API
• X-Auth-Signature-پیام امضا شده با استفاده از SHA256 با استفاده از کلید مخفی Decoded Decoded در رشته Prehash + یا ++ برای قرار دادن/لغو سفارشات.
• x-auth-timestamp-میلی ثانیه از زمان دوره یونیکس در UTC
• x-auth-coid-این قسمت فقط هنگام قرار دادن سفارش جدید یا لغو سفارش مورد نیاز است ، برای جزئیات بیشتر به زیر مراجعه کنید

به عنوان مثال ، برای پرس و جو از تعادل خود از طریق تعادل مسیر API در 2018-06-26 20: 49: 34. 012 UTC (Timestamp = 1530046174012) ، می توانید با استفاده از الگوریتم SHA256 برای رشته 1530046174012+متعادل ، امضا را بدست آورید. فرآیند امضای می تواند در Python 3. 6+ به عنوان:

نکته: برای قرار دادن سفارش جدید یا لغو سفارش ، باید شناسه سفارش را در پیام قرار دهید:

نکته: برای قرار دادن یا لغو چندین سفارش ، باید تمام شناسه های سفارش را در پیام قرار دهید:

لطفاً توجه داشته باشید که ما از سال 2018-09-26 به بعد به یک روش امضای جدید خواهیم پرداخت. اگرچه هنوز هم می توانید از الگوریتم فوق استفاده کنید ، اما به شما تشویق می شود که به روش جدید امضای تغییر دهید.

نقطه ورود API

Bitmax سرورهای اختصاصی را در همان گروه حساب به کاربران اختصاص می دهد. این امر باعث افزایش توان در هر کاربر هر سرور می شود. انتظار می رود کاربران API برای اتصال به سرور مورد نظر ، گروه حساب را در URL پرس و جو مشخص کنند. در غیر این صورت ، درخواست رد می شود.

نقطه ورود API برای API های معتبر https://bitmax.io//api است. به عنوان مثال ، کاربر با گروه حساب 3 باید از https://bitmax.io/3/api برای پرس و جو از داده های معتبر استفاده کند.

پیش بینی می شود گروه حساب به مرور زمان یکسان بمانید. با این حال ، توصیه می شود کاربران API گروه حساب را در آغاز برنامه بررسی کنند. برای دریافت گروه حساب کاربری/اطلاعات مراجعه کنید.

API با داده های ورودی تماس می گیرد

برخی از تماس های API به داده های ورودی کاربر نیاز دارند. سرور فقط JSON را به عنوان نوع ورودی می پذیرد ، لطفاً اطمینان حاصل کنید که نوع داده را در هدر درخواست مشخص کرده اید:

اطلاعات کاربر (api_path = کاربر/اطلاعات)

پاسخ موفقیت آمیز: یک شی با اطلاعات اصلی کاربر.

لیست تمام مانده حساب نقدی (API_PATH = مانده)

پاسخ موفقیت آمیز: لیستی از تمام مانده های فعلی شما.

تعادل یک دارایی از حساب نقدی را دریافت کنید (api_path = مانده)

پاسخ موفقیت آمیز: یک شی با داده های تعادل فعلی دارایی مشخص شده.

تعادل یک دارایی از حساب حاشیه را دریافت کنید (api_path = حاشیه/تعادل)

پاسخ موفقیت آمیز: یک شی با داده های تعادل فعلی دارایی مشخص شده.

لیست تمام تعادل حساب حاشیه (api_path = حاشیه/تعادل)

پاسخ موفقیت آمیز: لیستی از تمام مانده های فعلی شما.

ما یک AssetCode مخصوص BTMXD را به عنوان مقدار BTMX قفل شده اضافه کردیم. در دسترس بودن میزان BTMX قفل شده را نشان می دهد ، و TotalAmount مجموع BTMX قفل شده و مقدار BTMX است که برای باز کردن قفل درخواست شده است (که در بیش از 24 ساعت به BTMX شناور تبدیل می شود).

دریافت سپرده/برداشت تاریخ (API_PATH = معامله)

پاسخ موفقیت آمیز شامل:

مراحل چرخه زندگی یک سفارش

یک سفارش ممکن است در یکی از وضعیت زیر باشد:

• در حال انتظار - فقط برای سفارشات توقف در دسترس است.
• جدید
• تا حدی
• پر شده
• لغو شد
• رد شده

سفارش جدیدی قرار دهید

برای این API باید X-Auth-Coid را در عنوان درخواست خود قرار دهید.

درخواست طرح بدنه: برنامه/json

هر درخواست باید حاوی یک شناسه منحصر به فرد باشد. COID بیش از 32 بار نیست و فقط از شخصیت های مورد پایین (A-Z) ، شخصیت های بزرگ (A-Z) و ارقام (0-9) تشکیل شده است.

لطفاً توجه داشته باشید که باید در مورد مکان های اعشاری برای سفارش ، StopPrice و OrderQty مراقب باشید. تعداد مکان های اعشاری برای سفارش قیمت گذاری / StopPrice نباید از Pricescale تجاوز کند ، و این که برای Orderqty نباید از Qtyscale تجاوز کند ، در غیر این صورت گرد می شوند.(Pricescale/Qtyscale برای هر نماد را می توان از API دریافت API/V1/محصولات بدست آورد.)

هر درخواست همچنین باید زمان را مشخص کند - زمان درخواست به عنوان کل میلی ثانیه از زمان UNIX EPOCH در UTC. درخواستهایی که بیش از 30 ثانیه پیش قرار گرفته اند به صورت منقضی شده رفتار می شوند و پردازش نمی شوند.

جدول زیر نحوه پیکربندی صحیح سفارش از انواع مختلف را نشان می دهد: (o - مورد نیاز ، x - اختیاری)

نمونه ای از پاسخ ناموفق:

پاسخ کد 200 OK به این معنی است که سفارش توسط سرور دریافت شده است. با این حال ، این بدان معنا نیست که این سفارش با موفقیت به موتور تطبیق ارسال شده است. کاربران API باید از Success: Boolean Field در پاسخ API استفاده کنند تا بررسی کنند که آیا این سفارش با موفقیت به سیستم منتقل شده است یا خیر. به عنوان مثال ، اگر کسی تعادل کافی نداشته باشد ، او موفقیت = نادرست دریافت می کند.

حتی اگر سفارش به موتور تطبیق منتقل شود ، ممکن است هنوز رد شود. به عنوان مثال ، در صورتی که دستور در غیر این صورت نقدینگی باشد ، می توان دستور postonly را رد کرد. کاربران API باید از لیست API Open Order API برای نظارت بر وضعیت سفارش قرار داده شده استفاده کنند.(به زیر مراجعه کنید)

قرار دادن چندین سفارش از حساب نقدی (api_path = سفارش/دسته)

ممکن است چندین سفارش را در یک درخواست ترکیب کنید

برای این API ، شما باید X-Auth-Coid را در عنوان درخواست خود قرار دهید. شما باید شناسه تمام سفارشات را با شخصیت + به هم بزنید. ترتیب شناسه در هدر باید با سفارشات درخواست مطابقت داشته باشد.

شما ممکن است حداکثر 10 سفارش را به طور همزمان ارسال کنید. در صورت ارسال بیش از 10 سفارش ، سرور با InvalidRequest پاسخ خواهد داد.

بدنه درخواست: برنامه/json

پاسخ موفقیت آمیز: یک شیء حاوی لیستی از (نماد ، OrderID)

لغو سفارش

برای این API باید X-Auth-Coid را در عنوان درخواست خود قرار دهید. توجه داشته باشید که برای لغو سفارشات نقدی و API حساب Margin باید از API حساب نقدی استفاده کنید تا سفارشات حاشیه را لغو کنید.

درخواست طرح بدنه: برنامه/json

برای لغو سفارش باز ، باید CorreClty را مشخص کنید. در صورت عدم یافتن هیچ سفارش باز با استفاده از Origcoid ارائه شده ، مبادله درخواست را رد می کند.

پاسخ کد 200 OK به این معنی است که سفارش با موفقیت در سیستم ما قرار گرفته است. کاربران API باید از WebSocket برای نظارت بر وضعیت سفارش قرار داده شده استفاده کنند.

نمونه ای از پاسخ ناموفق:

چندین سفارش را لغو کنید (api_path = سفارش/دسته)

شما می توانید چندین سفارش را در درخواست واحد حذف کنید:

برای این API باید X-Auth-Coid را در عنوان درخواست خود قرار دهید. شما باید شناسه تمام سفارشات را با شخصیت + به هم بزنید. ترتیب شناسه در هدر باید با سفارشات درخواست مطابقت داشته باشد.

شما ممکن است حداکثر 10 سفارش را به طور همزمان ارسال کنید. در صورت ارسال بیش از 10 سفارش ، سرور با InvalidRequest پاسخ خواهد داد.

بدنه درخواست: برنامه/json

پاسخ موفقیت آمیز: یک شیء حاوی لیستی از (نماد ، OrderID)

لغو همه سفارشات باز (api_path = سفارش/همه)

این پرس و جو درخواست لغو برای کلیه سفارشات باز را که توسط کاربر مشخص شده است ، ارسال می کند.

• نماد - رشته رشته اختیاری. نماد مثال = ETH-BTC.
• سمت - رشته رشته اختیاری (حساس به مورد). یا "خرید" یا "فروش".

لیست کلیه سفارشات باز

پاسخ موفقیت آمیز: لیست تمام سفارشات باز شما.(فیلتر توسط نماد در نسخه بعدی پشتیبانی می شود)

لیست سفارشات تاریخی (api_path = سفارش/تاریخ)

(تجربی: پارامترهای زیر در معرض تغییر هستند)

• نماد - اختیاری ، نوع رشته.
• دسته - اختیاری ، نوع رشته.
• OrderType - اختیاری ، نوع رشته.
• صفحه - نوع اختیاری ، عدد صحیح. صفحه از 1 شروع می شود.
• PageSize - نوع اختیاری ، عدد صحیح.
• طرف - اختیاری ، نوع رشته. خرید یا فروش ، بی حساسیت.
• StartTime - نوع اختیاری ، عدد صحیح. میلی ثانیه از آنجا که دوره یونیکس نمایانگر شروع دامنه است
• EndTime - نوع اختیاری ، عدد صحیح. میلی ثانیه از زمان دوره یونیکس که نشانگر پایان دامنه است
• وضعیت - اختیاری ، نوع رشته. وضعیت فقط می تواند یکی از "پر شده" ، "لغو" ، "رد شده" باشد.

لطفاً توجه داشته باشید که ما تمام سفارشات لغو / رد شده را بدون پر از مجموعه نتیجه حذف می کنیم.

پاسخ موفقیت آمیز: لیست تمام تاریخ سفارشات شما ، (سفارشات باز فعلی گنجانده نشده است.)

نکته ، پرس و جو آخرین سفارشات N را در محدوده مشخص شده برمی گرداند. برای پرس و جو از تاریخ بیشتر ، از زمان بندی قدیمی ترین سفارش به عنوان Endtime جدید استفاده کنید و دوباره پرس و جو را اجرا کنید.

داده های اصلی سفارش یک سفارش را دریافت کنید

پاسخ موفقیت آمیز: داده های اساسی سفارشات باز.

دریافت یک سفارش (api_path = سفارش/پر کردن)

پاسخ موفقیت آمیز: لیست تمام پر کردن سفارش مشخص شده.

آدرس سپرده یک دارایی را دریافت کنید (api_path = سپرده)

درخواست طرح بدنه: برنامه/json

شما باید پیام "+سپرده+" را امضا کنید و X-auth-coid = را در هدر تنظیم کنید.

پاسخ موفقیت آمیز: یک شی با آدرس سپرده مرتبط با کاربر معتبر.

توجه: استفاده از نسخه V2 این مسیر ، به ویژه برای دارایی هایی با زنجیره های بلوک های متعدد مانند USDT بسیار توصیه می شود.

این API در حال حاضر در دسترس نیست.

نقطه ورود WebSocket:

• عمومی: wss: //bitmax.io/api/public/ [نماد]
• تأیید اعتبار (مشاهده و مجوز تجارت مورد نیاز): wss: //bitmax.io//api/stream/ [نماد]

Similiar به سرورهای معتبر ، Bitmax سرورهای اختصاصی را برای پخش داده ها به کاربران در همان گروه حساب از طریق WebSocket اختصاص می دهد. به عنوان مثال ، کاربر در گروه حساب 3 تمام پیام های ETH-BTC را از طریق مشترک می کند:

توجه: [نماد] در اتصالات WebSocket باید توسط یک Hyphen (-) ، به عنوان مثال ، ETH-BTC جدا شود. Slash (/) به ویژه در URL ها به عنوان جداکننده مسیر رفتار می شود.

اتصال به API WebSocket تقریباً همان فرآیند احراز هویت را به عنوان API های معتبر معتبر دنبال می کند. شما باید هدرهای زیر را به درخواست WebSocket خود اضافه کنید:

• x-auth
• X-Auth-Signature-پیام امضا شده با استفاده از SHA256 با استفاده از کلید مخفی Decoded Base64 در رشته prehash +api/stream ".
• X-auth-timestamp

پس از اتصال WebSocket ، برای شروع دریافت جریان داده باید یک پیام مشترک ارسال کنید. در حال حاضر ما سه نوع پیام را پخش می کنیم.

• عمق - عمق بازار
• MarketTrades - معاملات بازار
• سفارش - سفارشات خود مشتری.

تمام پیام های WebSocket در قالب JSON هستند و بسیار شبیه API های RESTFUL هستند. با این حال ، نام فیلد برای کاهش اندازه پیام کوتاه می شود.

در جریان های WebSocket مشترک شوید

پس از اتصال به WebSocket ، برای شروع دریافت جریان داده باید یک پیام مشترک ارسال کنید.

هر پیام عمق بازار یک شیء JSON است که حاوی مقدار فعلی در سطح قیمت های خاص است. هیچ روش مستقیمی برای دریافت داده های برتر کتاب وجود ندارد. شما باید کتاب عمق فعلی را حفظ کرده و بهترین پیشنهاد را بدست آورید. این کار را می توان با دو مرحله انجام داد:

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

تمام پیام های عمق دارای یک ساختار یکسان هستند ، برای جزئیات بیشتر به عمق مراجعه کنید.

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

هر سابقه خلاصه بازار شامل اطلاعات فعلی در مورد یک محصول واحد است. داده ها به صورت دسته ای پخش می شوند - ما داده های بازار همه محصولات را هر 30 ثانیه پخش می کنیم.

داده های نوار تقریباً مشابه داده های خلاصه بازار است ، به جز این:

• نوع پیام نوار است
• در هر جلسه WebSocket فقط یک نماد وجود دارد
• قسمت فاصله من ممکن است مقادیر مختلفی داشته باشد: 1 ، 5 ، 30 ، 160 ، 360 ، 1d.

ما داده های نوار را در دسته ها پخش می کنیم. هر 30 ثانیه ، ما پیام های داده نوار را در تمام سطوح فاصله پخش می کنیم. شما می توانید از این داده ها برای به روزرسانی نمودار نوار به طور مستقیم استفاده کنید (میله ها را جایگزین کنید). با این حال ، شما همچنین باید نمودار نوار را با استفاده از پیام های تجارت بازار به روز کنید.

با websocket API ما، می توانید وضعیت همه سفارش های فعال خود را کنترل کنید، سفارش های جدید را ثبت کنید و سفارش های موجود را لغو کنید.

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

از آنجایی که فقط به روزرسانی های سفارش جدید پخش می شوند، توصیه می شود که عکس اولیه همه سفارش هایتان را با استفاده از RESTful API GET api/v1/order/op بارگیری کنید.

یک سفارش جدید با WebSocket ثبت کنید

برای ثبت سفارش جدید، باید یک newOrderRequest به سرور ارسال کنید:

فیلد شناسه سفارش مشتری (coid) یک شناسه منحصر به فرد برای شناسایی سفارش شما است. هنگامی که سفارش با موفقیت انجام شد، این شناسه مجدداً در قسمت origCoid پیام به روزرسانی سفارش بازتاب داده می شود.