سابقه تغییرات
۱۴۰۱/۰۲/۱۰
● راه اندازی بخش مستندات
● اضافه کردن وب سرویس به بخش تبادل سریع
GET /oapi/v1/otc/tickers
GET /oapi/v1/otc/ticker
۱۴۰۱/۰۴/۱۵
● اضافه کردن وب سرویس به بخش بازار حرفه ای
GET /oapi/v1/market/tickers
GET /oapi/v1/market/ticker
GET /oapi/v1/market/orderbook
GET /oapi/v1/market/trades
۱۴۰۱/۱۰/۰۷
● راه اندازی بخش API Key
● امکان کار با بخش های مربوط به حساب کاربری با استفاده از api ها
1402/06/11
● اضافه کردن وب سرویس های
GET /api/v2/otc/estimate/public
GET /api/v2/otc/estimate
GET /api/v2/otc/convert
توضیحات کلی
مقدمه
به مستندات API اوکی اکسچنج، پیشروترین بازار ارز دیجیتال کشور خوش آمدید. با استفاده از سرویس API میتوانید علاوه بر اطلاع از آخرین قیمتها و وضعیت بازار رمزارزها، حساب کاربری خود را در اوکی اکسچنج به صورت خودکار و بر اساس کد مدیریت نمایید.
مجموعه Postman
حهت دسترسی سریع و راحت به مجموعه وب سرویس های اوکی اکسچنج می توانید از آن استفاده کنید. جهت اطلاعات بیشتر می توانید از طریق لینک زیر اقدام کنید: مجموعه Postman وب سرویس های اوکی اکسچنج
شرایط استفاده
- در نظر داشته باشید که تنها بخشهایی که در مستندات API اوکی اکسچنج ذکر شده باشند، API عمومی و قابل استفاده در اوکی اکسچنج محسوب میشوند. اگر endpoint یا هر فیلدی در مستندات ذکر نشده باشد، ممکن است بدون اطلاع قبلی دچار تغییر شود.
- این امکان وجود دارد که در طول زمان تغییراتی در API عمومی اوکی اکسچنج به وجود آید. این تغییرات در بخش «سابقه تغییرات API اوکی اکسچنج» اطلاعرسانی خواهند شد. لازم است استفاده کنندگان به صورت منظم و مکرر این بخش را رصد نمایند و تغییرات لازم را در برنامههای خود اعمال نمایند. اوکی اکسچنج تضمین سطح سرویس SLA برای API خود به عموم مشتریان ارائه نمیدهد و استفاده کنندگان از API باید تدابیر و تمهیدات لازم را در مورد تشخیص و واکنش به اختلالات احتمالی در سرویس انجام دهند. اوکی اکسچنج در خصوص شرایط یا تغییرات در API که باعث ایجاد مشکلات احتمالی در کدهای نوشته شده توسط کاربران شود هیچگونه مسئولیتی نخواهد داشت.
- در صورتی که پاسخی مبنی بر استفاده نادرست از از API مانند خطای 429 یا سایر خطاهای ناشی از نرخ بالای درخواستها یا ورودی نامعتبر دریافت شود، استفاده کننده ملزم است که واکنش مناسبی نسبت به خطای به وجود آمده نشان داده و از تکرار اشتباه خودداری نماید. در صورت تشخیص استفاده نادرست و عدم بروز واکنش مناسب به پیامهای خطاهای دریافتی، ممکن است IP درخواستدهنده به طور موقت یا دائمی در سرویس اوکی اکسچنج مسدود شود.
- حملات DDOS یا هرگونه اعمال مخرب و زیان آور دیگر خلاف شرایط استفاده از API اوکی اکسچنج است و در صورت مشاهده تمامی حسابهای کاربری مرتبط در سرویس اوکی اکسچنج مسدود خواهند شد.
- به طور معمول خروجی API اوکی اکسچنج به صورت JSON ارائه میشود. حتما باید دقت شود که علاوه بر فیلدهایی که در مستندات برای خروجی وجود دارند، ممکن است فیلدهای دیگری نیز در خروجی پاسخ وجود داشته باشند. لذا پیشنهاد میشود که برنامه خود را به شکلی توسعه دهید که در صورت وجود فیلدهای دیگری علاوه بر فیلدهای مورد انتظار، عملکرد آن دچار خطا نشود.
راهنمای خطایابی
در صورتی که پاسخ مد نظر خود را از API دریافت نمیکنید، ابتدا اطمینان حاصل کنید که تمامی موارد ذکر شده در مستندات مربوطه را به درستی رعایت کرده باشید. بهترین روش حل مشکلات برنامهنویسی سعی در ریشهیابی مشکلات با تغییر متغیرها و بررسی تمام حالتها و استفاده از روشهای مرسوم عیبیابی کد است.
چنانچه مشکل حل نشد مراجعه به بخش سوالات متداول میتواند مفید واقع شود. همچنین در صورتی که مشکل مربوط به حساب کاربری شما باشد و امکان هیچ اقدامی نه از طریق API و نه از طریق سایت اوکی اکسچنج را نداشته باشید، باید از طریق ارسال تیکت با بخش پشتیبانی اوکی اکسچنج در ارتباط باشید.
شروع به کار
Content-Type: application/json
x-api-key: 37c541a1-****-****-****-10fe7a038418
x-signature: leaVRET-****-****-****-j8gnl3uw
x-timestamp: 1664789830555
- آدرس دامنه اصلی برای تمامی وب سرویس ها 'https://azapi.ok-ex.io' است
- خروجی تمامی وب سرویس ها بصورت json خواهد بود
- در تمامی وب سرویس ها، درصورتی که می بایست timestamp ارسال شود، باید بصورت میلی ثانیه باشد
- هدر مورد نظر جهت استفاده برای درخواست ها به این صورت است:
API Key
نکات مهم :
- جهت کار با وب سرویس های مربوط به حساب کاربری، استفاده از API Key الزامی است. برای دریافت API Key به این صفحه مراجعه کنید.
- جهت ایجاد هر API Key به دلایل مسائل امنیتی وارد کردن حداقل یک ip آدرس الزامیست.
- هرگز API Key حساب کاربری خود را با دیگران به اشتراک نگذارید.
برای استفاده از API های دارای امضا، نیازمند API KEY و SECRET میباشید که در بخش حساب کاربری میتوانید ایجاد نمایید.
در Header های این درخواست ها باید کلید های مقابل اضافه شود.
امضاء درخواست ها:
برای امضاء درخواست ها ابتدا باید تمام مشخصات درخواست را مشابه زیر در یک متن آماده کنید:
<method>\n<full_path>\n<timestamp>\n<data>
عنوان | توضیحات |
---|---|
method | متد استفاده شده در زمان ارسال درخواست به طور مثال |
full_path | مسیر درخواست داده شده به همراه آرگومان ها و بدون دامنه سایت |
timestamp | تایم استمپ حال حاضر با منطقه زمانی UTC به میلی ثانیه |
data | داده های json ارسالی در صورت وجود رمزنگاری شده به صورت base64 |
- در صورت عدم وجود data باید متن را مشابه زیر درست کرد:
\n \n
def create_signature(secret_key, full_path, request_method, request_data=None):
timestamp = int(datetime.datetime.utcnow().now().timestamp() * 1000)
msg = f'{request_method.upper()}\n{full_path}\n{timestamp}'
if request_data:
base64encode = base64.b64encode(json.dumps(request_data).encode()).decode()
msg += f'\n{base64encode}'
signed_key = hmac.new(
bytes(secret_key, "utf-8"),
msg=bytes(msg, "utf-8"),
digestmod=hashlib.sha256).hexdigest()
return signed_key, timestamp
function createSignature(secretKey, fullPath, requestMethod, requestData = null) {
const timestamp = moment().valueOf();
let msg = `${requestMethod.toUpperCase()}\n${fullPath}\n${timestamp}`;
if (requestData) {
const base64Encoded = Buffer.from(JSON.stringify(requestData)).toString('base64');
msg += `\n${base64Encoded}`;
}
const signedKey = crypto
.createHmac('sha256', secretKey)
.update(msg)
.digest('hex');
return [signedKey, timestamp];
}
مثال :
POST\n/api/v1/test?example=sample\n1689680240824\neyJleGFtcGxlIjoic2FtcGxlIn0=
یا در صورت عدم وجود data :
POST\n/api/v1/test?example=sample\n1689680240824
پس از ساخت متن ریکوئست میتوان با توجه به قطعه کد های زیر در پلتفرم مربوطه مقدار امضاء ریکوئست را به دست آورد.
echo -n "Your Generated Request Text" | openssl dgst -sha256 -hmac "Your SECRET key"
بازار حرفه ای
لیست کوین ها (بازار)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"tickers": [
{
"symbol": "USDT-IRT", // اختصار
"last": "30423.0", // اخرین قیمت
"best_ask": "30423.0", // بهترین فروشنده
"best_bid": "30423.0", // بهترین خریدار
"open_24h": "30435", // قیمت باز شدن کندن در ۲۴ ساعت گذشته
"high_24h": 45000, // بیشترین قیمت ۲۴ ساعت گذشته
"low_24h": 30423, // کمترین قیمت ۲۴ ساعت گذشته
"vol_24h_pair": 2532046, // حجم معاملات به تتر در ۲۴ ساعت گذشته
"vol_24h": 78, // حجم معاملات به تعداد کوین در ۲۴ ساعت گذشته
"ts": 1664883685 // اخرین اپیدت
},
{
"symbol": "BTC-USDT",
"last": "20138.5",
"best_ask": "20139.6",
"best_bid": "20139.5",
"open_24h": "19997.5",
"high_24h": "20447.9",
"low_24h": "19731.2",
"vol_24h_pair": 1513198.570306309,
"vol_24h": 75.0731143660909,
"ts": "1665061728860"
}
],
"msg": "OK",
"code": 100
}
برای دریافت لیست کوین های بخش بازار حرفه ای، از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/market/tickers
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
مشخصات کوین (بازار)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"ticker": {
"symbol": "BABYDOGE-USDT", // اختصار
"last": "0.000000001251", // آخرین قیمت
"best_ask": "0.000000001252", // بهترین فروشنده
"best_bid": "0.000000001251", // بهترین خریدار
"open_24h": "0.000000001249", // قیمت باز شدن کندل در ۲۴ ساعت گذشته
"high_24h": "0.000000001321", // بیشترین قیمت در ۲۴ ساعت گذشته
"low_24h": "0.000000001228", // کمترین قیمت در ۲۴ ساعت گذشته
"vol_24h_pair": 2532046, // حجم معاملات به تتر در ۲۴ ساعت گذشته
"vol_24h": 78, // حجم معاملات به تعداد کوین در ۲۴ ساعت گذشته
"ts": 1664883685 // اخرین اپیدت
}
"msg": "OK",
"code": 100
}
برای دریافت قیمت و مشخصات یک کوین با استفاده از اختصار یا نام کوین از این درخواست استفاده کنید.
درخواست:
GET /oapi/v1/market/ticker
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
symbol | true | جفت ارز مورد نظر بصورت uppercase | string |
- پارامتر های ورودی باید از طریق query ارسال شوند. به مثال زیر توجه کنید:
https://example.com/api/v1/example?key=value
لیست سفارشات کاربران: اردربوک
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"books": {
"asks": [
[
"33000",
"5000"
],
[
"33500",
"5000"
]
],
"bids": [
[
"31000",
"10000"
]
]
},
"code": 100,
"msg": "OK"
}
برای دریافت لیست سفارشها یا همان اردربوک بازارهای مختلف، از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/market/orderbook
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
symbol | true | جفت ارز مورد نظر بصورت uppercase | string |
- پارامتر های ورودی باید از طریق query ارسال شوند. به مثال زیر توجه کنید:
https://example.com/api/v1/example?key=value
تاریخچه معاملات کاربران
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"history": [
{
"symbol": "USDT-IRT",
"side": "sell",
"sz": "5.0",
"price": "30015.0",
"ts": 1672047497423
},
{
"symbol": "USDT-IRT",
"side": "sell",
"sz": "993.0",
"price": "30010.0",
"ts": 1672047475694
}
],
"msg": "OK",
"code": 100
}
برای تاریخچه معاملات کاربران از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/market/trades
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
symbol | true | جفت ارز مورد نظر بصورت uppercase | string |
- پارامتر های ورودی باید از طریق query ارسال شوند. به مثال زیر توجه کنید:
https://example.com/api/v1/example?key=value
لیست سفارشات باز کاربر
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"data": [
{
"symbol": "USDT-IRT",
"side": "BUY",
"type": "LIMIT",
"price": 42000.0,
"status": "live",
"sz": 5.0,
"fill_sz": 0.0,
"ts": 1672237395000,
"ts_update": 1672237395000
},
{
"symbol": "USDT-IRT",
"side": "SELL",
"type": "LIMIT",
"price": 45000.0,
"status": "live",
"sz": 5.0,
"fill_sz": 0.0,
"ts": 1672237430000,
"ts_update": 1672237430000
}
],
"code": 100,
"msg": "OK"
}
برای دریافت لیست سفارشات باز کاربر، از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/trade/market/orderbook
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
تاریخچه معاملات کاربر
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"history": [
{
"symbol": "DOGEIRT",
"side": "BUY",
"type": "LIMIT",
"price": 1430.0,
"status": "canceled",
"sz": 200.0,
"fill_sz": 0.0,
"ts": 1613817900329,
"ts_update": 1613818124385
},
{
"symbol": "DOGEIRT",
"side": "BUY",
"type": "LIMIT",
"price": 1479.0,
"status": "canceled",
"sz": 140.0,
"fill_sz": 0.0,
"ts": 1613818385605,
"ts_update": 1613818902906
}
],
"msg": "OK",
"code": 100
}
برای دریافت لیست تاریخچه معاملات کاربر، از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/trade/market/history
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
ثبت سفارش (بازار)
نمونه پارامتر های ارسالی:
{
"quantity": "100",
"symbol": "USDT-IRT",
"type": "STOP_LOSS",
"side": "BUY",
"price": "35000",
"stop_price": "35000"
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"order_id": 97, //شناسه سفارش
"code": 100,
"msg": "OK"
}
برای ثبت سفارش جدید در بخش بازار حرفه ای از این درخواست استفاده نمایید:
درخواست:
POST /oapi/v1/trade/market
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
quantity | true | مقدار سفارش | string |
symbol | true | اختصار کوین همراه مارکت | string |
type | true | نوع سفارش (LIMIT , MARKET , STOP_LOSS) | string |
side | true | جهت سفارش | string |
price | (true به جز برای نوع MARKET) | قیمت سفارش | string |
stop_price | (true فقط برای نوع STOP_LOSS) | ایستگاه | string |
لغو سفارش (بازار)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"code": 100,
"msg": "OK"
}
برای لغو یک سفارش باز در بخش بازار حرفه ای از این درخواست استفاده نمایید:
درخواست:
POST /oapi/v1/trade/market/cancel
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
order_id | true | شناسه سفارش | string |
فاکتور معاملات (بازار)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"data": [
{
"order_id": 88, //شناسه فاکتور
"price": 30000.0, //قیمت
"fee": 0.015, //کمیسیون
"fee_ccy": "USDT", //واحد کارمزد
"ts": 1665928207000 //تاریخ ایجاد
}
],
"code": 100,
"msg": "OK"
}
برای دریافت فاکتور یک سفارش از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/trade/market/fills
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
order_id | true | شناسه سفارش | string |
- پارامتر های ورودی باید از طریق query ارسال شوند. به مثال زیر توجه کنید:
https://example.com/api/v1/example?key=value
تبادل سریع
لیست کوین های موجود (تبادل سریع)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"tickers": [
{
"asset": "USDT", // اختصار
"allow_buy": true, // وضعیت خرید
"allow_sell": true, // وضعیت فروش
"name": "Tether", // نام کامل
"lot_size": 5, // تعداد اعشار مجاز
"buy_px": "32875", // قیمت خرید از سایت
"sell_px": "32875" // قیمت خرید از سایت
},
{
"asset": "VITE",
"allow_buy": true,
"allow_sell": true,
"name": "VITE",
"lot_size": 1,
"buy_px": 898.145,
"sell_px": 895.515
}
],
"msg": "OK",
"code": 100
}
برای دریافت لیست کوین های تبادل سریع به همراه قیمت و مشخصات، از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/otc/tickers
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
مشخصات کوین (تبادل سریع)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"ticker": [
{
"asset": "BTC", // اختصار
"allow_buy": true, // وضعیت خرید
"allow_sell": true, // وضعیت فروش
"name": "Bitcoin", // نام کامل
"lot_size": 8, // تعداد اعشار مجاز
"buy_px": 634064496, // قیمت خرید از سایت
"sell_px": 634061208 // قیمت فروش به سایت
}
],
"msg": "OK",
"code": 100
}
برای دریافت قیمت و مشخصات یک کوین با استفاده از اختصار یا نام کوین از این درخواست استفاده کنید.
درخواست:
GET /oapi/v1/otc/ticker
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
asset | false | جفت ارز مورد نظر بصورت uppercase | string |
- پارامتر های ورودی باید از طریق query ارسال شوند. به مثال زیر توجه کنید:
https://example.com/api/v1/example?key=value
محاسبه ی قیمت
نمونه پارامتر های ارسالی:
{
"fromAsset": "USDT",
"amount": 1,
"side": "BUY",
"mode": "AMOUNT"
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"amount": 1.0, //مقدار کوین
"toSz": 50178, // total ریالی
"cnvId": "3d897420-459c-11ee-b9e8-0242ac1c0534", // ایدی تراکنش
"expire": 5, // زمان اعتبار قیمت
"gem": 0.0, // امتیاز دریافتی
"msg": "OK",
"code": 100,
"status": true
}
برای دریافت قیمت مقدار کوین انتخاب شده درحالت لاگین از این درخواست استفاده کنید.
درخواست:
POST /api/v2/otc/estimate
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
fromAsset | true | اختصار کوین مورد نظر به صورت uppercase | string |
amount | true | مقدار که معادل تومانی و یا مقدار کوین مورد نظر است. | number |
side | true | جهت سفارش که برای خرید مقدار buy و برای فروش مقدار sell | string |
mode | true | نوع فیلد مقدار که دوحالت دارت: TOTAL و یا AMOUNT | string |
محاسبه ی قیمت
نمونه پارامتر های ارسالی:
{
"fromAsset": "USDT",
"amount": 1,
"side": "BUY",
"mode": "AMOUNT"
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"amount": 1.0, //مقدار کوین
"toSz": 50178, // total ریالی
"cnvId": "3d897420-459c-11ee-b9e8-0242ac1c0534", // ایدی تراکنش
"expire": 5, // زمان اعتبار قیمت
"msg": "OK",
"code": 100,
"status": true
}
برای دریافت قیمت مقدار کوین انتخاب شده به صورت پابلیک از این درخواست استفاده کنید.
درخواست:
POST /api/v2/otc/estimate/public
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
fromAsset | true | اختصار کوین مورد نظر به صورت uppercase | string |
amount | true | مقدار که معادل تومانی و یا مقدار کوین مورد نظر است. | number |
side | true | جهت سفارش که برای خرید مقدار buy و برای فروش مقدار sell | string |
mode | true | نوع فیلد مقدار که دوحالت دارت: TOTAL و یا AMOUNT | string |
ثبت سفارش (تبادل سریع)
نمونه پارامتر های ارسالی:
{
"cnvId": "5623ca2a-4570-11ee-a857-0242ac1c0534"
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"code": 100,
"id": 793,
"msg" : "OK",
"status": true
}
برای ثبت سفارش خرید یا فروش از سایت از این درخواست استفاده کنید.
درخواست:
POST /api/v2/otc/convert
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
cnvId | true | توکن قیمت که از وب سرویس estimate دریافت می شود. | string |
تاریخچه خرید و فروش (تبادل سریع)
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"data": [
{
"asset": "BTC", //اختصار کوین
"amount": 0.001, //مقدار
"amount_rial": 656887.26272, // قیمت ریالی
"discount": 0.0, //تخفیف
"side": "buy", //خرید یا فروش
"ts": 1666180274000 //timestamp
},
{
"asset": "BTC",
"amount": 0.005,
"amount_rial": 3226637.1160700005,
"discount": 0.0,
"side": "buy",
"ts": 1665938145000
}
],
"code": 100,
"msg": "OK"
}
برای دریافت لیست تاریخچه های خرید و فروش از سایت از این درخواست استفاده کنید.
درخواست:
GET /oapi/v1/trade/otc/history
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
side | false | جهت سفارش که برای خرید مقدار buy و برای فروش مقدار sell | string |
- پارامتر های ورودی باید از طریق query ارسال شوند. به مثال زیر توجه کنید:
https://example.com/api/v1/example?key=value
کیف پول
موجودی کیف پول
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"wallets": [
{
"asset": "BTC", // اختصار
"name": "Bitcoin", // نام
"is_withdrawal": null, // وضعیت برداشت
"is_deposit": null, // وضعیت واریز
"is_transfer": false, // وضعیت انتقال بین کیف پولی
"otc_balance": 7.0, // موجودی تبادل سریع
"trade_balance": 0.0, // موجودی بازار حرفه ای
"pending_trade": 0.0 // درگیر در سفارشات بازار
},
{
"asset": "TRX",
"name": "TRON",
"is_withdrawal": true,
"is_deposit": true,
"is_transfer": false,
"otc_balance": 150000.0,
"trade_balance": 0.0,
"pending_trade": 0.0
}
],
"msg": "OK",
"code": 100
}
برای دریافت موجودی های کیف پول اصلی، از این درخواست استفاده نمایید:
درخواست:
GET /oapi/v1/wallet
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
دریافت آدرس
نمونه پارامتر های ارسالی:
{
"coin": "USDT",
"network": "TRC20",
"gen_addr": true,
"update_addr": false
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"address": "TDBHSqTa1RKf5QneKBCoqLMvxjPbKUXGLW", // آدرس
"tag": "", // ممو یا تگ
"estimated_time": 20274, // مدت زمان مالکیت آدرس
"msg": "OK", // پیغام خطا(درصورت بروز خطا)
"code": 100, // کد خطا(درصورت بروز خطا)
"status": true // وضعیت پاسخ دریافتی(موفق/ناموفق)
}
برای دریافت آدرس شبکه از این درخواست استفاده کنید.:
درخواست:
POST /oapi/v1/wallet/deposit/address
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
coin | true | کوین برای واریز | string |
network | true | نام شبکه برای واریز | string |
gen_addr | false | فلگ برای ساخت آدرس جدید | string |
update_addr | false | فلگ برای تمدید آدرس قبلی | string |
تاریخچه واریز
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"data": [
{
"amount": 50000.0, // مقدار تراکنش
"tx_id": "1e336f450982bc92ce01295ad8541248b609393c4f53333f8ccf15a224c7bbbe", // لینک تاکنش
"address": "TDBHSqTa1RKf5QneKBCoqLMvxjPbKUXGLW", // ادرس کیف پول
"asset": "USDT", // اختصار کوین
"status": "DONE", // وضعیت واریز
"ts": 1662806932000 // زمان واریز
},
{
"amount": 1000.0,
"tx_id": "3eab6d8987a932cf74aacb292b01584915967a0b9fa8877c9514e112885211cc",
"address": "TDBHSqTa1RKf5QneKBCoqLMvxjPbKUXGLW",
"asset": "USDT",
"status": "DONE",
"ts": 1662825609000
}
],
"code": 100,
"msg": "OK"
}
برای دریافت تاریخچه های واریز از این درخواست استفاده کنید.:
درخواست:
GET /oapi/v1/wallet/deposit/history
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
برداشت
نمونه پارامتر های ارسالی:
{
"coin": "BTC",
"amount": "0.001",
"to_address": "dsadsadsa",
"network": "BTC"
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"code": 100,
"id": 123456,
"internal": true,
"msg": "OK",
"status": true
}
برای برداشت کوین و برداشت ریالی از این درخواست استفاده کنید.:
درخواست:
POST /oapi/v1/wallet/withdrawal
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
پارامتر های ورودی
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
coin | true | کوینی برای برداشت | string |
amount | true | مقدار کوینی برای برداشت | string |
to_address | true | ادرس کیف پول مقصد | string |
network | true | شبکه | string |
تاریخچه برداشت
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"data": [
{
"address": "0xe037b2a8d8fce5a71b00adc954bb6196a463f2de" //آدرس کیف پولی که به آن واریز کردیم
"amount": "0.015" // مقدار
"asset": "ETH" // اختصار کوینی که برداشت کردیم
"coin_id": 8 // آیدی کوین که برداشت کردیم
"created_at" : "2022-09-28T10:39:12.000Z" // تاریخ ایجاد
"des_for_user": null // توضیحات تراکنش
"fee": "0" // کمیسیون
"full_t": "122" //
"id": 1959650 // آیدی
"network": "ERC20" // شبکه ی استفاده شده
"status": "DONE" // وضعیت برداشت
"tag": ""
"txid": "okex-internal-1959650" // لینک تراکنش
}
],
"code": 100,
"msg": "OK"
}
برای دریافت تاریخچه برداشت ها از این درخواست استفاده کنید.
درخواست:
GET /oapi/v1/wallet/withdrawal/history
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
انتقال
نمونه پارامتر های ارسالی:
{
"coin": "USDT",
"amount": "0.001",
"wallet_from": "OTC",
"wallet_to": "TRADE"
}
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"code": 100,
"msg": "OK"
}
برای انتقال بین کیف پولی از این درخواست استفاده کنید.:
درخواست:
POST /oapi/v1/wallet/transfer
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
عنوان | اجباری | توضیحات | نوع |
---|---|---|---|
coin | true | کوینی برای انتقال | string |
amount | true | مقدار کوینی برای انتقال | string |
wallet_from | true | کیف پول مبدا | string |
wallet_to | true | کیف پول مقصد | string |
تاریخچه انتقال
در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:
{
"data": [
{
"amount": 829268123.1733981, // مقدار انتقال
"asset": "IRT", // اختصار کوینی که انتقال دادیم
"wallet_from": "OTC", // کیف پولی که از ان انتقال دادیم
"wallet_to": "TRADE", // کیف پولی که به آن انتقال دادیم
"ts": 1662649337000 // تاریخ انتقال
},
{
"amount": 829268123.1733981,
"asset": "IRT",
"wallet_from": "TRADE",
"wallet_to": "OTC",
"ts": 1662650319000
}
],
"code": 100,
"msg": "OK"
}
برای دریافت تاریخچه انتقال از این درخواست استفاده کنید.:
درخواست:
GET /oapi/v1/wallet/transfer/history
محدودیت ها:
- تعداد درخواست های مجاز در هر دقیقه ۶۰ عدد است.
ملاحظات
کد وضعیت ها
کد | توضیحات |
---|---|
200 | عملیات با موفقیت انجام شد |
401 | توکن وجود ندارد یا نامعتبر است |
403 | خطای دسترسی |
400 | درخواست نامعتبر |
404 | دیتای مورد نظر یافت نشد |
422 | مقادیر ورودی به درستی وارد نشده است |
500 | خطای داخلی سرور لطفا این مورد را به پشتیبانی اطلاع دهید |
کد خطاها
API ها از کد خطاهای زیر استفاده میکنند:
کد | توضیحات |
---|---|
100 | OK |
101 | نوع دیتای ارسالی باید به فرم JSON باشد |
102 | اطلاعات درخواستی مورد نظر یافت نشد |
103 | اختصار کوین اجباری است |
104 | درخواست انجام نشد |
105 | تاریخ شروع نامعتبر است |
106 | تاریخ پایان نامعتبر است |
107 | خطای سیستمی |
108 | مقادیر الزامی را وارد کنید |
109 | مقادیر را به درستی وارد کنید |
110 | تاریخ منقضی شده |
111 | این ip به api key دسترسی ندارد |
112 | فیلد side اجباری است |
113 | دسترسی به apy key امکان پذیر نیست |
1000 | در حال حاظر واریز کوین مورد نظر بسته می باشد. |
1001 | جهت تمدید آدرس باید حداقل ۱۵ دقیقه از زمان دریافت یا تمدید قبلی گذشته باشد. |
1002 | آدرس موجود نمی باشد یا منقصی شده است در صورت لزوم میتواند آدرس بسازید. |
1003 | آدرس موجود نمی باشد در صورت لزوم میتواند آدرس بسازد. |
1100 | مقدار برداشت شما نباید کمتر از 50 هزار تومان باشد. |
1101 | برداشت در حال حاظر بسته می باشد لطفا چند دقیقه دیگر تلاش کنید. |
1102 | حساب شما باید تایید شده باشد. |
1103 | برداشت از حساب برای شما بسته می باشد. |
1104 | کیف پول شما تا زمان معینی بسته می باشد. |
1105 | آدرس مورد نظر صحیح نمی باشد. |
1106 | در هر بار برداشت کوین ، امکان برداشت بیش از 100 میلیون میسر نیست! |
1107 | شما تنها مجاز به ۳ درخواست برداشت در هر ۲۴ ساعت می باشید به مبلغ 300 میلیون تومان، لطفا ۲۴ ساعت دیگر سعی کنید. |
1108 | حداکثر برداشت از حساب شما نباید بیشتر از 100 میلیون تومان در روز باشد. |
1109 | موجودی حساب شما کافی نمی باشد. |
1200 | خطای انتقال |
1201 | انتقال بسته شده است |
1202 | کیف پول مبدا یا کیف پول مقصد نامعتبر است |
1300 | خرید ارز مورد نظر بسته می باشد. |
1301 | کوین شناسایی نشد ، لطفا مراحل خرید را از اول طی کنید. |
1302 | مقدار کمتر از حد مجاز می باشد. |
1303 | حساب شما بسته می باشد در صورت نیاز می توانید با پشتیبانی تماس بگیرید. |
1304 | خرید یا فروش از سایت برای شما بسته میباشد. |
1305 | لطفا ابتدا اطلاعات پایه خود را تایید نمایید. |
1306 | مشکل در خرید ارز مورد نظر لطفا چند دقیقه دیگر تلاش کنید. |
1307 | موجودی حساب شما کافی نمی باشد. |
1308 | قیمت کمتر از حد مجاز. |
1309 | مشکل در خرید ارز مورد نظر لطفا چند دقیقه دیگر تلاش کنید. |
1400 | امکان ثبت ترید در حال حاظر امکان پذیر نمی باشد. |
1401 | ثبت ترید برای کوین مورد نظر امکان پذیر نمی باشد. |
1402 | مقدار اعشار وارد شده در مقدار معتبر نمی باشد. |
1403 | مقدار مورد نظر کمتر از حد مجاز می باشد. |
1404 | قیمت نباید بیشتر از حد مجاز باشد. |
1405 | سفارش خود را در بازه معتبر ثبت نمایید. |
1406 | ایستگاه و قیمت نباید با هم برابر باشند. |
1407 | ایستگاه نباید از قیمت مارکت کوچکتر یا مساوی باشد. |
1408 | ایستگاه نباید از قیمت شما بزرگتر باشد. |
1409 | ایستگاه نباید از قیمت مارکت بزرگتر یا مساوی باشد. |
1410 | ایستگاه نباید از قیمت شما کوچکتر باشد. |
1411 | مشکل در ثبت معامله دوباره اقدام نمایید. |
1412 | معامله مناسب برای شما یافت نشد. |
1413 | امکان ثبت معامله برای شما بسته می باشد. |
1414 | در حال حاظر امکان لغو معامله میسر نمی باشد. |
1415 | معامله یافت نشد. |
1416 | لغو معامله برای این مارکت بسته میباشد. |
1417 | شماره معامله وارد شده صحیح نمی باشد. |
1418 | سفارش لغو نشد لطفا دوباره اقدام نمایید. |
1419 | تعداد سفارش های باز شده بیش از حد مجاز می باشد. |
1420 | مبلغ سفارش باید بیشتر از حداقل مقدار موجود باشد. |
1421 | پارامتر مقدار یا قیمت اشتباه می باشد. |
1422 | سفارش لغو نشد ، سفارش از قبل کامل شده. |
1423 | سفارش لغو نشد ، سفارش از قبل لغو شده می باشد. |
1424 | مقدار فعلی بیش از حد مجاز می باشد لطفا مقدار خود را کاهش دهید. |