مستندات دسترسی به API عمومی

پلتفرم ما وب سرویس ها (API) خودش رو در اختیار شما میذاره که اگه برنامه نویس و یا یه کاربر حرفه ای هستید میتونید به راحتی از اونا استفاده کنید . این بخش دسترسی به API های عمومی به صورت کامل به شما توضیح میدیم . برای استفاده از این وب سرویس نیازی نیست شما حتما عضو پلتفرم ما باشید . همچنین شما میتونید با استفاده از این وب سرویس به صورت ویجیت توی وب سایت خودتون اطلاعاتی رو به نمایش بزارید .

 

برای اتصال به API عمومی شما با استفاده از پروتکل HTTPS از طریق اتصال به End point وب سرویس میتونید ارتباط برقرار کنید . آدرس Endpoint ما برای اتصال :

https://visapay.io/api/public

 

returnTicker

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

شما حتی برای استفاده از این تابع میتونید اون رو به صورت URL از طریق End point استفاده کنید . به این موضوع دقت کنید که End Point وب سرویس ما به صورت پویا هست . در اینجا End point میشه :

https://visapay.io/api/public?command=returnTicker

توضیحات فیلد
با این فیلد شما قیمت آخرین معامله جفت رمز ارز معاملاتی رو میگیرید last
درصد تغییر قیمت change
نمایش بالاترین قیمت جفت رمز ارز معملاتی مورد نظر high24hr
نمایش پایین ترین قیمت جفت رمز ارز معاملاتی مورد نظر low24hr
نمایش تعداد معامله رمز ارز پایه برای جفت معاملاتی رمز ارز baseVolume
نمایش حجم معاملاتی tradeVolume
 
نمونه کدهای خروجی:
    {
        "BTC_USDT": {
            "last": "57860.23000000",
            "low24hr": "54374.00000000",
            "high24hr": "58453.45000000",
            "change": "2.99",
            "tradeVolume": "614.35457681",
            "baseVolume": "3465574.16778521"
        },
        "DOGE_USDT": {
            "last": "0.054800000",
            "low24hr": "0.051800000",
            "high24hr": "0.061100000",
            "change": "17.95",
            "tradeVolume": "345781.23450",
            "baseVolume": "18948.8116506"
        }
    }

 

 

ارائه خلاصه اطلاعات برای یک جفت رمرز ارز معاملاتی روی پلتفرم

 

توضیحات پارامتر درخواستی
BTC_USDT جفت رمز ارز معاملاتی

 

آدرس Endpoint ما برای اتصال :

https:/visapay.io/api/public?command=returnTicker&tradePair=BTC_USDT

 
مثال خروجی :
    {
        "last": "57860.23000000",
            "low24hr": "54374.00000000",
            "high24hr": "58453.45000000",
            "change": "2.99",
            "tradeVolume": "614.35457681",
            "baseVolume": "3465574.16778521"
    }

 

returnOrderBook

با استفاده از این تابع و End point شما میتونید آخرین ۵۰ سفارش ثبت شده در پلتفرم رو برای یه جفت معاملاتی رمز ارز خاص دریافت کنید . توجه داشته باشید که این استفاده از این تابع محدودیتی برای انتخاب جفت های معاملاتی نداره ولی در کل برای هر جفت رمز ارز معاملاتی فقط ۵۰ تا سفارش آخر رو نشون میده.

آدرس End point وب سرویس برای فراخوانی اطلاعات :

https:/visapay.io/api/public?command=returnTicker&tradePair=BTC_USDT

 

 
فیلد های ورودی :
BTC_USDT جفت رمز ارز معاملاتی
 
نمونه کد های خروجی :
Field Description
نمایش سفارشات خرید که از کمترین به پیشترین قیمت لیست شده. asks
نمایش سفارشات خرید که از بیشترین به کمترین قیمت قیست شده. bids
 
مثال خروجی :
    {
      "asks": [
        {
          "price": "0.08880000",
          "amount": "900.00000000",
          "total": "79.92000000"
        },
        {
          "price": "0.15100000",
          "amount": "3570.00000000",
          "total": "539.07000000"
        }
        ...
      ],
      "bids": [
        {
          "price": "0.14200000",
          "amount": "984.00000000",
          "total": "139.72800000"
        },
        {
          "price": "0.08910000",
          "amount": "798.00000000",
          "total": "71.10180000"
        }
        ...
      ]
    }

 

returnTradeHistory

شما با استفاده از این پارامتر شما میتونید آخرین ۱۰۰ ترید برای یه جفت رمز ارز معاملاتی رو بگیرید . توی این تابع شما میتونید با استفاده از UNIX timestamps یه رنج رو مشخص کنید . برای مشخص کردن این رنج شما میتونید از “start” و “end” با استفاده از متد GET تنظیمات خودتون رو پیاده کنید .

آدرس End point وب سرویس برای فراخوانی اطلاعات :

https://visapay.io/api/public?command=returnTradeHistory&tradePair=BTC_USD

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

https://visapay.io/api/public?command=returnTradeHistory&tradePair=BTC_USD&start=1593519220&end=1593578220

 

 
فیلد های ورودی :
توضیحات پارامتر درخواستی
یکی از جفت رمز ارزهای معاملاتی مثال : ETH_IRT جفت رمز ارز معاملاتی
استفاده از start در صورت استفاده از UNIX timestamps start (اختیاری)
استفاده از end در صورت استفاده از UNIX timestamps end (اختیاری)
 
فیلد های خروجی :
توضیحات فیلد
تاریخ انجام معاملات بر اساس تایم استاندارد جهانی به وقت تهران GMT +3:30 date
نمایش نوع معامله که خرید یا فروش بوده type
قیمت رمز ارز بر اساس رمز ارز پایه معاملاتی price
تعداد واحد رمز ارز که در این تراکنش معاملاتی بر روی پلتفرم منتقل شده amount
نمایش ارز کل معامله بر اساس رمز ارز پایه معاملاتی total
 
مثال خروجی :
    [
      {
        "price": "57480.24000000",
        "amount": "0.7567207",
        "total": "43496.48744896",
        "type": "buy",
        "date": "2021-02-22 20:17:54"
      },
      {
        "price": "57280.24000000",
        "amount": "0.25436791",
        "total": "14570.2549331",
        "type": "sell",
        "date": "2021-02-22 20:17:54"
      },
      ...
    ]

 

returnChartData

با استفاده از این تابع روی خروجی وب سرویس میتونید اطلاعات نمودار کندل استیک رو به صورت کامل دریافت کنید . شما میتونید از پارامتر هایی مثل جفت رمز ارز های معاملاتی و بازه زمانی توی نمودار کندل استیک با واحد ثانیه استفاده کنید . مقادیر مورد قبول وب سرویس ۳۰۰ - ۹۰۰ - ۱۸۰۰ - ۷۲۰۰ - ۱۴۴۰۰ و ۸۶۴۰۰ هست . همچنین میتونید از تابع زمانی با فرمت UNIX timestamp با مقادیر start و end هم استفاده کنید .

آدرس End point وب سرویس به همراه کلیه پارامترها برای فراخوانی اطلاعات :

https://visapay.io/api/public?command=returnChartData&tradePair=ETH_IRT&interval=14400&start=1637300100&end=1637678900

 
فیلد های ورودی :
توضیحات پارامترهای درخواستی
جفت رمز ارز معاملاتی مورد نظر شما مثل: ETH_USDT یا هر جفت رمز ارز معاملاتی. tradePair
بازه زمانی مورد درخواست شما از نموار کندل استیک . مقادیر قابل قبول : ۳۰۰ - ۹۰۰ - ۱۸۰۰ - ۷۲۰۰ - ۱۴۴۰۰ و ۸۶۴۰۰ هستند. interval
شروع بازه زمانی بر اساس استاندارد UNIX timestamp start
پایان بازه زمانی بر اساس استاندارد UNIX timestamp end
 
فیلد های خروجی :
توضیحات فیلد
زمان بر اساس تایم استاندارد جهانی به وقت تهران GMT +3:30 برای کندل درخواستی در واحد میلیونیم ثانیه با استاندارد زمانی UNIX date
بالاترین قیمت رمز ارز معاملاتی در نموار کندل استیک. high
پایین ترین قیمت رمز ارز معاملاتی در نمودار کندل استیک. low
شروع قیمت رمز ارز معاملاتی در مدت زمان درخواستی بر اساس نمودار کندل استیک open
آخرین قیمت رمز ارز معاملاتی در مدت زمان درخواستی بر اساس نمودار کندل استیک close
حجم معاملات رمز ارز معاملاتی در مدت زمان درخواستی بر اساس نمودار کندل استیک volume
 
مثال خروجی :
    [
      {
        "date": 1613943758,
        "low": "1931.32984517",
        "high": "1935.70000000",
        "volume": "4.41510971",
        "open": "1931.32984517",
        "close": "1935.70000000"
      },
      {
        "date": 1613947238,
        "low": "1921.74279043",
        "high": "1933.96452109",
        "volume": "1.52801267",
        "open": "1933.96452109",
        "close": "1921.74279043"
      },
      ...
    ]