NAV
shell plaintext

مستندات API بیت24

اینجا صفحه مستندات API صرافی بیت ۲۴ است. بیت ۲۴ با هدف کمک به کاربران و توسعه‌دهندگان، API خود را در اختیار آ‌ن‌ها قرار داده است تا ضمن اطلاع از آخرین قیمت‌ها و ارزیابی وضعیت بازار، به قابلیت مدیریت خودکار حساب کاربری دسترسی داشته باشند. با استفاده از API همیشه چند قدم جلوتر از سایر کاربران حرکت کرده و علاوه بر معامله در بهترین قیمت‌های ممکن، امکانات نوین ترید را در اختیار خواهید داشت.

قبل شروع کار با API بیت ۲۴ حتما قوانین کلی این صرافی و همچنین شرایط و مقررات مربوط به استفاده از API را مرور کنید. از طرفی، با توجه به این که احتمال بروزرسانی یا اعمال یک سری تغییرات در ساختار و جزئیات API وجود دارد، بهتر است برای مشاهده سریع و به موقع آخرین اطلاعیه‌ها، کانال رسمی ما در تلگرام را دنبال کنید. یکی از نکات حائز اهمیت در زمان ایجاد کدهایی که از API بیت ۲۴ استفاده می‌کنند، در نظر گرفتن عکس‌العمل‌های مناسب در مواجهه با خطا و حالت‌های پیش‌بینی نشده است. از آن جایی که با، بازاری بسیار پر نوسان سروکار داریم، توصیه می‌کنیم کدهای حاوی API صرافی بیت ۲۴ با رعایت تمام اصول و در نظر گرفتن ملاحظاتی همچون کنترل نرخ درخواست‌ها در شرایط مختلف، مدیریت حالت‌های خطا، پیش‌گیری از تشدید آبشاری خطاها، سازوکارهای حفاظت در عمق، وجود سامانه‌های مانیتورینگ و اعلان، وجود سازوکارهای مدیریت ریسک و دیگر موارد ضروری توسعه داده شوند.

اگر قبلا از API بیت ۲۴ استفاده نکرده اید، کار خود را با ورود به بخش،راهنمای شروع به کار با API آغاز کنید.

احراز هویت و توکن

X-BIT24-APIKEY: *******DDF**78*************186

برای استفاده از APIها نیاز به ارسال توکن وجود دارد. این توکن باید در HTTP Header درخواست به صورت زیر ارسال شود:

X-BIT24-APIKEY: *******DDF**78*************186

‍

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

در این صفحه می توانید IP هایی که می توانند از این توکن استفاده کنند را مشخص کنید.

PHP-EXAMPLE: $signature = hash_hmac('sha256', $prameters,$secret_key);

در صورت عدم ارسال یا نادرست بودن مقدار signature، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "errors": [
            {
                "reason": "signature",
                "message": "امضا اشتباه است."
            }
        ],
        "message": "خطا در اعتبار سنجی ورودی ها"
    },
    "status_code": 422,
    "success": false
}

راهنما شروع به کار با API

اگر برای اولین بار از API بیت24 استفاده می‌کنید، برای شروع کار پیشنهاد می‌شود گام‌های زیر را طی کنید:

برای شروع کار با API ابتدا در بیت24 ثبت‌نام نمایید و مراحل احراز هویت خود را تا سطح پیشرفته انجام دهید. با مراجعه به پنل کاربری خود در بیت24، از بخش پروفایل وارد صفحه مدیریت API شده و توکن خود را دریافت نمایید. دسترسی به این توکن به منزله دسترسی کامل به حساب شماست، در نتیجه در حفاظت آن دقت کامل داشته باشید. اگر با نرم‌افزار Postman آشنا هستید، می‌توانید برای تست فراخوانی APIهای اصلی بیت24، از کالکشن Postman بیت24 استفاده کنید. لازم به توضیح است که این کالکشن تنها شامل برخی از APIهای بیت24 و کاربرد آن‌ها است و مرجع اصلی مستندات، همین صفحه است.

اطلاعات شبکه های قابل برداشت

curl --location 'https://rest.bit24.cash/lite/capi/v1/withdraw/networks?symbol=TRX' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186' 

GET https://rest.bit24.cash/lite/capi/v1/withdraw/networks?symbol=TRX

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "data": {
    "balance": "195.92430000",
    "networks": [
      {
        "network_id": 486,
        "network_name": "TRX",
        "network_layer": "TRX",
        "min_withdraw": "7",
        "max_withdraw": null,
        "fee": "2",
        "address_regex": "^T[1-9A-HJ-NP-Za-km-z]{33}$",
        "memo_regex": null
      }
    ],
    "message": ""
  },
  "error": null
}

در صورت تناقض ورودی، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 422,
    "error": {
        "message": "خطا در اعتبار سنجی ورودی ها",
        "errors": [
            {
                "reason": "symbol",
                "message": "symbol (نماد) الزامی است."
            }
        ]
    },
    "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 401,
    "error": {
        "message": "عدم احراز.",
        "errors": null

    },
    "data": null
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null

    },
    "status_code": 404,
    "success": false
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 500,
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "data": null
}

برای دریافت اطلاعات شبکه های قابل برداشت از این درخواست استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
symbol string الزامی ارز BTC
پارامتر توضیحات مقادیر
symbol نماد ارز دیجیتال برای دریافت اطلاعات شبکه های قابل برداشت

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
balance string موجودی
networks array اطلاعات شبکه ها
networks.network_id numeric شناسه شبکه
networks.network_name string نام شبکه
networks.network_layer string لایه شبکه
networks.min_withdraw string حداقل مقدار برداشت
networks.max_withdraw string حداکثر مقدار برداشت
networks.fee string کمیسیون شبکه
networks.address_regex string الگو صحیح آدرس شبکه
networks.memo_regex string الگو ممو کیف پول

برداشت

curl --location 'https://rest.bit24.cash/lite/capi/v1/withdraw/submit' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186' \
--data-urlencode 'symbol=TRX' \
--data-urlencode 'network_id=486' \
--data-urlencode 'address=TXQmDK38s5YHjJDF7xuGpJtGTH9WeDVpk5' \
--data-urlencode 'value=50' \
--data-urlencode 'signature=eb5c373bb3f28434006566efc98bcb7067e5027b21a67bb284e8067100e2db7b'

POST https://rest.bit24.cash/lite/capi/v1/withdraw/submit

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "data": {
    "message": "درخواست برداشت شما با موفقیت ثبت شد."
  },
  "error": null
}

در صورت تناقض ورودی، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 422,
    "error": {
        "message": "خطا در اعتبار سنجی ورودی ها",
        "errors": [
            {
                "reason": "symbol",
                "message": "symbol (نماد) الزامی است."
            },
            {
                "reason": "network_id",
                "message": "ارز/شبکه الزامی است."
            },
            {
                "reason": "address",
                "message": "آدرس الزامی است."
            },
            {
                "reason": "value",
                "message": "مقدار الزامی است."
            }
        ]
    },
    "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 401,
    "error": {
        "message": "عدم احراز.",
        "errors": null
    },
    "data": null
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 500,
    "error": {
        "message": "خطای برنامه نویسی: در قسمتی از برنامه خطای ناشناخته ای وجود دارد",
        "errors": null
    },
    "data": null
}

برای ثبت برداشت از این درخواست استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
symbol string الزامی ارز TRX
network_id numeric الزامی شناسه شبکه 486
address string الزامی آدرس کیف پول TXQmDK38s5YHjJDF7xuGpJtGTH9WeDVpk5
memo string اختیاری ممو کیف پول 123456
value numeric الزامی مقدار برداشت 1000
signature string الزامی امضا 48187874b431653147d59717150da82b6560fa3dee739fdb
پارامتر توضیحات مقادیر
memo در بعضی از شبکه های کیف پول ممو مورد نیاز است.

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
message string پیام

اطلاعات شبکه های قابل واریز

curl --location 'https://rest.bit24.cash/lite/capi/v1/deposit/networks?symbol=TRX' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186' 

GET https://rest.bit24.cash/lite/capi/v1/deposit/networks?symbol=TRX

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "data": {
    "networks": [
      {
        "network_name": "TRX",
        "network_layer": "TRX",
        "description_deposit": "کاربران گرامی به هیچ وجه از سایت www.8trx8.com به بیت24 مستقیم ارز انتقال ندهید. ابتدا به والت شخصی مثل Trust منتقل سپس به بیت 24 ارسال کنید.در صورت عدم توجه و مشکل، بیت24 مسئولیتی نمیپذیرد",
        "min_deposit": "10",
        "address": "TAxFTcVThKKg9sMH2JSGacFHLVE6vkK9bV",
        "memo": null
      }
    ],
    "message": ""
  },
  "error": null
}

در صورت تناقض ورودی، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 422,
    "error": {
        "message": "خطا در اعتبار سنجی ورودی ها",
        "errors": [
            {
                "reason": "symbol",
                "message": "symbol (نماد) الزامی است."
            }
        ]
    },
    "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "success": false,
    "status_code": 401,
    "error": {
        "message": "عدم احراز.",
        "errors": null
    }
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 500,
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    }
}

برای دریافت اطلاعات شبکه های قابل واریز از این درخواست استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
symbol string الزامی ارز TRX
پارامتر توضیحات مقادیر
symbol نماد ارز دیجیتال برای دریافت اطلاعات شبکه های قابل واریز

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
network_name string نام شبکه
network_layer string لایه شبکه
description_deposit string توضیحات واریز
min_deposit string حداقل مقدار واریز
address string آدرس کیف پول
memo string ممو کیف پول

اطلاعات دارایی

curl --location 'https://rest.bit24.cash/asset/capi/v1/wallet/assets?name=DOGE&without_zero=0&without_irt=1&alphabet=d&page=1' \
--header 'Accept: application/json' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/asset/capi/v1/wallet/assets?name=DOGE&without_zero=0&without_irt=1&alphabet=d&page=1

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "success": true,
    "status_code": 200,
    "error": null,
    "data": {
        "message": "",
        "asset": [
          {
            "id": 11,
            "name": "Tron",
            "fa_name": "ترون",
            "symbol": "TRX",
            "coin_type": 0,
            "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/b79477c5-e085-4a7b-a2b3-ea00ba539bdd.png",
            "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/b79477c5-e085-4a7b-a2b3-ea00ba539bdd.png",
            "each_price": "0.1514000000000000",
            "change_24hr": "1.06",
            "balance": "100000200.00000000",
            "available_balance": "100000200.00000000",
            "in_orders": "0.00000000",
            "balance_irt": "781982563962",
            "balance_usdt": "15140030.28",
            "markets": [
              {
                "base_coin_symbol": "TRX",
                "quote_coin_symbol": "IRT",
                "is_active": 1
              },
              {
                "base_coin_symbol": "TRX",
                "quote_coin_symbol": "USDT",
                "is_active": 1
              }
            ]
          },
          {
            "id": 20,
            "name": "Dogecoin",
            "fa_name": "دوج کوین",
            "symbol": "DOGE",
            "coin_type": 0,
            "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
            "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
            "each_price": "0.0958000000000000",
            "change_24hr": "1.57",
            "balance": "100000110.00000000",
            "available_balance": "100000010.00000000",
            "in_orders": "0.00000000",
            "balance_irt": "494807544287",
            "balance_usdt": "9580010.53",
            "markets": [
              {
                "base_coin_symbol": "DOGE",
                "quote_coin_symbol": "IRT",
                "is_active": 1
              },
              {
                "base_coin_symbol": "DOGE",
                "quote_coin_symbol": "USDT",
                "is_active": 1
              }
            ]
          }
        ]
    }
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false
}

برای دریافت لیست اطلاعات دارایی رمز ارز ها از این درخواست استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
name string اختیاری ارز پایه BTC
alphabet string اختیاری ارز متقابل e(ارز هایی که شروع کلماتشان با کاراکتر مورد نظر است)
without_irt string اختیاری جهت سفارش 0
without_zero string اختیاری نوع سفارش 1
پارامتر توضیحات مقادیر
without_irt 0 = همه ارز ها, 1 = همه ارز ها - ارز تومان
without_zero 0 = همه ارز ها , 1 = ارز هایی که مقدار داراییشان بیشتر از 0 است

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
id numeric شناسه ارز
name string نام ارز
fa_name string نام فارسی ارز
symbol string نماد ارز
coin_type numeric نوع ارز (0 = ارز دیجیتال , 1 =ارز نقدی)
web_icon string آیکون ارز در وبسایت
app_icon string آیکون ارز در موبایل
each_price string قیمت ارز
change_24hr string درصد تغییر 24 ساعت اخیر
balance string مقدار دارایی
available_balance string مقدار در دسترس دارایی
in_orders string مقدار قفل شده دارای در سفارشات
balance_irt string ارزش ریالی دارایی در دسترسی ارز
balance_usdt string ارزش تتری دارایی در دسترسی ارز
markets array بازار های موجود بر اساس ارز
markets.base_coin_symbol string ارز پایه
markets.base_coin_symbol string ارز متقابل
markets.is_active numeric وضعیت بازار(1 = فعال , 0 = غیر فعال)

اطلاعات مجموع دارایی

curl --location 'https://rest.bit24.cash/asset/capi/v1/wallet/assets/total?with_asset_main_coins=1' \
--header 'Accept: application/json' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/asset/capi/v1/wallet/assets/total?with_asset_main_coins=1

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "error": null,
  "data": {
    "message": "",
    "assets": {
      "total_assets": {
        "total_crypto_asset_in_usdt": "258.34683510",
        "total_crypto_asset_in_irt": "13343614",
        "total_crypto_asset_in_btc": "0.00456290",
        "available_crypto_asset_in_usdt": "258.34683510",
        "available_crypto_asset_in_irt": "13343614",
        "available_crypto_asset_in_btc": "0.00456290",
        "total_irt_asset": "985851659",
        "total_irt_asset_in_usdt": "19087.15700344",
        "available_irt_asset": "984841912",
        "available_irt_asset_in_usdt": "19067.60721290"
      },
      "user": {
        "total_crypto_asset_in_usdt": "258.34683510",
        "total_crypto_asset_in_irt": "13343614",
        "total_crypto_asset_in_btc": "0.00456290",
        "available_crypto_asset_in_usdt": "258.34683510",
        "available_crypto_asset_in_irt": "13343614",
        "available_crypto_asset_in_btc": "0.00456290",
        "total_irt_asset": "985851659.22769095",
        "total_irt_asset_in_usdt": "19087.15700344",
        "available_irt_asset": "984841912.54662015",
        "available_irt_asset_in_usdt": "19067.60721290"
      }
    }
  }
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false,
    "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false,
    "data": null
}

برای دریافت اطلاعات مجموع دارایی از این نوع درخواست استفاده نمایید:

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
total_assets.total_crypto_asset_in_usdt string مجموع مقدار دارایی‌های کریپتویی کاربر در کیف پول های مختلف به تتر.
(شامل دارایی تومانی نمیباشد)
total_assets.total_crypto_asset_in_irt string مجموع مقدار دارایی‌های کریپتویی کاربر در کیف پول های مختلف به تومان.
(شامل دارایی تومانی نمیباشد)
total_assets.total_crypto_asset_in_btc string مجموع مقدار دارایی‌های کریپتویی کاربر در کیف پول های مختلف به بیتکوین.
(شامل دارایی تومانی نمیباشد)
total_assets.available_crypto_asset_in_usdt string مجموع مقدار دارایی‌های کریپتویی دردسترس کاربر در کیف پول های مختلف به تتر.
(شامل دارایی تومانی نمیباشد)
total_assets.available_crypto_asset_in_irt string مجموع مقدار دارایی‌های کریپتویی دردسترس کاربر در کیف پول های مختلف به تومان.
(شامل دارایی تومانی نمیباشد)
total_assets.available_crypto_asset_in_btc string مجموع مقدار دارایی‌های کریپتویی در دسترس کاربر در کیف پول های مختلف به بیتکوین.
(شامل دارایی تومانی نمیباشد)
total_assets.total_irt_asset string مجموع دارایی ارز تومان در همه کیف پول ها
total_assets.total_irt_asset_in_usdt string معادل تتری، ارز تومان در همه کیف پول ها
total_assets.available_irt_asset string دارایی در دسترس ارز تومان در همه کیف پول ها
total_assets.available_irt_asset_in_usdt string معادل دارایی در دسترس ارز تومان به تتر در همه کیف پول ها
user.total_crypto_asset_in_usdt string مجموع مقدار دارایی‌های کریپتویی کاربر در کیف پول کاربر به تتر.
(شامل دارایی تومانی نمیباشد)
user.total_crypto_asset_in_irt string مجموع مقدار دارایی‌های کریپتویی کاربر در کیف پول کاربر به تومان.
(شامل دارایی تومانی نمیباشد)
user.total_crypto_asset_in_btc string مجموع مقدار دارایی‌های کریپتویی کاربر در کیف پول کاربر به بیتکوین.
(شامل دارایی تومانی نمیباشد)
user.available_crypto_asset_in_usdt string مجموع مقدار دارایی‌های کریپتویی دردسترس کاربر در کیف پول کاربر به تتر.
(شامل دارایی تومانی نمیباشد)
user.available_crypto_asset_in_irt string مجموع مقدار دارایی‌های کریپتویی در دسترس کاربر در کیف پول کاربر به تومان.
(شامل دارایی تومانی نمیباشد)
user.available_crypto_asset_in_btc string مجموع مقدار دارایی‌های کریپتویی دردسترس کاربر در کیف پول کاربر به بیتکوین.
(شامل دارایی تومانی نمیباشد)
user.total_irt_asset string مجموع دارایی ارز تومان در کیف پول کاربر
user.total_irt_asset_in_usdt string معادل تتری، ارز تومان در کیف پول کاربر
user.available_irt_asset string دارایی در دسترس ارز تومان در کیف پول کاربر
user.available_irt_asset_in_usdt string معادل دارایی در دسترس ارز تومان به تتر در کیف پول کاربر

تاریخچه کیف پول

curl --location 'https://rest.bit24.cash/asset/capi/v1/wallet/assets/history?type=0&reason_type=0&balance_status=0&from=2023-01-12&to=2023-12-12&coin_type=0&symbol=btc' \
--header 'Accept: application/json' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/asset/capi/v1/wallet/assets/history?type=0&reason_type=0&balance_status=0&from=2023-01-12&to=2023-12-12&coin_type=0&symbol=btc

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "error": null,
  "data": {
    "message": "",
    "has_paginate": 1,
    "total_data": 170,
    "current_page": 1,
    "from": 1,
    "to": 40,
    "last_page": 5,
    "per_page": 40,
    "results": [
      {
        "id": 238297,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "qY66eaa3edb17e1Gn",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 13:27:01",
        "created_at_jalali": "1403/6/28 - 13:27:01",
        "updated_at": "2024-09-18 13:27:01",
        "updated_at_jalali": "1403/6/28 - 13:27:01"
      },
      {
        "id": 238294,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "lO66ea9faf525001J",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 13:08:55",
        "created_at_jalali": "1403/6/28 - 13:08:55",
        "updated_at": "2024-09-18 13:08:55",
        "updated_at_jalali": "1403/6/28 - 13:08:55"
      },
      {
        "id": 238289,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "hK66ea9d162e909TD",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 12:57:50",
        "created_at_jalali": "1403/6/28 - 12:57:50",
        "updated_at": "2024-09-18 12:57:50",
        "updated_at_jalali": "1403/6/28 - 12:57:50"
      },
      {
        "id": 238288,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "is66ea9c969fd70YJ",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 12:55:42",
        "created_at_jalali": "1403/6/28 - 12:55:42",
        "updated_at": "2024-09-18 12:55:42",
        "updated_at_jalali": "1403/6/28 - 12:55:42"
      },
      {
        "id": 238287,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "7v66ea99e098402oz",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 12:44:08",
        "created_at_jalali": "1403/6/28 - 12:44:08",
        "updated_at": "2024-09-18 12:44:08",
        "updated_at_jalali": "1403/6/28 - 12:44:08"
      },
      {
        "id": 238285,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "Gl66ea906cae2f967",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 12:03:48",
        "created_at_jalali": "1403/6/28 - 12:03:48",
        "updated_at": "2024-09-18 12:03:48",
        "updated_at_jalali": "1403/6/28 - 12:03:48"
      },
      {
        "id": 238278,
        "name": "Dogecoin",
        "fa_name": "دوج کوین",
        "symbol": "DOGE",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
        "value": "1000.00000000",
        "done_value": "1000.00000000",
        "type": 1,
        "transaction_code": "PI66ea74d98fb82OZ",
        "type_text": "افزایشی",
        "reason_type": "7",
        "reason_text": null,
        "reason_type_text": "بخش پشتیبانی",
        "reason_id": 1300200,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-18 10:06:09",
        "created_at_jalali": "1403/6/28 - 10:06:09",
        "updated_at": "2024-09-18 10:06:09",
        "updated_at_jalali": "1403/6/28 - 10:06:09"
      },
      {
        "id": 237678,
        "name": "Toman",
        "fa_name": "تومان",
        "symbol": "IRT",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
        "value": "25050027.34658800",
        "done_value": "25050027.34658800",
        "type": 1,
        "transaction_code": "qg66e01a978ac72Hj",
        "type_text": "افزایشی",
        "reason_type": "2",
        "reason_text": null,
        "reason_type_text": "معامله حرفه\u200cای",
        "reason_id": 35306454,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-10 13:38:21",
        "created_at_jalali": "1403/6/20 - 13:38:21",
        "updated_at": "2024-09-10 13:38:29",
        "updated_at_jalali": "1403/6/20 - 13:38:29"
      },
      {
        "id": 237676,
        "name": "Tether",
        "fa_name": "تتر",
        "symbol": "USDT",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png",
        "value": "485.48000000",
        "done_value": "485.48000000",
        "type": 0,
        "transaction_code": "kR66e01a91bba35W6",
        "type_text": "کاهشی",
        "reason_type": "2",
        "reason_text": "",
        "reason_type_text": "معامله حرفه\u200cای",
        "reason_id": 35306454,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-10 13:38:17",
        "created_at_jalali": "1403/6/20 - 13:38:17",
        "updated_at": "2024-09-10 13:38:17",
        "updated_at_jalali": "1403/6/20 - 13:38:17"
      },
      {
        "id": 237675,
        "name": "Toman",
        "fa_name": "تومان",
        "symbol": "IRT",
        "logo": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
        "value": "11805807.36205600",
        "done_value": "11805807.36205600",
        "type": 1,
        "transaction_code": "LU66e01a557a856Zx",
        "type_text": "افزایشی",
        "reason_type": "2",
        "reason_text": null,
        "reason_type_text": "معامله حرفه\u200cای",
        "reason_id": 35306403,
        "balance_status": 1,
        "balance_status_text": "موفق",
        "commission": 0,
        "final_commission": "0",
        "created_at": "2024-09-10 13:37:15",
        "created_at_jalali": "1403/6/20 - 13:37:15",
        "updated_at": "2024-09-10 13:37:17",
        "updated_at_jalali": "1403/6/20 - 13:37:17"
      }
    ]
  }
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null

    },
    "status_code": 404,
    "success": false
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false
}

برای دریافت لیست تاریخچه کیف پول خود، از این درخواست استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
type string اختیاری جهت تراکنش 1
symbol string اختیاری نماد رمز ارز BTC
coin_type string اختیاری نوع رمز ارز 0
reason_type string اختیاری نوع تراکنش 0
balance_status string اختیاری وضعیت تراکنش 0
from dateTime اختیاری از تاریخ 2022-02-20
to dateTime اختیاری تا تاریخ 2023-03-21
پارامتر توضیحات مقادیر
type 0 = کاهشی , 1 = افزایشی
coin_type 0 = رمز ارز دیجیتالی , 1 =ارز بانکی
reason_type 0 = واریز , 1 = برداشت , 2 = معامله حرفه ای , 3 = کمیسیون معرف معامله حرفه ای , 6 = معامله آنی , 7 = بخش پشتیبانی , 8 = واریز با شناسه پرداخت , 9 = کد هدیه , 10 = کمیسیون معرف معامله آنی , 11 = کمیسیون معرف , 12 = معامله دارایی خرد
balance_status 0 = در حال انجام , 1 = تکمیل شده

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
has_paginate numeric مشخص کننده اینکه این پاسخ به صورت pagination ارسال شده است.
total_data numeric تعداد کلی اطلاعات
current_page numeric مشخص کننده صفه کنونی
from numeric آیتم اول صفحه کنونی
to numeric آیتم آخر صفحه کنونی
per_page numeric تعداد آیتم های هر صفحه
results array لیست دارایی‌ها
result.id numeric شناسه تراکنش
result.name string نام ارز
result.fa_name string نام فارسی ارز
result.symbol string نماد ارز
result.logo string لینک تصویر ارز
result.value string مقدار تراکنش
result.done_value string مقدار تکمیل شده از تراکنش
result.type numeric جهت تراکنش(0 = کاهشی , 1 = افزایشی)
result.transaction_code string کد رهگیری تراکنش
result.type_text string متن جهت تراکنش
result.reason_type string نوع تراکنش
result.reason_text string توضیحات
result.reason_type_text string متن نوع تراکنش
result.reason_id numeric شناسه نوع تراکنش
result.balance_status numeric وضعیت تراکنش
result.balance_status_text string متن وضعیت تراکنش
result.commission numeric کمیسیون
result.final_commission string کمیسیون نهائی
result.created_at dateTime تاریخ ایجاد
result.created_at_jalali dateTime تاریخ شمسی ایجاد

ثبت سفارش

curl --location 'https://rest.bit24.cash/pro/capi/v1/orders/submit' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186' \
--data-urlencode 'base_coin_symbol=DOGE' \
--data-urlencode 'quote_coin_symbol=IRT' \
--data-urlencode 'stop_price=100000' \
--data-urlencode 'type=1' \
--data-urlencode 'trigger_price=110000' \
--data-urlencode 'category_type=0' \
--data-urlencode 'price=3717' \
--data-urlencode 'amount=1000' \
--data-urlencode 'signature=eb5c373bb3f28434006566efc98bcb7067e5027b21a67bb284e8067100e2db7b'

POST https://rest.bit24.cash/pro/capi/v1/orders/submit

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "success": true,
    "status_code": 200,
    "error": null,
    "data": {
        "message": "با موفقیت ثبت شد!",
        "order": {
            "id": 8470913,
            "type": 1,
            "each_price": "3717",
            "stop_price": "0",
            "trigger_price": "0",
            "amount": "1000",
            "available_amount": "1000",
            "done_value": "0",
            "done_percent": "0.00",
            "mean_value": 0,
            "commission": null,
            "total": "3717000",
            "created_at": "2023-10-17 12:13:21",
            "created_at_jalali": "1402/7/25 12:13:21",
            "base_coin": {
                "id": 20,
                "symbol": "DOGE",
                "name": "Dogecoin",
                "fa_name": "دوج کوین",
                "web_icon": "https://storage.bit24.exchange/exchange/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png",
                "app_icon": "https://storage.bit24.exchange/exchange/icons/c9718cb5-4651-45a1-850a-91000fc82b25.png"
            },
            "quote_coin": {
                "id": 496,
                "symbol": "IRT",
                "name": "Toman",
                "fa_name": "تومان",
                "web_icon": "https://storage.bit24.exchange/exchange/icons/irt1.png",
                "app_icon": "https://storage.bit24.exchange/exchange/icons/irt1.png"
            },
            "status": 0,
            "status_text": "در حال تکمیل",
            "category_type": "0",
            "category_type_text": "سفارش عادی",
            "conditions": "-",
            "triggered_category_type": null,
            "is_trade": 0
        }
    }
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 422,
    "error": {
        "message": "خطا در اعتبار سنجی ورودی ها",
        "errors": [
            {
                "reason": "base_coin_symbol",
                "message": "فیلد base coin symbol الزامی است."
            },
            {
                "reason": "quote_coin_symbol",
                "message": "فیلد quote coin symbol الزامی است."
            },
            {
                "reason": "market_id",
                "message": "فیلد آی دی مارکت الزامی است."
            },
            {
                "reason": "type",
                "message": "فیلد نوع معامله الزامی است."
            },
            {
                "reason": "category_type",
                "message": "فیلد نوع سفارش الزامی است."
            },
            {
                "reason": "price",
                "message": "فیلد قیمت واحد الزامی است، مگر آنکه نوع سفارش در 1 موجود باشد."
            },
            {
                "reason": "amount",
                "message": "فیلد مقدار الزامی است."
            }
        ]
    },
    "data": null
}

در صورت درخواست با ورودی نا مناسب، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 400,
    "error": {
        "message": "قیمت بخش لیمیت باید کمتر از قیمت فعلی بازار باشد.",
        "errors": null
    },
    "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false,
    "data": null,

}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false,
    "data": null,
}

برای ثبت سفارش از این آدرس استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
amount numeric الزامی یا اختیاری مقدار سفارش 1.5
base_coin_symbol string الزامی ارز پایه BTC
category_type numeric الزامی نوع سفارش 0
price numeric الزامی قیمت 1400000000
quote_coin_symbol string الزامی ارز متقابل IRT
quote_coin_amount string الزامی یا اختیاری قیمت ارز متقابل 500000
stop_price numeric الزامی یا اختیاری قیمت استا‍‍‍پ 100000
type numeric الزامی جهت سفارش 0
trigger_price numeric الزامی یا اختیاری قیمت شرط 110000
signature string الزامی امضا 48187874b431653147d59717150da82b6560fa3dee739fdb
پارامتر توضیحات مقادیر
amount در سفارشات خرید از نوع فوری نیاز به ارسال این فیلد نیست.
quote_coin_amount در سفارشات خرید از نوع فوری این فیلد الزامی است(بر اساس ارز متقابل).
type 0 = فروش , 1 = خرید
category_type 0 = عادی , 1 = فوری , 2 = حد سود و ضرر , 3 = OCO
stop_price در نوع سفارش حد سود و ضرر یا OCO الزامی است
trigger_price در نوع سفارش OCO الزامی است

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
id numeric شناسه سفارش
type numeric جهت سفارش(0 = فروش , 1 = خرید)
each_price string قیمت سفارش
stop_price string قیمت استا‍‍‍پ
trigger_price string قیمت شرط سفارش از نوع OCO
amount string مقدار سفارش
available_amount string مقدار باقی مانده سفارش
done_value string مقدار تکمیل شده سفارش
done_percent string درصد مقدار تکمیل شده سفارش
mean_value numeric میانگین قیمت خرید یا فروش
commission string مقدار کمیسیون کسر شده
total string مجموع قیمت سفارش
created_at dateTime تاریخ ثبت سفارش
created_at_jalali dateTime تاریخ شمسی ثبت سفارش
base_coin object اطلاعات ارز پایه
base_coin.id numeric شناسه ارز پایه
base_coin.symbol string نام ارز پایه
base_coin.name string نام ارز پایه
base_coin.fa_name string نام فارسی ارز پایه
base_coin.web_icon string لینک تصویر ارز پایه مخصوص وب سایت
base_coin.app_icon string لینک تصویر ارز پایه مخصوص اپلیکیشن
quote_coin object اطلاعات ارز متقابل
quote_coin.id numeric شناسه ارز متقابل
quote_coin.symbol string نام ارز متقابل
quote_coin.name string نام ارز متقابل
quote_coin.fa_name string نام فارسی ارز متقابل
quote_coin.web_icon string لینک تصویر ارز متقابل مخصوص وب سایت
quote_coin.app_icon string لینک تصویر ارز متقابل مخصوص اپلیکیشن
status numeric وضعیت سفارش(0 = در حال تکمیل, 1 = تکمیل شده, 2 = لغو شده)
status_text string متن وضعیت سفارش
category_type string نوع سفارش
category_type_text string متن نوع سفارش
triggered_category_type numeric مشخص کننده فعال سازی کدام شرط قیمت که در سفارشات از نوع OCO کاربرد دارد (0 = عادی , 2 =حد سود و ضرر)
conditions string شرط سفارش
is_trade numeric مشخص کننده سفارش(0 = سفارش باز , 1 = یعنی قسمتی از سفارش تکمیل شده و یک معامله است)

لغو سفارش

curl --location 'https://rest.bit24.cash/pro/capi/v1/orders/cancel' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186' \
--data-urlencode 'order_id=596472' \
--data-urlencode 'signature=eb5c373bb3f28434006566efc98bcb7067e5027b21a67bb284e8067100e2db7b'

POST https://rest.bit24.cash/pro/capi/v1/orders/cancel

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "success": true,
    "status_code": 200,
    "error": null,
    "data": {
        "message": "لغو سفارش/سفارشات با موفقیت انجام شد."
    }
}

در صورت درخواست با ورودی نا مناسب، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 400,
    "error": {
        "message": "سفارش/سفارشات قابل لغو یافت نشد!",
        "errors": null
    },
    "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false,
    "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false,
    "data": null
}

برای لغو سفارش از این آدرس استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
order_id numeric اختیاری شناسه سفارش 2221600

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
message string پیام

تاریخچه سفارشات

curl --location 'http://rest.bit24.cash/pro/capi/v1/orders/get-history?is_trade=0&market_id=19&type=1&category_type=1&from=2022-01-12&to=2023-01-12' \
--header 'Accept: application/json' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/pro/capi/v1/orders/get-history?is_trade=0&market_id=19&type=1&category_type=1&from=2022-01-12&to=2023-01-12

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "error": null,
  "data": {
    "message": "",
    "has_paginate": 1,
    "total_data": 362,
    "current_page": 1,
    "from": 1,
    "to": 15,
    "last_page": 25,
    "per_page": 15,
    "results": [
      {
        "id": 12172847,
        "type": 1,
        "each_price": "30000",
        "stop_price": "0",
        "trigger_price": "0",
        "amount": "20.0",
        "amount_coin_symbol": "USDT",
        "available_amount": "20.00000000",
        "done_value": "0.0",
        "done_percent": "0.00",
        "mean_value": "-",
        "commission": "0",
        "total": "600000",
        "total_coin_symbol": "IRT",
        "created_at": "2024-09-07 11:39:46",
        "created_at_jalali": "1403/6/17 11:39:46",
        "base_coin": {
          "id": 6,
          "symbol": "USDT",
          "name": "Tether",
          "fa_name": "تتر",
          "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png",
          "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png"
        },
        "quote_coin": {
          "id": 496,
          "symbol": "IRT",
          "name": "Toman",
          "fa_name": "تومان",
          "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
          "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png"
        },
        "commission_coin_symbol": "IRT",
        "status": 0,
        "status_text": "در حال تکمیل",
        "category_type": 0,
        "category_type_text": "عادی",
        "club_commission_discount_amount": "0.000000000000",
        "conditions": "-",
        "triggered_category_type": null,
        "is_trade": 0,
        "trailing_price_condition": "",
        "activation_price_condition": "",
        "delta": "% "
      },
      {
        "id": 12172846,
        "type": 1,
        "each_price": "30000",
        "stop_price": "0",
        "trigger_price": "0",
        "amount": "20.0",
        "amount_coin_symbol": "USDT",
        "available_amount": "20.00000000",
        "done_value": "0.0",
        "done_percent": "0.00",
        "mean_value": "-",
        "commission": "0",
        "total": "600000",
        "total_coin_symbol": "IRT",
        "created_at": "2024-09-07 11:39:31",
        "created_at_jalali": "1403/6/17 11:39:31",
        "base_coin": {
          "id": 6,
          "symbol": "USDT",
          "name": "Tether",
          "fa_name": "تتر",
          "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png",
          "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png"
        },
        "quote_coin": {
          "id": 496,
          "symbol": "IRT",
          "name": "Toman",
          "fa_name": "تومان",
          "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
          "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png"
        },
        "commission_coin_symbol": "IRT",
        "status": 0,
        "status_text": "در حال تکمیل",
        "category_type": 0,
        "category_type_text": "عادی",
        "club_commission_discount_amount": "0.000000000000",
        "conditions": "-",
        "triggered_category_type": null,
        "is_trade": 0,
        "trailing_price_condition": "",
        "activation_price_condition": "",
        "delta": "% "
      },
    ]
  }
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 422,
    "error": {
        "message": "خطا در اعتبار سنجی ورودی ها",
        "errors": [
            {
                "reason": "is_trade",
                "message": "فیلد is trade الزامی است."
            }
        ]
    },
    "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false,
    "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false,
    "data": null
}

برای گرفتن لیست سفارشات از این آدرس استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
market_id numeric اختیاری شناسه بازار 1
is_trade numeric الزامی نوع 1
type numeric اختیاری جهت سفارش 0
category_type numeric اختیاری نوع سفارش 0
from dateTime اختیاری از تاریخ 2022-02-20
to dateTime اختیاری تا تاریخ 2023-03-21
status numeric اختیاری فیلتر وضعیت سفارشات 1
limit dateTime اختیاری تا تاریخ 2023-03-21

nullable | dar surate naferestadane param, tamame sefareshat | 0 => sefareshate baz | 1 => takmil shode ha | 2 => lagv shode ha | 3 => partially excuted [lagv shode vali megdari azash fill shode]

پارامتر توضیحات مقادیر
type 0 = فروش , 1 = خرید
category_type 0 = عادی , 1 = فوری , 2 = حد سود و ضرر , 3 = OCO
status 0 = سفارشات باز , 1 = سفارشات تکمیل شده , سفارشات لغو شده
is_trade 0 = سفارش , 1 = معامله
limit در صورت نفرستادن، اطلاعات بصورت صفحه‌بندی شده نمایش داده میشود

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
has_paginate numeric مشخص کننده اینکه این پاسخ به صورت pagination ارسال شده است.
total_data numeric تعداد کلی اطلاعات
current_page numeric مشخص کننده صفه کنونی
from numeric آیتم اول صفحه کنونی
to numeric آیتم آخر صفحه کنونی
per_page numeric تعداد آیتم های هر صفحه
type numeric جهت سفارش (0 = فروش , 1 = خرید)
each_price string قیمت سفارش
stop_price string قیمت استا‍‍‍پ
trigger_price string قیمت شرط سفارش از نوع OCO
amount string مقدار سفارش
available_amount string مقدار باقی مانده سفارش
done_value string مقدار تکمیل شده سفارش
done_percent string درصد مقدار تکمیل شده سفارش
mean_value string میانگین قیمت خرید یا فروش
commission string مقدار کمیسیون کسر شده
total string مجموع قیمت سفارش
created_at dateTime تاریخ ثبت سفارش
created_at_jalali dateTime تاریخ شمسی ثبت سفارش
base_coin object اطلاعات ارز پایه
base_coin.id numeric شناسه ارز پایه
base_coin.symbol string نام ارز پایه
base_coin.name string نام ارز پایه
base_coin.fa_name string نام فارسی ارز پایه
base_coin.web_icon string لینک تصویر ارز پایه مخصوص وب سایت
base_coin.app_icon string لینک تصویر ارز پایه مخصوص اپلیکیشن
quote_coin object اطلاعات ارز متقابل
quote_coin.id numeric شناسه ارز متقابل
quote_coin.symbol string نام ارز متقابل
quote_coin.name string نام ارز متقابل
quote_coin.fa_name string نام فارسی ارز متقابل
quote_coin.web_icon string لینک تصویر ارز متقابل مخصوص وب سایت
quote_coin.app_icon string لینک تصویر ارز متقابل مخصوص اپلیکیشن
status numeric وضعیت سفارش(0 = در حال تکمیل, 1 = تکمیل شده, 2 = لغو شده)
status_text string متن وضعیت سفارش
category_type numeric نوع سفارش
category_type_text string متن نوع سفارش
triggered_category_type numeric مشخص کننده فعال سازی کدام شرط قیمت که در سفارشات از نوع OCO کاربرد دارد (0 = عادی , 2 =حد سود و ضرر)
conditions string شرط سفارش
is_trade numeric مشخص کننده سفارش یا معامله
total_coin_symbol string واحد مجموع ارزش سفارش
commission_coin_symbol string نماد ارز کارمزد سفارش
club_commission_discount_amount string مقدار تخفیف اعظا
trailing_price_condition string شروط سفارش از نوع trailing stop
delta string دلتا

لیست بازار ها

curl --location 'https://rest.bit24.cash/pro/capi/v1/markets?page=1' \
--header 'Accept: application/json' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/pro/capi/v1/markets?page=1

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
    "success": true,
    "status_code": 200,
    "error": null,
    "data": {
        "message": "",
        "has_paginate": 1,
        "total_data": 2,
        "current_page": 1,
        "from": 1,
        "to": 2,
        "last_page": 1,
        "per_page": 15,
        "results": [
            {
                "id": 1,
                "base_coin_id": 1,
                "base_coin_name": "bitcoin",
                "base_coin_fa_name": "بیت کوین",
                "base_coin_symbol": "BTC",
                "quote_coin_id": 496,
                "quote_coin_symbol": "IRT",
                "quote_coin_name": "Toman",
                "quote_coin_fa_name": "تومان",
                "each_price": "1461170400",
                "other_side_each_price": null,
                "quote_coin_volume": "1262012874",
                "base_coin_volume": "0.863700",
                "24h_change": "0.000",
                "24h_change_volume": "0",
                "total_min": "100000.00000000",
                "market_order_quote_coin_total_min": "100000",
                "market_order_base_coin_total_min": "0.000069",
                "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/ca4e6136-b7e0-407d-81d6-fdf21910cc53.png",
                "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/ca4e6136-b7e0-407d-81d6-fdf21910cc53.png",
                "quote_web_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
                "quote_app_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
                "is_active": 1,
                "first_order": "1461170400",
                "last_order": "1461170400",
                "min_price": "1461170400",
                "max_price": "1461170400",
                "base_coin_decimal": 6,
                "quote_coin_decimal": 0,
                "daily_chart_icon": "btcirt.png",
                "is_favorite": false
            },
            {
                "id": 85,
                "base_coin_id": 1,
                "base_coin_name": "bitcoin",
                "base_coin_fa_name": "بیت کوین",
                "base_coin_symbol": "BTC",
                "quote_coin_id": 6,
                "quote_coin_symbol": "USDT",
                "quote_coin_name": "Tether",
                "quote_coin_fa_name": "تتر",
                "each_price": "26690.400000",
                "other_side_each_price": null,
                "quote_coin_volume": "0",
                "base_coin_volume": "0.00000000",
                "24h_change": "0.000",
                "24h_change_volume": "0.000000",
                "total_min": "5.00000000",
                "market_order_quote_coin_total_min": "5.000000",
                "market_order_base_coin_total_min": "0.00018734",
                "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/ca4e6136-b7e0-407d-81d6-fdf21910cc53.png",
                "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/ca4e6136-b7e0-407d-81d6-fdf21910cc53.png",
                "quote_web_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png",
                "quote_app_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png",
                "is_active": 1,
                "first_order": "0.000000",
                "last_order": "0.000000",
                "min_price": "0.000000",
                "max_price": "0.000000",
                "base_coin_decimal": 8,
                "quote_coin_decimal": 6,
                "daily_chart_icon": "btcusdt.png",
                "is_favorite": false
            }
        ]
    }
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false,
    "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false,
    "data": null
}

برای دریافت لیست بازارها از این نوع درخواست استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
page numeric اختیاری صفحه 1

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
has_paginate numeric مشخص کننده اینکه این پاسخ به صورت pagination ارسال شده است.
total_data numeric تعداد کلی اطلاعات
current_page numeric مشخص کننده صفه کنونی
from numeric آیتم اول صفحه کنونی
to numeric آیتم آخر صفحه کنونی
per_page numeric تعداد آیتم های هر صفحه
id numeric شناسه بازار
base_coin_id numeric شناسه ارز پایه
base_coin_name string نام ارز پایه
base_coin_fa_name string نام فارسی ارز پایه
base_coin_symbol string نماد ارز پایه
quote_coin_id numeric شناسه ارز متقابل
quote_coin_name string نام ارز متقابل
quote_coin_fa_name string نام فارسی ارز متقابل
quote_coin_symbol string نماد ارز متقابل
each_price string قیمت بازار
other_side_each_price string قیمت بازار مقابل
quote_coin_volume string حجم ارز متقابل 24 ساعت اخیر
base_coin_volume string حجم ارز پایه 24 ساعت اخیر
24h_change string درصد تغیر 24 ساعت اخیر
24h_change_volume string حجم تغییرات 24 ساعت اخیر
total_min string حداقل مقدار خرید نسبت به ارز متقابل
market_order_quote_coin_total_min string حداقل مقدار خرید نسبت به ارز متقابل در نوع سفارش فوری
market_order_base_coin_total_min string حداقل مقدار خرید نسبت به ارز پایه در نوع سفارش فوری
web_icon string آیکون ارز پایه در وبسایت
app_icon string آیکون ارز پایه در اپلیکیشن
quote_web_icon string آیکون ارز متقابل در وبسایت
quote_app_icon string آیکون ارز متقابل در موبایل
is_active numeric وضعیت بازار(0= غیرفعال , 1 = فعال)
first_order string اولین سفارش در 24 سعت اخیر
last_order string اخرین سفارش در 24 اخیر
min_price string کمترین قیمت سفارش در 24 ساعت اخیر
max_price string بیشترین قیمت سفارش در 24 ساعت اخیر
base_coin_decimal numeric تعداد ارقام مجاز بعد از اعشار ارز پایه
quote_coin_decimal numeric تعداد ارقام مجاز بعد از اعشار ارز متقابل
daily_chart_icon string تصویر نمودار تغییرات بازار در 24 ساعت اخیر
is_favorite bool بازار مورد علاقه(false = نه, true = بله)

لیست سفارشات

curl --location 'https://rest.bit24.cash/pro/capi/v1/markets/order-books?base_coin=btc&quote_coin=irt' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/pro/capi/v1/markets/order-books?base_coin=btc&quote_coin=irt

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "error": null,
  "data": {
    "message": "",
    "buy_orders": [
      {
        "price": "4898935251",
        "amount": "0.0059945",
        "total": "29366667"
      },
      {
        "price": "4898367514",
        "amount": "0.0080305",
        "total": "39336340"
      },
      {
        "price": "4897602814",
        "amount": "0.0088322",
        "total": "43256607"
      },
      {
        "price": "4897044272",
        "amount": "0.0062396",
        "total": "30555597"
      },
      {
        "price": "4029956745",
        "amount": "0.0010382",
        "total": "4183901"
      },
      {
        "price": "3836470733",
        "amount": "0.0006301",
        "total": "2417360"
      },
      {
        "price": "3733212163",
        "amount": "0.0006496",
        "total": "2425094"
      },
      {
        "price": "2865905624",
        "amount": "0.0016780",
        "total": "4808989"
      },
      {
        "price": "2655686408",
        "amount": "0.0003347",
        "total": "888858"
      }
    ],
    "sell_orders": [
      {
        "price": "5004968904",
        "amount": "0.0080239",
        "total": "40159369"
      },
      {
        "price": "5031015489",
        "amount": "0.0033703",
        "total": "16956031"
      },
      {
        "price": "5055950327",
        "amount": "0.0044560",
        "total": "22529314"
      },
      {
        "price": "5081155292",
        "amount": "0.0092604",
        "total": "47053530"
      },
      {
        "price": "5110170825",
        "amount": "0.0009728",
        "total": "4971174"
      },
      {
        "price": "5122864234",
        "amount": "0.0033345",
        "total": "17082190"
      },
      {
        "price": "5152861370",
        "amount": "0.0026363",
        "total": "13584488"
      },
      {
        "price": "5183444923",
        "amount": "0.0088573",
        "total": "45911326"
      },
      {
        "price": "5213101526",
        "amount": "0.0032109",
        "total": "16738747"
      },
      {
        "price": "5236754851",
        "amount": "0.0072605",
        "total": "38021458"
      },
      {
        "price": "5268258634",
        "amount": "0.0007279",
        "total": "3834765"
      }
    ]
  }
}

در صورت تناقض ورودی، پاسخ به این صورت خواهد بود:

{
  "success": false,
  "status_code": 422,
  "error": {
    "code": null,
    "message": "خطا در اعتبار سنجی ورودی ها",
    "errors": [
      {
        "reason": "base_coin",
        "message": "فیلد کوین پایه الزامی است."
      },
      {
        "reason": "quote_coin",
        "message": "فیلد کوین قیمت گذار الزامی است."
      }
    ]
  },
  "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
  "data": null,
  "error": {
    "errors": null,
    "message": "عدم احراز"
  },
  "status_code": 401,
  "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
  "success": false,
  "status_code": 404,
  "error": {
    "code": null,
    "message": "آدرس یا آیتم درخواستی شما در سیستم یافت نشد",
    "errors": null
  },
  "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 500,
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "data": null
}

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
base_coin string الزامی ارز BTC
quote_coin string الزامی ارز USDT

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
message string در صورت وجود پیغام پر خواهد بود
id numeric شناسه جفت ارز
market_symbol string نماد جفت ارزی
buy_orders array سفارشات خرید
buy_orders.market_id numeric شناسه جفت ارز
buy_orders.each_price string قیمت ارز
buy_orders.available_amount string مقدار
sell_orders array سفارشات فروش
sell_orders.market_id numeric شناسه جفت ارز
sell_orders.each_price string قیمت ارز
sell_orders.available_amount string مقدار

جزئیات سفارش

curl --location 'https://rest.bit24.cash/pro/capi/v1/orders?id=36052525' \
--header 'Accept: application/json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/pro/capi/v1/orders?id=36052525

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "error": null,
  "data": {
    "message": "",
    "order": {
      "id": 36052525,
      "type": 1,
      "each_price": "51634",
      "stop_price": "0",
      "trigger_price": "0",
      "amount": "10.00",
      "amount_coin_symbol": "USDT",
      "available_amount": "0",
      "done_value": "10.00",
      "done_percent": "100.00",
      "mean_value": "51634.0000000000000000",
      "commission": "361.438",
      "total": "516340",
      "total_coin_symbol": "IRT",
      "created_at": "2024-09-18 14:46:28",
      "created_at_jalali": "1403/6/28 14:46:28",
      "base_coin": {
        "id": 6,
        "symbol": "USDT",
        "name": "Tether",
        "fa_name": "تتر",
        "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png",
        "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/596ac4ed-3c63-45cf-9f30-c28646ec0532.png"
      },
      "quote_coin": {
        "id": 496,
        "symbol": "IRT",
        "name": "Toman",
        "fa_name": "تومان",
        "web_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png",
        "app_icon": "https://storage.bit24.exchange/exchange-stage/icons/irt1.png"
      },
      "commission_coin_symbol": "IRT",
      "status": 1,
      "status_text": "تکمیل شده",
      "category_type": 0,
      "category_type_text": "عادی",
      "club_commission_discount_amount": "154.902000000000",
      "conditions": "-",
      "triggered_category_type": null,
      "is_trade": 0,
      "trailing_price_condition": "",
      "activation_price_condition": "",
      "delta": "% "
    }
  }
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
  "data": null,
  "error": {
    "errors": null,
    "message": "عدم احراز"
  },
  "status_code": 401,
  "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 404,
    "error": {
        "message": "آدرس یا آیتم درخواستی شما در سیستم یافت نشد",
        "errors": null
    },
    "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "success": false,
    "status_code": 500,
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "data": null
}

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
id numeric الزامی آیدی سفارش 36052525

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
id int شناسه سفارش
type int جهت سفارش
0 => فروش
1 => خرید
each_price string قیمت
stop_price string شرط قیمت که در سفارشات نوع
حد سود و ضرر و OCO و حد ضرر با قیمت بازار کاربرد دارد.
trigger_price string شرط قیمت که در سفارشات نوع OCO و حد ضرر متحرک کاربر دارد.
amount string مقدار سفارش است.
amount_coin_symbol string واحد مقدار سفارش است(base coin یا quote coin)
available_amount string مقداری از سفارش است که تکمیل نشده است.
done_value string مقداری از سفارش است که تکمیل شده است.
done_percent string مشخص کننده درصد تکمیل شده از سفارش است.
mean_value string قیمت میانگین خریداری شده یا فروخته شده نسبت به حجم سفارش را مشخص می کند.
commission string مقدار کارمزد سفارش بر اساس quote coin را مشخص می کند.
total string قیمت کل سفارش
total_coin_symbol string واحد قیمت کل سفارش (base coin یا quote coin)
created_at string تاریخ و زمان ثبت سفارش
created_at_jalali string تاریخ و زمان شمسی ثبت سفارش
base_coin object ارز پایه
base_coin.id int شناسه ارز
base_coin.symbol string نماد ارز
base_coin.name string نام ارز
base_coin.fa_name string نام فارسی ارز
base_coin.web_icon string آیکون مخصوص وب
base_coin.app_icon string آیکون مخصوص app
quote_coin object ارز ارزش گذار
quote_coin.id int شناسه ارز
quote_coin.symbol string نماد ارز
quote_coin.name string نام ارز
quote_coin.fa_name string نام فارسی ارز
quote_coin.web_icon string آیکون مخصوص وب
quote_coin.app_icon string آیکون مخصوص app
commission_coin_symbol string واحد مقدار کارمزد سفارش(base coin یا quote coin)
status int وضعیت سفارش
0 => در حال تکمیل
1 => تکمیل شده
2 => لغو شده
5 => در انتظار شرط قیمت
6 => در انتظار شرط فعال سازی
status_text string متن وضعیت سفارش
category_type int نوع سفارش
0 => عادی
1 => فوری
2 => حد سود و ضرر
3 => OCO
4 => حد ضرر با قیمت بازار
5 => حد ضرر متحرک
category_type_text string متن نوع سفارش
club_commission_discount_amount string مقدار تخفیف سفارش از بابت تخفیف کلاب
conditions string مشخص کننده شروط سفارش
triggered_category_type string در بعضی از نوع های سفارش مانند OCO سفارش، چندین شرط وجود دارد که این فیلد مشخص کننده این است کدام شرط برقرار شده است.
is_trade int مشخص کننده سفارش یا معامله.
0 => سفارش
1 => معامله
trailing_price_condition string مشخص کننده شرط قیمت در سفارشات نوع حد ضرر متحرک است.
activation_price_condition string مشخص کننده شرط فعالسازی در سفارشات نوع حد ضرر متحرک است.
delta string مشخص کننده دلتا در سفارشات نوع حد ضرر متحرک است.

اطلاعات OHLC-V

curl --location 'http://rest.bit24.cash/pro/capi/v1/markets/ohclv?from_ts=1727770855&to_ts=1727778055&base_coin_symbol=USDT&quote_coin_symbol=IRT&resolution=1m' \
--header 'Accept: application/json' \
--header 'X-BIT24-APIKEY: *******DDF**78*************186'

GET https://rest.bit24.cash/pro/capi/v1/markets/ohclv?from_ts=1727770855&to_ts=1727778055&base_coin_symbol=USDT&quote_coin_symbol=IRT&resolution=1m

در صورت فراخوانی درست، پاسخ به این صورت خواهد بود:

{
  "success": true,
  "status_code": 200,
  "error": null,
  "data": {
    "message": "",
    "ohclv": [
      {
        "t": 1723099860,
        "tb": "2024-08-08 06:51:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.00002415
      },
      {
        "t": 1723099800,
        "tb": "2024-08-08 06:50:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.0000092
      },
      {
        "t": 1723099680,
        "tb": "2024-08-08 06:48:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.00000889
      },
      {
        "t": 1723099620,
        "tb": "2024-08-08 06:47:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.00002121
      },
      {
        "t": 1723099560,
        "tb": "2024-08-08 06:46:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.00001299
      },
      {
        "t": 1723099500,
        "tb": "2024-08-08 06:45:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.00000644
      },
      {
        "t": 1723099440,
        "tb": "2024-08-08 06:44:00",
        "o": 57142,
        "c": 57142,
        "h": 57142,
        "l": 57142,
        "v": 0.0000098
      },
      {
        "t": 1723099320,
        "tb": "2024-08-08 06:42:00",
        "o": 57086.7,
        "c": 57086.7,
        "h": 57086.7,
        "l": 57086.7,
        "v": 0.00001307
      },
      {
        "t": 1723099260,
        "tb": "2024-08-08 06:41:00",
        "o": 57086.7,
        "c": 57086.7,
        "h": 57086.7,
        "l": 57086.7,
        "v": 0.00002128
      }
    ]
  }
}

در صورت عدم وجود اطلاعات، پاسخ به این صورت خواهد بود:

{
  "success": false,
  "status_code": 404,
  "error": {
    "message": "بازار معادلی برای ارز های درخواستی موجود نیست!",
    "errors": null
  },
  "data": null
}

در صورت تناقض توکن، پاسخ به این صورت خواهد بود:

{
    "data": null,
    "error": {
        "message": "عدم احراز",
        "errors": null
    },
    "status_code": 401,
    "success": false
}

در صورت فراخوانی نادرست آدرس، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "صفحه مورد نظر یافت نشد",
        "errors": null
    },
    "status_code": 404,
    "success": false,
    "data": null
}

در صورت وجود خطا درون سرور، پاسخ به این صورت خواهد بود:

{
    "error": {
        "message": "خطایی در سرور رخ داده است.",
        "errors": null
    },
    "status_code": 500,
    "success": false,
    "data": null
}

برای گرفتن اطلاعات OHLC-V از این آدرس استفاده نمایید:

پارامترهای ورودی

پارامتر نوع پیش‌فرض توضیحات نمونه
from_ts numeric الزامی نقطه شروع بازه زمانی در فرمت time stamp ده رقمی 1727770855
to_ts numeric الزامی نقطه پایان بازه زمانی در فرمت time stamp ده رقمی 1727778055
base_coin_symbol string الزامی سنبل پایه بازار هدف USDT
quote_coin_symbol string الزامی سنبل ارزش گزار بازار هدف IRTT
resolution string اختیاری رزولوشن 1m

پارامترهای پاسخ(data)

پارامتر نوع توضیحات
t numeric تایم استمپ کندل
tb string دیت تایم کندل
o numeric قیمت بازار هنگام باز شدن کندل
c numeric قیمت بازار هنگام بسته شدن کندل
h numeric بیشترین قیمت کندل
i numeric کمترین قیمت کندل
v numeric حجم کندل

مفاهیم HTTP CODE

کد HTTP عنوان توضیحات ‌
200 OK درخواست دریافت و پاسخ داده شده .
422 Unprocessable Entity پارامتر ارسالی نادرست است یا ارسال نشده است.
400 Bad Request سرور قادر به پردازش دیتای ورودی نیست.
401 عدم احراز کاربر احراز هویت نشده است
404 صفحه مورد نظر یافت نشد آدرس یا شی مد نظر وجود ندارد
500 Internal Server Error مشکلی به صورت موقت در سرور رخ داده است
shell plaintext