لیست ‌ای پی آی‌ها

مستندات API رمزینکس

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

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

شما با استفاده از ای پی آی های رمزینکس قوانین و شرایط موجود در سایت رمزینکس را پذیرفته‌اید.

ساخت کلید API

برای آشنایی با نحوه ساخت کلید ای پی آی اینجا کلیک کنید.

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

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

‫برای دسترسی به این ای پی آی‌ها نیاز به ارسال HTTP Headerها و ارسال کلید خصوصی و توکن خصوصی به صورت زیر است:

Authorization2: Bearer Your-Token

x-api-key: YOUR_API_KEY

برای شروع به کار لطفا به بخش احراز هویت مراجعه کنید.

اطلاعات بازار (عمومی)

اطلاعات عمومی بازار

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

Get لیست سفارش‌ها: اردربوک

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/2/buys_sells' \
--header 'Content-Type: application/json'
   Body
{
  "status": 0,
  "data": {
    "buys": [
      [
        9320000000,
        0.00369,
        34390800,
        false,
        null,
        1,
        315682508
      ],
    ]
  }
}
   Header
Date: Tue, 17 May 2022 10:55:03 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=RfaJDj7Rge0HsBAAMIRmNW2FNEoZJF5%2Fq9nF5a3jFRF%2B2QKHLF878vtmnLhro9%2F0mcdqlLTok3jn%2FyntRGx7wz8PomaZatvPg6CoC4LVMbcYoVu6WQiSpr6Eh6Br87AZm4njKUCbm5s%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cbd18c6eb4976f-AMS
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/{{pair_id}}/buys_sells

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

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

Example

https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/2/buys_sells

Path Variable:

پارامتر نوع اجباری توضیحات
pair_id int بله
  • آیدی بازار می‌باشد و مقدار آن عدد است
  • نیاز به ارسال توکن ندارد
  • محدودیت فراخوانی ندارد

Get لیست معاملات

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/2/trades' \
--header 'Content-Type: application/json'
   Body
{
  "status": 0,
  "data": [
    [
      9353000000,
      0.0008,
      "2022-05-17 11:30:11",
      "buy",
      1652787011,
      "fd99e7e5898b87473bfd3ce549107d45"
    ]
  ]
}
   Header
Date: Tue, 17 May 2022 11:30:47 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=6oS%2BBmnsRNElnXq9ZRxasnjFyj1AeWhSCc%2B3o9EzA0gmZIYoemHcgm1d3jmbBZfNpO1XI23RckXHxjMCzmLvjQ18g081sK4xd6ortm2aebo7ircAnX6k6dI5WjrF6q1NG3wz82RBpwY%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cc05e64e59972e-AMS
Content-Encoding: br

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

Example

https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/2/trades

Path Variable:

پارامتر نوع اجباری توضیحات
pair_id int بله
  • آیدی بازار می‌باشد و مقدار آن عدد است
  • نیاز به ارسال توکن ندارد
  • محدودیت درخواست ندارد

GET ارزهای رمزینکس

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/currencies'
   Body
{
  "status": 0,
  "data": [
    {
      "name": "bitcoin",
      "persian_name": "بیت کوین",
      "show_precision": 5,
      "id": 1,
      "symbol": "btc",
      "has_tag": false,
      "international_price": null,
      "withdraw_fee": 0.0005,
      "icon": "/exchange/img/coins/btc.png",
      "show_order": 2000,
      "color": "FFD700",
      "factor": 1,
      "url_name": "bitcoin-btc",
      "related_pairs": [
        12,
        2
      ],
      "rial_related_pair": 2,
      "withdraw": 1,
      "deposit": 1
    },
  ]
}
   Header
Date: Tue, 17 May 2022 11:45:57 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=%2FoHZTAAE93ZSrAj0SeeAh%2BZxpu1d2sk8qR%2FfrSqcskovpLn%2Fu9Blz9vkQySIYcaHJYhMriBiGp47uruYABvOuzpScRt22Jw3vQI6kFBoA3PMfzWUf5eshhePHuuOyJi1kD80Z8zkhvE%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cc1c17daa65989-AMS
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/currencies

مشخصات ارزهای رمزینکس

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

GET مشخصات یک ارز مشخص

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/currencies/2'
   Body
{
  "status": 0,
  "data": {
    "name": "rial",
    "persian_name": "ریال",
    "show_precision": 0,
    "id": 2,
    "symbol": "irr",
    "has_tag": false,
    "international_price": null,
    "withdraw_fee": 45000,
    "icon": "/exchange/img/coins/irr.png",
    "show_order": 1000,
    "color": "1E90FF",
    "factor": 1,
    "url_name": null,
    "related_pairs": [],
    "rial_related_pair": null,
    "withdraw": 1,
    "deposit": 1
  }
}
   Header
Date: Tue, 17 May 2022 11:52:30 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=Qt9Pa%2BMUSakjKjCNIdTA0rgzHPtMIA7NZge73E6okqnniGVQnajMd1n5WftfFqH6CE6o3wRXTfLpof4Pt3OiSVLhHxcLQrt3zt9rd2YoWNDjB4q3NkN4XNNgFzZx9I95hNhmUsvXNkM%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cc25b6fafa9060-FRA
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/currencies/{{currency_id}}

مشخصات یک ارز مشخص

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

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله
  • آیدی ارز و مقدار عددی است
  • نیاز به ارسال توکن ندارد
  • محدودیت فراخوانی ندارد

GET بازارهای رمزینکس

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/pairs'
   Body
{
  "status": 0,
  "data": [
    {
      "sell": 9306235000,
      "buy": 9295000000,
      "pair_id": 2,
      "name": {
        "fa": "بیت کوین",
        "en": "bitcoin/rial"
      },
      "icon": "/exchange/img/coins/btc.png",
      "web_link": "https://ramzinex.com/exchange/orderbook/2",
      "base_precision": 5,
      "quote_precision": 0,
      "base_currency_id": 1,
      "base_currency_symbol": {
        "en": "btc",
        "fa": "بیت کوین"
      },
      "quote_currency_id": 2,
      "quote_currency_symbol": {
        "en": "irr",
        "fa": "ریال"
      },
      "financial": {
        "last24h": {
          "open": 9274019925,
          "close": 9306235000,
          "highest": 9418999966,
          "lowest": 9103710000,
          "quote_volume": 3631913934,
          "base_volume": 1.18,
          "change_percent": 0.35
        }
      },
      "price_step": 9306235,
      "amount_step": 0.0001,
      "tv_symbol": {
        "ramzinex": "btcirr",
        "international": "BINANCE:BTCUSDT"
      },
      "show_order": 50,
      "url_name": null
    }
  ]
}
   Header
Date: Tue, 17 May 2022 12:47:06 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=gRXKyII50A54v3wuVIeQPKLOPYZSV00phVatDAYFCrpMe5df6NGbOTbN5BlyqSVkIAP0uQU3R72CgRnGFl9I665n6jPEEG8XXCyE0H8R1KrT847huGxZ%2FPF4s5oS2lRZ8uPWMjjZZws%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cc75b0eb155b2c-FRA
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/pairs

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

وضعیت همه‌ی بازارها

GET مشخصات یک بازار مشخص

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/pairs/2'
   Body
{
  "status": 0,
  "data": {
    "sell": 7399999896,
    "buy": 7370363000,
    "pair_id": 2,
    "name": {
      "fa": "بیت کوین",
      "en": "bitcoin/rial"
    },
    "icon": "/exchange/img/coins/btc.png",
    "web_link": "https://ramzinex.com/exchange/orderbook/2",
    "base_precision": 5,
    "quote_precision": 0,
    "base_currency_id": 1,
    "base_currency_symbol": {
      "en": "btc",
      "fa": "بیت کوین"
    },
    "quote_currency_id": 2,
    "quote_currency_symbol": {
      "en": "irr",
      "fa": "ریال"
    },
    "financial": {
      "last24h": {
        "open": 7503842600,
        "close": 7379363969,
        "highest": 7697651549,
        "lowest": 7350000000,
        "quote_volume": 4620162081,
        "base_volume": 1.86,
        "change_percent": -1.66
      }
    },
    "price_step": 7399999,
    "amount_step": 0.00013,
    "tv_symbol": {
      "ramzinex": "btcirr",
      "international": "BINANCE:BTCUSDT"
    },
    "show_order": 50,
    "url_name": "bitcoin-btc",
    "crypto_box": 0,
    "price_precision": null
  }
}
   Header
Date: Sat, 23 Jul 2022 10:09:47 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=N4PqXq3lrVdq%2FgwJ6LHvLZ3n%2B9iLLo64p1T5tobm7SeqDYZSuNqnCzGO8pPWc%2BQrWzfPbAzc2ZVQLvEzALAYTj7Vc%2FpI%2BPCJIgnrC4TEV91u5DI81%2BmmDEOeqrFecv1wqQKLShnQk4Y%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 72f39f613b749296-FRA
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/pairs/{{pair_id}}

مشخصات یک بازار مشخص

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

Example

https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/pairs/2

پارامتر نوع اجباری توضیحات
pair_id int بله
  • آیدی ارز و مقدار عددی است
  • نیاز به ارسال توکن ندارد
  • محدودیت فراخوانی ندارد

GET قیمت خرید و فروش مربوط به بازارها

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/prices'
   Body

{
  "status": 0,
  "data": {
    "btcirr": {
      "sell": 9353000000,
      "buy": 9310000000,
      "pair_id": 2,
      "name": {
        "fa": "بیت کوین",
             "en": "bitcoin/rial"
      },
      "icon": "/exchange/img/coins/btc.png",
      "web_link": "https://ramzinex.com/exchange/orderbook/2",
      "base_precision": 5,
      "quote_precision": 0,
      "base_currency_id": 1,
      "base_currency_symbol": {
        "en": "btc",
        "fa": "بیت کوین"
      },
      "quote_currency_id": 2,
      "quote_currency_symbol": {
        "en": "irr",
        "fa": "ریال"
      },
      "financial": {
        "last24h": {
          "open": 9274019942,
          "close": 9280001000,
          "highest": 9418999966,
          "lowest": 9103710000,
          "quote_volume": 3797433268,
          "base_volume": 1.24,
          "change_percent": 0.06
        }
      },
      "price_step": 9353000,
      "amount_step": 0.0001,
      "tv_symbol": {
        "ramzinex": "btcirr",
        "international": "BINANCE:BTCUSDT"
      },
      "show_order": 50,
      "url_name": null
    }
  }
}
   Header
Date: Tue, 17 May 2022 13:38:07 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=V0wZy8GPByTEto2sSA%2FIaTKLk2tYWgZvQvSl%2BI9lKwVovaJqm13WhEjkEGpyBKGy%2Fkt7K0eBAwUFvQOEsMmfm%2F4eesFAcL4z5qEjWzpe3OR%2FQSLjgEsFvKH%2BBWwk6r9%2FNUidN4DVkEI%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70ccc06e48789b69-FRA
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/prices

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

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

GET قیمت تمام شده خرید یک ارز

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/2/market_buy_price'
   Body
{
  "status": 0,
  "data": {
    "price": 9353000000,
    "max_price": 9353000000
  }
}
   Header
Date: Tue, 17 May 2022 13:55:49 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=7CvLDYlrZjBatdRev6kAnUlSSMjO5UwXCMCY4eQN6nzPDd8dnWX0Pm5Eze4uKnuB84yUkCditsVLT3PTiB95CmKFlgaTwOavwDzZD8M5Ae%2FoVlmYCU4DAZQxMxodTXQsNh7BY4iIN0s%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70ccda5c9d9a8ffa-FRA
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/{{pair_id}}/market_buy_price

قیمت تمام شده خرید یک ارز با مقدار مشخص شده در بازار رمزینکس

پارامتر نوع اجباری توضیحات
pair_id int بله
  • آیدی بازار و مقدار عددی است
  • نیاز به ارسال توکن ندارد
  • محدودیت فراخوانی ندارد

GET قیمت تمام شده فروش یک ارز

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/2/market_sell_price'
   Body
{
  "status": 0,
  "data": {
    "price": 9310000000
  }
}
   Header
Date: Tue, 17 May 2022 14:06:58 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=TS8F5dfXN5YSAS2n1hQhVs1hFqOJAfwWqOvZvAGrcAmha9OjfPvGiXeV7xK6dbZO9K68w%2B9kmc7Ee0YGYgBCjhp1A4CyAQh5eg4QjEvsQ05kzB9TNEwXepC%2Ff2rHjyikdTaIgoR2O2Q%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cceaad0feb9b34-FRA
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/orderbooks/{{pair_id}}/market_sell_price

قیمت تمام شده فروش یک ارز با مقدار مشخص شده در بازار رمزینکس

پارامتر نوع اجباری توضیحات
pair_id int بله
  • آیدی بازار و مقدار عددی است
  • نیاز به ارسال توکن ندارد
  • محدودیت فراخوانی ندارد

احراز هویت

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

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

Authorization2: Bearer Your-Token

x-api-key: YOUR_API_KEY

POST گرفتن مشخصات کلید خصوصی (Api Key)

   Example Request
curl --location --request POST 'http://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/apiKeyDetail' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key_id": 1
}'
   Body
{
  "status": 0,
  "data": {
    "id": 1,
    "api_key": "ApiKeyVQaSauG:248030519afb1df40adeda047d3748674fc780c29bce31a4ba63f348183601af",
    "name": "firstTest",
    "withdraw": 1,
    "trade": 0,
    "cancel_order": 1,
    "excel_output": 0,
    "ip_free": 0,
    "address_free": 1,
    "alert": 0,
    "ips": [
      "89.199.67.117",
      "94.182.157.67",
      "2.190.142.183"
    ],
    "created_at_ms": 1650456362,
    "updated_at_ms": 1650456362
  }
}

POST https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/apiKeyDetail

گرفتن مشخصات کلید خصوصی (Api Key)

Query Parameters:

پارامتر نوع اجباری
api_key_id int بله

POST ایجاد کلید خصوصی (API Key)

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/createApikey' \
--data-raw '  {
  "withdraw" : 1,
    "trade" : 0,
    "cancel" : 1,
    "excel" : 0,
    "ipFree" : 0,
    "addressFree" : 1,
    "alert" : 0,
    "2fa":0,
    "agree":1,
    "name" : "Test GA2",
    "ips" : [
        "89.199.67.117",
        "94.182.157.67",
        "2.190.142.183"
    ],
    "gaCode":381023
  }'
   Body
{
  "status": 0,
  "data": {
    "secret_key": "7aa097541eb26000ef40ddc75b3",
    "api_key": "ApiKeyZb69EDB:a5ecf1977baf33e891c6b903cb7e3b6a73819b9a933e412addefd9c25dba6",
    "details": {
      "id": 814,
      "api_key": "ApiKeyZb69EDB:a5ecf1977baf33e891c6b903cb7e3b6a73819b9a933e412addefd9c25dba6",
      "name": "Test GA2",
      "withdraw": 1,
      "trade": 0,
      "cancel_order": 1,
      "excel_output": 0,
      "ip_free": 0,
      "2fa": 0,
      "agree": 1,
      "address_free": 1,
      "alert": 0,
      "ips": [
        "89.199.67.117",
        "94.182.157.67",
        "2.190.142.183"
      ],
      "created_at_ms": 1663255962,
      "updated_at_ms": 1663255962
    }
  }
}
   Header
Date: Thu, 15 Sep 2022 15:32:44 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=THvvgB0kKD8RPsXemMbyxbTcJXw%2FrgsF6Xf%2BZIDD6LyiMG3W8lxv%2FRPjjXrzB6AitK6XVBHZ31ugIshNsCBjPpPkhwnW2UeBNnBl6hv%2B7rHoCqUDiqyZIuWBCsgDfA%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 74b26a8d2e5f9b1b-FRA
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/createApikey

ایجاد Api Key

Query Parameters:

پارامتر نوع اجباری توضیحات
withdraw int(0,1) بله دسترسی به برداشت
trade int(0,1) بله دسترسی به ثبت سفارش
cancel int(0,1) بله
excel int(0,1) بله
ipFree int(0,1) بله دسترسی از هر IP
addressFree int(0,1) بله
alert int(0,1) بله ارسال هشدار
name string بله
ips Array of Strings بله IPهای مجاز
gaCode string بله کد گوگل آتنتیکیتور

POST حذف کلید خصوصی (API Key)

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/deleteApiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
"api_key_id" : 2
}'
   Body
{
  "status": 0,
  "data": [],
  "description": {
    "fa": "کلید api با موفقیت حذف شد",
    "en": "The api key was successfully removed"
  }
}

POST https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/deleteApiKey

حذف کلید خصوصی (API Key)

Query Parameters:

پارامتر نوع اجباری
api_key_id int بله

GET لیست تمام کلیدهای خصوصی (Api Key)

   Example Request
curl --location --request GET 'http://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/apiKeyList'
   Body
{
  "status": 0,
  "count": 1,
  "data": [
    {
      "id": 1,
      "api_key": "ApiKeyVQaSauG25ec92fb14e116673fcb65bd265bf0c57a120bc3197de69be61c2779f514f596",
      "withdraw": 1,
      "trade": 0,
      "cancel_order": 1,
      "excel_output": 0,
      "ip_free": 0,
      "address_free": 0,
      "alert": 0,
      "ips": "[94.182.157.67]",
      "created_at_ms": 1649595649
    }
  ]
}
   Header
Cache-Control: no-cache, private
Date: Wed, 18 May 2022 16:21:09 GMT
Content-Type: application/json
X-Ratelimit-Limit: 300
X-Ratelimit-Remaining: 297
Server: swoole-http-server
Connection: keep-alive
Content-Length: 170
Content-Encoding: gzip

GET https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/apiKeyList

لیست تمام کلیدهای خصوصی

DEL حذف تمام کلیدهای خصوصی (Api Keys)

   Example Request
curl --location --request DELETE 'http://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/deleteAllApiKey'
   Body
{
  "status": 0,
  "data": [],
  "description": {
    "fa": "همه کلید api با موفقیت حذف شد",
    "en": "The api keys was successfully removed"
  }
}

DEL https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/deleteAllApiKey

حذف تمام کلیدهای خصوصی (Api Keys)

POST بروزرسانی دسترسی‌های عمومی

   Example Request
curl --location --request POST 'http://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/editGeneralAccess'
   Body
{
  "status": 0,
  "data": [],
  "description": {
    "fa": "دسترسی ها با موفقیت آپدیت شد",
    "en": "Accesses were successfully updated"
  }
}

POST https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/editGeneralAccess

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

Query Parameters:

پارامتر نوع اجباری توضیحات
addressFree int(0,1) بله دسترسی به برداشت
alert int(0,1) بله دسترسی به ثبت سفارش

POST بروزرسانی دسترسی‌های خصوصی

   Example Request
curl --location --request POST 'http://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/editPrivateAccess' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key_id" : 1,
    "withdraw" : 1,
    "trade" : 0,
    "cancel" : 1,
    "excel" : 0,
    "ipFree" : 1

}'
   Body
{
  "status": 0,
  "data": [],
  "description": {
    "fa": "دسترسی ها با موفقیت آپدیت شد",
    "en": "Accesses were successfully updated"
  }
}
   Header
Cache-Control: no-cache, private
Date: Wed, 18 May 2022 15:41:12 GMT
Content-Type: application/json
X-Ratelimit-Limit: 300
X-Ratelimit-Remaining: 299
Server: swoole-http-server
Connection: keep-alive
Content-Length: 170
Content-Encoding: gzip

POST https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/editPrivateAccess

بروزرسانی دسترسی‌های خصوصی

Query Parameters:

پارامتر نوع اجباری توضیحات
api_key_id int بله
withdraw int(0,1) بله دسترسی به برداشت
trade int(0,1) بله دسترسی به خرید و فروش
cancel int(0,1) بله دسترسی لغو سفارش
excel int(0,1) بله
ipFree int(0,1) بله
ips Array of Strings بله IPهای مجاز

POST گرفتن توکن خصوصی

   Example Request
curl --location --request POST 'http://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/getToken' \
--header 'Content-Type: application/json' \
--data-raw '{
    "secret" : "2341e11612ad14ce88c063ec8d93a8c1",
    "api_key" : "ApiKeyVQaSauG:fbeb9412f0d4bb339c48d58b96e6995f0d25ded1e1ff0710c9ed049119d6136c"
}'
   Body
{
  "status": 0,
  "data": {
    "token": "abc2eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ8.eyJwcml2YXRlIjoie1wid1wiOjAsXCJ0XCI6MCxcINcIjowLFwiZVwiOjEsXCJpZlwiOjF9IiwiZ2VuZXJhbCI6IntcImFmXCI6MCxcImFsZXJ0XCI6MX0iLCJleHAiOjE2NTcxMTA5MzcsImlwIjoiW10iLCJzaWQiOiJBeWkyQVp3In0.WcEWBQjFH13WRTXMNRq55YxgvKI-5E5NdiJmktYsBpNfeLzyd7L9I-2RZJUfWruSUe7ef76QlP_iSr7udD3fmiPDqlY39FkBkE34lnAjF6xj6xv5CV573JlXjtg78JLba3-h4ga4DwlGiXL1TSPJRWAgglZknSQ4jzu6JO2KXjjie7dWKVvvbR5_Ps3Tja5QGsoIJa_UQDmqMVUZ0ucZ1MbrNSI_jZu9XXWPhEV3xQpVVTXIr5JkGuM7hNzogwel4wITdSbUtl2oiFc441JesnQpqmGibQwzlimFAe_DircKHIi3O4rSBaW873hEBPgvhphoo-mMiUNkGSEc2IkO3A"
  }
}
   Header
Cache-Control: no-cache, private
Date: Wed, 18 May 2022 16:28:22 GMT
X-Ratelimit-Limit: 300
X-Ratelimit-Remaining: 299
Content-Type: text/html; charset=UTF-8
Server: swoole-http-server
Connection: keep-alive
Content-Length: 2335
Content-Encoding: gzip

POST https://ramzinex.com/exchange/api/v1.0/exchange/auth/api_key/getToken

گرفتن توکن خصوصی

برای گرفتن API Key ابتدا به بخش مدیریت API مراجعه کنید و بعد از ساخت API Key کلید محرمانه و API Key خود را در HTTP Body Request خود ارسال کنید مثال مانند زیر:

   {

      "secret": "8abc111qsad11111c1222716306bf29807f7c7"

      "api_key": "ApiKeyAzi6AZw:0fdebee3ebc78abccddcc4b2c53db609b60e070ba83412c1540d8b7f952b277d1"

   }

کیف پول

برای هر ارز در کیف پول ۳ مقدار خواهید داشت:

  1. مقدار کل دارایی
  2. مقدار دارایی در حال معامله
  3. مقدار دارایی در دسترس

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

GET سرمایه در دسترس کاربر برای یک ارز

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/available/currency/96'
   Body
{
  "status": 0,
  "data": 5.94
}
   Header
Date: Tue, 17 May 2022 15:17:27 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.26
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=DOH1B30zazCMiLjDDjvrTMLyYXEEVSABeeKpy0VyiEVbSEQkLl3TNI4ds9fal%2FmWS1fUqTXVDh1lTh1K5ssfe2paOyujhMIZlhIdpSpzG%2B2OiJAwnySO%2F%2F7Eva5KRw%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cd51edcc8a9be2-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/available/currency/{{currency_id}}

میزان سرمایه در دسترس کاربر برای یک ارز مشخص

میزان سرمایه‌ای از یک ارز که در حال معامله نیست

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

GET سرمایه کل کاربر برای یک ارز

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/total/currency/96'
   Body
{
  "status": 0,
  "data": 5.94
}
   Header
Date: Tue, 17 May 2022 15:20:39 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.26
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 297
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=p18N9uYkxeIBYdByn5e4dukWE6QjH6VoyjW4OTce9yWq45Vmbf%2BB5pNzgaO5%2BCoq6bRdts3IFjlOPOlq9tl01Z3kAbkgZBj6Ukj0b0gkURBFWh6MR%2BAjgvD28ZuJtg%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70cd569e0d959be2-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/total/currency/{{currency_id}}

میزان سرمایه کل در دسترس کاربر برای یک ارز مشخص

میزان سرمایه کل یک ارز. مجموع سرمایه در حال معامله و سرمایه در دسترس

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

GET میزان سرمایه در حال معامله کاربر

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/in_orders/currency/2'
   Body
{
  "status": 0,
  "data": 0
}
   Header
Date: Wed, 18 May 2022 07:24:11 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.26
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 298
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=YlYIeIFvokkcQbx0kFon%2F7TLo4ZXrtxU02l1aiiDFtjOCMA%2FZE3mOd82RwQ5yCs74fZw9vPOw0HY5E%2Ff0Ie6wu9unYTr38yKQ7sD%2FKa5s5d0A%2FwXudzW9jAT8oGbAw%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d2da0868f591f5-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/in_orders/currency/{{currency_id}}

میزان سرمایه در حال معامله کاربر برای یک ارز مشخص

میزان سرمایه‌ای از یک ارز که در حال معامله است

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

GET مشخصات سرمایه کاربر برای یک ارز

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/details/currency/1'
   Body
{
  "status": 0,
  "data": {
    "total": "0.00000",
    "in_order": "0",
    "available": "0.00000",
    "currency": {
      "icon": "https://ramzinex.com/exchange/img/coins/btc.png",
      "symbol": "BTC",
      "name": "Bitcoin",
      "fee": 0.0005,
      "precision": 7,
      "show_order": 2000
    },
    "is_rial": false,
    "has_tag": false,
    "rialCards": [],
    "address": "15nzUXQL6hsaBE3usxrq4218xKSQJs1xjw",
    "exchange_address": null,
    "currency_id": 1,
    "rial_equivalent": {
      "buy": 0,
      "sell": 0,
      "show": 0
    },
    "rial_equivalent_show": 0,
    "usdt_equivalent": {
      "buy": 0.025107491856677523,
      "sell": 0.025148286144951744
    },
    "related_pairs": [
      12,
      2
    ],
    "rial_related_pair": 2,
    "international_price": null,
    "total_nr": 0,
    "in_order_nr": 0,
    "available_nr": 0
  }
}
   Header
Date: Wed, 18 May 2022 07:33:09 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.22
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 297
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=EmA76iBOsB7ZhomYQrIKmB5nRLZgMF8qtc5HrFRBdY8SBciUMRKEi8dNO2DW1YbUoKU6Fsf8c5j2dM5OPIlCuCp1uw8JR3B%2FdEyYcUtOqXuWmrDLSZSQcoJf6oYxow%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d2e72ca8929ba4-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/details/currency/{{currency_id}}

مشخصات سرمایه کاربر برای یک ارز مشخص

مشخصات سرمایه‌ یک ارز

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

GET مشخصات سرمایه کاربر برای همه ارزها

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/details'
   Body
{
  "status": 0,
  "data": [
    {
      "total": "3.1220",
      "in_order": "0.92",
      "available": "2.2020",
      "currency": {
        "icon": "https://ramzinex.com/exchange/img/coins/eth.png",
        "symbol": "ETH",
        "name": "Ethereum",
        "fee": 0.005,
        "precision": 6,
        "show_order": 4000
      },
      "is_rial": false,
      "has_tag": false,
      "rialCards": [],
      "address": "0x741c13c7f45620c7DF7D63516BAdbF235fE46A35",
      "exchange_address": null,
      "currency_id": 4,
      "rial_equivalent": {
        "buy": 373380925.014086,
        "sell": 376258197.398714,
        "show": 376258197.398714
      },
      "rial_equivalent_show": 376258197.398714,
      "usdt_equivalent": {
        "buy": 884.4313035039999,
        "sell": 887.350893792
      },
      "total_nr": 3.122,
      "in_order_nr": 0.92,
      "available_nr": 2.202,
      "international_price": "454.32",
      "related_pairs": [
        13,
        3
      ],
      "rial_related_pair": 3
     }
  ]
}
   Header
Content-Type: application/json

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/details

مشخصات سرمایه کاربر برای همه ارزها

GET شبکه‌های موجود برای واریز و برداشت یک ارز

   Example Request
curl --location --request GET 'https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/networks?currency_id=46&withdraw=1'
   Body
{
  "data": [
    {
      "id": 116,
      "show_name": "ERC20",
      "name": "ERC20",
      "currency_id": 46,
      "withdraw_fee": 18000,
      "has_tag": 0,
      "withdraw_min": 40000,
      "deposit_min": 0,
      "deposit": 1,
      "withdraw": 1,
      "deposit_temporarily_suspended": 0,
      "withdraw_temporarily_suspended": 0,
      "contract_address": "0x95ad61b0a150d79219dcf64e1e6cc01f0b64c4ce"
    }
  ],
  "status": 0
}
   Header
Date: Tue, 28 Jun 2022 14:45:04 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 86400
Access-Control-Allow-Headers: *
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=nohrE7%2FoGiT%2FZL9q471Sqwjlq9BlGlsgXKTaeGE1cQMEarytS%2FvSmDe4wyqE%2BgVCgYIe%2BMdPUplUYS2swiY9lP5kGKb8pEryg0stMPfCqrKKBVTv7a6deuxg6gOGWyhKRLEp7XBNkxw%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 7227343d6eaa76fc-LHR
Content-Encoding: br

GET https://publicapi.ramzinex.com/exchange/api/v1.0/exchange/networks

شبکه‌های موجود

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

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر
withdraw int:1 بله دریافت شبکه‌های برداشت
deposit int:1 بله دریافت شبکه‌های واریز

POST آدرس‌های کاربر

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/addresses' \
--data-raw '{
    "networks":[
        116
            ]
}'
   Body
{
  "status": 0,
  "count": 1,
  "data": [
    {
      "address": "0x521A993a8B4b731E8e1801777722109f3953b6bF",
      "tag": null,
      "has_tag": false,
      "currency_id": 46,
      "network_id": 116
    }
  ]
}
   Header
Date: Tue, 28 Jun 2022 14:44:30 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.15
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 298
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=UifNiB3GV1p5ytjx0lyRedXr9MEEygFtoriBwwMfzl87R9za17pE7S2ygi0xWy3wwsrCyMKt1LsH7Ac%2BhGFb2rhDgTfFNhn33aLb6CGbNfxpk%2BLyV5WyGI%2BUS36wkw%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 72273366095be680-LHR
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/addresses

آدرس‌های موجود برای یک کاربر

برای دریافت آدرس‌های موجود برای یک ارز از این نوع درخواست استفاده کنید

Path Variable:

پارامتر نوع اجباری توضیحات
networks array['network_id'] بله دریافت آدرس ولت‌های هر ارز کاربر که آرایه‌ای از آیدی‌های شبکه می‌باشد

GET دارایی

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop'
   Body
{
  "status": 0,
  "data": [
    {
      "currency_id": 1,
      "total_nr": 0,
      "in_order_nr": 0
    }
  ]
}
   Header
Date: Wed, 15 Jun 2022 12:44:03 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.22
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=QVqwgz3GRTQzFc%2BAUDY%2B9q34GsSTK08RtZmRgVgucOg%2FBClNXZz46XpccxcCCM2%2BKK7%2BF37jyO6RxuQBW5MLZYaGfT9x%2BlefbxVxWjIv0dkl8huN0SFQXOC10NUfPA%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 71bb65152aa69229-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop

میزان دارایی

برای دریافت میزان کل دارایی‌های یک کاربر از این درخواست استفاده کنید

واریزها و برداشت‌ها

GET مشخصات واریزهای انجام شده کاربر برای یک ارز مشخص

   Example Request
curl --location -g --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/deposits/currency/{{currency_id}}' \
--data-raw ''
   Body
{
  "status": 0,
  "data": [
    {
      "id": 24300,
      "amount": "300,000,000",
      "amount_nr": 300000000,
      "address": "6104337921687230",
      "txid": "LSGMSI83O8A30HQ",
      "link": null,
      "confirm": 1,
      "created_at": "99-08-24 19:17",
      "created_at_ms": 1605368876
    }
  ]
}

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/deposits/currency/{{currency_id}}

مشخصات واریزهای انجام شده کاربر برای یک ارز مشخص

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

Query Parameters:

پارامتر نوع اجباری
offset int بله
limit int بله

POST مشاهده واریزهای کاربر برای ارزهای مخشص شده

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/deposits' \
--header 'Content-Type: application/json' \
--data-raw '{
"limit": 10,
"offset": 2,
"currencies": [
    1,
    2
  ]
}'
   Body
{
  "status": 0,
  "count": 192,
  "data": [
    {
      "id": 24126,
      "currency_id": 1,
      "amount": 0.006,
      "amount_nr": 0.006,
      "address": "19kvgGuT31SMTRsZ7oL1Y2LWVtFcns4sUh",
      "txid": "77558309688f430c09edcb123b7e8ca6372ce130a7a630a61f78b81282720040",
      "link": "https://blockchair.com/bitcoin/transaction/77558309688f430c09edcb123b7e8ca6372ce130a7a630a61f78b81282720040",
      "confirm": 1,
      "created_at": "99-08-23 15:38",
      "created_at_ms": 1605269281
    }
  ]
}

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/deposits

مشخصات واریزهای انجام شده کاربر برای ارزهای مشخص

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

Query Parameters:

پارامتر نوع اجباری
offset int بله
limit int بله
currencies Array of integers بله

GET مشخصات یک واریز مشخص

   Example Request
curl --location -g --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/deposits/{{id}}'
   Body
{
  "status": 0,
  "data": {
    "id": 7770,
    "amount": "40,000,000",
    "amount_nr": 40000000,
    "address": "6104337921687230",
    "txid": "15006511859",
    "link": null,
    "confirm": 1,
    "created_at": "99-03-03 23:52",
    "created_at_ms": 1590261756
  }
}
   Header
Date: Wed, 18 May 2022 09:35:14 GMT
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.16
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
referrer-policy: no-referrer-when-downgrade
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=kWxjFC3FJzRlSt8BrmJXjwssiRI%2BHtKWe2Iwsvc%2FgrslKyM%2BwvJTH0mgUZDFfIz6keQ%2BDCCdIPr7PCoc9Go2mYfjahnfeMIEZ9NEMsfZpSMAqq1XR%2FoOJr4GKbUiqA%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d39a009fcc922c-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/deposits/{{id}}

مشاهده مشخصات یک واریز مشخص کاربر

Path Variable:

پارامتر نوع اجباری توضیحات
id int بله آیدی یک واریز خاص می‌باشد و مقدار آن عدد است

GET مشخصات برداشت‌ها

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws'
   Body
{
  "status": 0,
  "count": 317,
  "data": [
    {
      "id": 18958,
      "amount": "26,600,000",
      "amount_nr": 26600000,
      "address": "6274121165402926, 760550236170105534203001,",
      "has_tag": false,
      "verification_status": {
        "cell_number": "09155192066",
        "remained": 300,
        "verified": false
      },
      "currency_id": 2,
      "currency": {
        "name": "rial",
        "persian_name": "ریال",
        "show_precision": 0,
        "id": 2,
        "symbol": "irr",
        "has_tag": false,
        "international_price": null,
        "withdraw_fee": 25000,
        "icon": "/exchange/img/coins/irr.png",
        "show_order": 1000,
        "related_pairs": [],
        "rial_related_pair": null
      },
      "txid": "pg583045",
      "link": null,
      "status": {
        "fa_name": "انجام شده(نهایی)",
        "id": 6
      },
      "status_id": 6,
      "can_be_canceled": false,
      "is_created": false,
      "verifiable": false,
      "created_at": "99-08-24 07:11",
      "created_at_ms": 1605325282
    }
  ]
}
   Header
Date: Wed, 18 May 2022 09:37:06 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.16
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
referrer-policy: no-referrer-when-downgrade
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=76LuRaeztWkeDoXutYPkR3W27%2BT0kbNgPq8Z0QDe%2FwOPuVphsuaTVnwf8niwboA5T5lnznNIaEz5v9gWLYda2szInjagJQXuK4HTfSObXtjl1EIeBXdMI4NCUXrNkw%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d39cbcceda922c-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws

مشخصات برداشت‌های کاربر

برای دریافت مشخصات برداشت‌های یک ارز کاربر از این درخواست استفاده کنید

Query Parameters:

پارامتر نوع اجباری توضیحات
offset int بله دریافت از تراکنش شماره آفست
limit int بله دریافت به تعداد لیمیت از شماره آفست به بعد
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

GET مشخصات یک برداشت خاص

   Example Request
curl --location -g --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{id}}'
   Body
{
  "status": 0,
  "data": {
    "id": 5813,
    "amount": "1",
    "amount_nr": 1,
    "address": "6104337921687230, 060120020000005208271692, 5208271692",
    "has_tag": false,
    "verification_status": {
      "cell_number": "09155192066",
      "remained": 300,
      "verified": false
    },
    "currency_id": 2,
    "currency": {
      "name": "rial",
      "persian_name": "ریال",
      "show_precision": 0,
      "id": 2,
      "symbol": "irr",
      "has_tag": false,
      "international_price": null,
      "withdraw_fee": 25000,
      "icon": "/exchange/img/coins/irr.png",
      "show_order": 1000,
      "related_pairs": [],
      "rial_related_pair": null
    },
    "txid": null,
    "link": null,
    "status": {
      "fa_name": "رد شده",
      "id": 8
    },
    "status_id": 8,
    "can_be_canceled": false,
    "is_created": false,
    "verifiable": false,
    "created_at": "99-02-31 17:39",
    "created_at_ms": 1589980157
  }
}

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{id}}

مشخصات یک برداشت خاص کاربر

Path Variable:

پارامتر نوع اجباری توضیحات
id int بله آیدی یک واریز خاص می‌باشد و مقدار آن عدد است

POST درخواست برداشت ارز

   Example Request
curl --location -g --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/{{currency_id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 1,
"address": "1x484B993a8B4b731E8e1803456812109f3953b2cF",
"network_id": 1,
"currency_id": 1,
"tag": 12312,
"no_tag": false
}'
   Body
{
  "withdraw_id": 14345647
}
   Header
Date: Wed, 18 May 2022 10:06:12 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.16
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 297
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
referrer-policy: no-referrer-when-downgrade
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=7B8O9W0k3DnfDm98py5YauWUsJ5mHzlj0DDBhd64OaxhqgJeIyXEemPk8kjypXvXS9fUjB8kBWqNjujqR6XdekwUox4TA6BXZgOL0APbr3LwBO1id7b4GyQ1gw0GIg%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d3c75e49c39ba7-FRA
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/{{currency_id}}

درخواست برداشت ارز به یک آدرس مشخص

درخواست برداشت یک ارز با مقدار مشخص شده به یک آدرس فرستاده می‌شود
‫ برای آگاهی از currency_id از درخواست مشخصات یک بازار مشخص در بخش اطلاعات بازار استفاده کنید:

Path Variable:

پارامتر نوع اجباری توضیحات
currency_id int بله آیدی ارز مورد نظر می‌باشد و مقدار آن عدد است

Query Parameters:

پارامتر نوع اجباری
amount int بله
address string بله
network_id int بله
currency_id int بله
tag int بله
no_tag boolean بله

POST تایید برداشت

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/4712789/verify' \
--data-raw '{
    "code" : "157018",
    "gaCode" : "194570"
}'
   Body
{
  "status": 0
}
   Header
Date: Sun, 03 Jul 2022 11:17:44 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.15
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 296
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=X55UzXcH2fpcsxwNZTNkOfSnDJoxmtRKWaQ53cN8u1g4N%2BK8XgId1j1q%2Bnu7bJ2%2F%2BZNHISiqLHlhrT9I2f%2BtKExS90pCJExl5XSCvaqemTZKzvhO3LYf42HD65Nw4Q%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 724f373d3d4091ff-FRA
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{withdraw_id}}/verify

تایید برداشت یک ارز

‫ برای تایید یک برداشت کد ارسال شده در پیامک و کد Google Authenticator (در صورت فعالسازی) را به این درخواست ارسال کنید.

Path Variable:

پارامتر نوع اجباری توضیحات
withdraw_id int بله شماره برداشت مورد نظر و مقدار آن عدد است

Request Params:

پارامتر نوع اجباری توضیحات
code int بله کد پیامک ارسال شده
gaCode int بله کد گوگل آث

POST کنسل کردن یک برداشت مشخص

   Example Request
curl --location -g --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{id}}/cancel'

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{id}}/cancel

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

در نظر داشته باشید که هنگام ثبت یک برداشت موجودی از حساب شما کم می‌شود و تا قبل زمان لغو یک برداشت این موجودی به حساب شما بر نمی‌گردد

Path Variable:

پارامتر نوع اجباری توضیحات
id int بله شماره آیدی برداشت

پاداش‌ها وکمیسیون‌ها

POST جزئیات ریزپاداش‌های کاربر

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/bonuses'
   Body
{
  "status": 0,
  "count": 41,
  "data": [
    {
      "amount": "2.2728",
      "created_at": "99-06-20 21:23",
      "created_at_ms": 1599756782,
      "currency_id": 14
     }
          ]
}

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/bonuses

جزئیات ریزپاداش‌های کاربر

جمع تمام پاداش‌های دریافتی به تفکیک ارز

Query Parameters:

پارامتر نوع اجباری توضیحات
offset int بله دریافت از تراکنش شماره آفست
limit int بله دریافت به تعداد لیمیت از شماره آفست به بعد

GET کمیسیون مربوط به تراکنش‌های انجام شده

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/commissions'
   Body
{
  "status": 0,
  "data": [
    {
      "amount": "0",
      "percent": 0,
      "currency_id": 2,
      "created_at": "99-08-24 09:45",
      "created_at_ms": 1605334535
    }
  ],
  "count": 0
}
   Header
Date: Wed, 18 May 2022 10:47:01 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.16
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 298
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
referrer-policy: no-referrer-when-downgrade
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=hyPV0HhIeLhvMHxN20pxxCSM6HFbq49sYUz6hlhXNEf8uqRVe42%2B3WTF2Rirv96V5oOjQfHpk7tfzFHZ2DWhcP9KJeqLOaI51WAUCoC20YSQLva%2Bo0ZAJyRbsJHckg%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d403296e8f920e-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/commissions

میزان کمیسیون مربوط به تراکنش‌های انجام شده توسط کاربر

Query Parameters:

پارامتر نوع اجباری توضیحات
offset int بله دریافت از تراکنش شماره آفست
limit int بله دریافت به تعداد لیمیت از شماره آفست به بعد

GET کل پاداش‌های کاربر

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/bonuses/total'
   Body
{
  "status": 0,
  "data": {
    "more_info_url": "string",
    "referral_code": "string",
    "referrals": [
      {
        "coin": "بیت کوین",
        "income": 0,
        "currency_id": 1
      }
    ],
    "ref_count": 0
  }
}
   Header
Date: Wed, 18 May 2022 10:54:24 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.22
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=u5ttx%2BDTo2hVL6m8zG9id5vaW171Im3V7kPK8aGXbr8JzJlWyGcWzpJ1eUo4Z9DGR%2FAINS2QRBsCthLDItY8IRHZ2fg3LO547xSYaFtXyBDWCD8bvm12a8B%2FKG9%2BEg%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d40df5dda99950-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/funds/bonuses/total

مشاهده کل پاداش‌های کاربر

Query Parameters:

پارامتر نوع اجباری توضیحات
readable int (0,1) بله در صورت 1 بودن مقدار را برمی‌گرداند و در صورت 0 بودن به جای اعداد * برمی‌گرداند

سفارشات و معاملات

POST دریافت سفارش‌های کاربر

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders3' \
--data-raw '{
"limit": 4,
"offset": 0,
"pairs":[12],
"states": [3],
"isbuy": true
}'
   Body
{
  "status": 0,
  "count": 145,
  "data": [
    {
      "id": 324959147,
      "pair": "bitcoin/tether",
      "pair_obj": {
        "sell": 23191.67,
        "buy": 22823.52,
        "pair_id": 12,
        "name": {
          "fa": "بیت کوین/تتر",
          "en": "bitcoin/tether"
        },
        "icon": "/exchange/img/coins/btc.png",
        "web_link": "https://ramzinex.com/exchange/orderbook/12",
        "base_precision": 5,
        "quote_precision": 2,
        "base_currency_id": 1,
        "base_currency_symbol": {
          "en": "btc",
          "fa": "بیت کوین"
        },
        "quote_currency_id": 9,
        "quote_currency_symbol": {
          "en": "usdt",
          "fa": "تتر"
        },
        "financial": {
          "last24h": {
            "open": 23100,
            "close": 22887,
            "highest": 23344,
            "lowest": 22750,
            "quote_volume": 3257,
            "base_volume": 0.14,
            "change_percent": -0.92
          }
        },
        "price_step": 23,
        "amount_step": 43.11707,
        "tv_symbol": {
          "ramzinex": "btcusdt",
          "international": "BINANCE:BTCUSDT"
        },
        "show_order": 210,
        "url_name": "bitcoin-btc",
        "crypto_box": 0,
        "price_precision": null
      },
      "pair_name": {
        "en": "bitcoin/tether",
        "fa": "بیت کوین/تتر"
      },
      "pair_id": 12,
      "type_id": 1,
      "type_id_v2": 11,
      "type_v2_all_lang": {
        "en": "limit",
        "fa": " محدود"
      },
      "type": "فروش",
      "type_en": "sell",
      "amount": "0.0046 btc",
      "stop_price": null,
      "limit_price": null,
      "stop_limit_price": null,
      "amount_nr": 0.0046,
      "amount_quote_nr": 106.3,
      "total_quote_amount_nr": 106.3,
      "average_price": "23,109 usdt",
      "average_price_nr": 23109.41,
      "order_price": 23109.41,
      "order_price_nr": 23109.41,
      "total_payment": "0.00460 btc",
      "total_payment_nr": 4.59,
      "net_received": "106.19 usdt",
      "net_received_nr": 106.19,
      "commission_currency_id": 9,
      "commission_nr": 0.1,
      "commission_percentage_nr": 0,
      "filled_nr": 0.0046,
      "created_at": "1-05-10 23:03",
      "created_at_ms": 1659378787,
      "status": {
        "fa_name": "کاملا اجرا شده",
        "id": 3
      },
      "status_id": 3,
      "percent": "100 %",
      "percent_num": 100,
      "details_route": "https://ramzinex.com/exchange/order/orderDetails/324959147"
    }
  ]
}
   Header
Date: Tue, 02 Aug 2022 16:05:54 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.14
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 299
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
referrer-policy: no-referrer-when-downgrade
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=KgxbeLF%2BFJ5l5ladHEM7zpFGDhKgFUNAftQK0Q1%2FEGs2gIryKlcu91fW6WRM6Xp0wOFzE2mBTVU0BO3K%2F5OcTSxw8IKI%2Fp3gTUnOluaUnUpGWxcX%2BK5ksB4T67mtaA%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 73480ec53aed995c-FRA
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders3

دریافت سفارش‌های کاربر با مشخصات خاص

Query Parameters:

پارامتر نوع اجباری توضیحات
limit int بله دریافت به تعداد لیمیت از شماره آفست به بعد
offset int بله دریافت از تراکنش شماره آفست
pairs Array of strings بله آرایه‌ای از آیدی بازارها
states Array of integers بله
isbuy boolean بله نوع سفارش

GET مشخصات یک سفارش

   Example Request
curl --location -g --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders2/{id}'
   Body
{
  "status": 0,
  "data": {
    "id": 97822768,
    "pair": "ethereum/rial",
    "pair_obj": {
      "sell": 121907055,
      "buy": 120998995,
      "pair_id": 3,
      "name": {
        "fa": "اتریوم",
        "en": "ethereum/rial"
      },
      "icon": "/exchange/img/coins/eth.png",
      "web_link": "https://ramzinex.com/exchange/orderbook/3",
      "base_precision": 4,
      "quote_precision": 0,
      "base_currency_id": 4,
      "base_currency_symbol": {
        "en": "eth",
        "fa": "اتریوم"
      },
      "quote_currency_id": 2,
      "quote_currency_symbol": {
        "en": "irr",
        "fa": "ریال"
      },
      "financial": {
        "last24h": {
          "open": 120804994,
          "close": 120993664,
          "highest": 122728559,
          "lowest": 118000000,
          "quote_volume": 4815813440,
          "base_volume": 40.146,
          "change_percent": 0.15
        }
      },
      "price_step": 121907,
      "amount_step": 0.0082
    },
    "pair_name": {
      "en": "ethereum/rial",
      "fa": "اتریوم"
    },
    "pair_id": 3,
    "type_id": 1,
    "type": "فروش",
    "type_en": "sell",
    "amount": "0.1 eth",
    "amount_nr": 0.1,
    "amount_quote_nr": 8800000,
    "total_quote_amount_nr": 8800000,
    "average_price": "88,000,000 irr",
    "average_price_nr": 88000000,
    "order_price": 88000000,
    "order_price_nr": 88000000,
    "total_payment": "0.1000 eth",
    "total_payment_nr": 1000,
    "net_received": "8,800,000 irr",
    "net_received_nr": 8800000,
    "commission_currency_id": 2,
    "commission_nr": 0,
    "commission_percentage_nr": 0,
    "filled_nr": 0.1,
    "created_at": "99-05-22 23:38",
    "created_at_ms": 1597259327,
    "status": {
      "fa_name": "کاملا اجرا شده",
      "id": 3
    },
    "status_id": 3,
    "percent": "100 %",
    "percent_num": 100,
    "details_route": "https://ramzinex.com/exchange/order/orderDetails/97822768"
  }
}

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders2/{id}

مشخصات یک سفارش مشخص

Path Variable:

پارامتر نوع اجباری توضیحات
id int بله شماره تراکنش

POST ارسال سفارش محدود

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/limit' \
--data-raw '{
    "pair_id":12,
    "amount":0.00460,
    "price":12000,
    "type":"buy"
}'
   Body
{
  "status": 0,
  "data": {
    "order_id": 324126174
  }
}
   Header
Date: Mon, 25 Jul 2022 07:55:05 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.26
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 298
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=VLtudnUMi3jmSdTqAp3pj8iREGvNl84EOI%2BSyywI691gBZZaiJt30nXbsrYaQY5YRm3ItqfYVQwB8O3Of9mnr0BaKZL5%2FSiZXBvo1a9ECvunxjYx3OO8w0wQFjjzfw%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 730354cadd21bbb9-FRA
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/limit

ارسال سفارش محدود

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

Query Parameters:

پارامتر نوع اجباری توضیحات
pair_id int بله آیدی بازار می‌باشد و مقدار آن عددیست
amount double بله حجم سفارش برای ارز می‌باشد و مقدار آن می‌تواند اعشاری باشد
price double بله
type string (sell,buy) بله

POST ارسال سفارش بازار

curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/market' \
--data-raw '{
    "pair_id" : 272,
    "amount" : 5,
    "type": "sell"
}'
   Body
{
  "status": 0,
  "data": {
    "order_id": 123456
  }
}

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/market

ارسال سفارش از نوع بازار

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

Query Parameters:

پارامتر نوع اجباری توضیحات
pair_id int بله شماره بازار مورد نظر و مقدار آن عدد است
amount double بله حجم ارز مورد که می‌تواند مقدار آن اعشاری باشد
type string (sell,buy) بله نوع سفارش که می‌تواند خرید(true) یا فروش(false) باشد

POST کنسل کردن سفارش

   Example Request
curl --location --request POST 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/324135039/cancel'
   Body
{
  "description": "ok",
  "status": 0,
  "data": []
}
   Header
Date: Mon, 25 Jul 2022 10:02:32 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.15
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 293
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=Xjh2ukU54hX8M41ZzAj3yesXWU73LGgWvAmgQRa81luZPPO8WMN%2FHqD49n7zV2QnGRZnSsZ3O1LtCAqkA4hy5SKBbS4WaRh17fCbAWGFFx15SgJiXLlHdDXGxOO3TQ%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 73040f81bb9b696f-FRA
Content-Encoding: br

POST https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/324135039/cancel

کنسل کردن سفارش موجود

برای لغو کردن یک سفارش از این درخواست استفاده کنید.

Path Variable:

پارامتر نوع اجباری توضیحات
order_id int بله آیدی سفارش که مقدار آن عدد است

GET حجم معاملات در یک بازه زمانی مشخص

   Example Request
curl --location --request GET 'https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/turnover' \
--data-raw ''
   Body
{
  "status": 0,
  "data": {
    "ninetyDayTurnover": 858187626007,
    "nextLevelTurnover": null,
    "volume": 858187626007
  }
}
   Header
Date: Wed, 18 May 2022 12:21:06 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
vary: Accept-Encoding
x-powered-by: PHP/7.4.26
cache-control: no-cache, private
x-ratelimit-limit: 300
x-ratelimit-remaining: 297
access-control-allow-origin: *
x-frame-options: SAMEORIGIN
CF-Cache-Status: DYNAMIC
Expect-CT: max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=IKsL%2FHCNkKsDXXmq9rJLTMDtRtDvJS2ce%2FveOlaIFkPtIQ94axD0ZsWbrz3LSHi1m%2FtNLf8IRKD6LPgIrGpC75FWaxaN1bKnP6YAt0fhI32y2%2BKky73qDdnhl3OpUg%3D%3D"}],"group":"cf-nel","max_age":604800}
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
Server: cloudflare
CF-RAY: 70d48cf8dc855c9e-FRA
Content-Encoding: br

GET https://ramzinex.com/exchange/api/v1.0/exchange/users/me/orders/turnover

حجم معاملات سی روزه

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

Query Parameters:

پارامتر نوع اجباری توضیحات
readable int(0,1) بله خوانا یا ناخوانا بودن مقدار
days 30 بله 30

سوکت‌ها

GET لیست سفارش‌های Orderbook

   Example Request
curl --location --request GET ''

لیست سفارش‌های اوردربوک

برای استفاده از سوکت اردربوک باید از کتابخانه socket.io با توجه به زبانی که برنامه‌نویسی می‌کنید استفاده کنید و همانند مدل زیر کانکشن سوکت خود را بسازید:

var socket = io("wss://publicapi.ramzinex.com",{path:"/exchange/wss/v1.0/orderbook/{{pair_id}}/"})

خطاها و استاتوس‌ها

لیست خطاهای HTTP

خطا توضیحات
429 تعداد درخواست‌های زیاد برای ای پی آی‌های غیر پابلیک
503 ,500 خطاهای مربوط به مشکلات سرور از سمت رمزینکس

لیست خطاهای داخلی رمزینکس

خطا توضیحات
82- یک دقیقه دیگر امتحان کنید
81- شما فقط در هر دقیقه ۲ سفارش می‌توانید بگذارید
1232- به دلایل امنیتی حساب شما قادر به برداشت رمزارز نیست، لطفا به پشتیبانی مراجعه کنید
8001 شماره‌های شبای بانک انصار تغییر یافته است و شماره شبای ورودی شما معتبر نیست. لطفا شماره شبای جدید خود را از بانک انصار دریافت کنید.
1004 شبا صحیح نمی‌باشد
8003 شبکه در حال پیاده سازی است لطفا شبکه‌ی دیگری را امتحان کنید
8003 به دلیل فی ERC20 برداشت موقتاً مقدور نیست.
8003 برداشت شما با مشکل مواجه شد لطفا مشکل با پشتیبانی مطرح کنید.
8003 آدرس معتبر نیست.
8003 برداشت برای ارز درخواستی موقتا غیرفعال شده است.
8003 امکان برداشت ارزهای دیجیتال در وجود ندارد.
8003 امکان برداشت ریال در فقط برای حساب های متعلق به فرد وجود دارد.
8003 برداشت برای حساب کاربری شما غیر فعال شده است.
8003 به دلیل مشکل فنی در حساب شما موقتا امکان برداشت برای شما مقدور نیست، اگر تا ۱۵ دقیقه ی دیگر حل نشد، لطفا با پشتیبانی در تماس باشید.
8003 برداشت نمی‌تواند منفی باشد.
8003 تعداد ارقام اعشار بیش از حد مجاز است.
8003 مبلغ درخواستی بیش از موجودی شماست لطفا مقادیر کمتر را امتحان کنید یا در صورت داشتن سفارش باز آن ها را کنسل نمایید.
8003 به دلیل مشکل فنی برداشت برای حساب شما غیرفعال شده است با پشتیبانی در تماس باشید.
8008 برداشت غیر فعال است
8008 برای برداشت مبالغ بالاتر از سی میلیون رمزارز در روز لطفا گوگل اتنتیکیتور خود را فعال کنید
8008 شما به سقف مقدار برداشت روزانه رسیدید
8008 شما برداشت با آدرس‌ و مقدار یکسان در چند دقیقه اخیر داشتید لطفا چند دقیقه دیگر امتحان کنید یا مقدار دیگری را امتحان کنی
80019 مقدار برداشتی از کارمزد برداشت کمتر است
8000039 با توجه به بخش نامه بانک مرکزی سقف برداشت روزانه به هر شماره شبا ۱۰۰ میلیون تومان است لطفا جهت برداشت مبالغ بیشتر از چند شماره شبا استفاده کنید یا در چند روز اقدام به برداشت کنید.
91222- بدون فعال سازی گوگل اتنتیکیتور امکان برداشت رمزارز را ندارید
915552- برای برداشت رمزارز باید ۱ روز از فعال کردن گوگل اتنتیکیتور شما بگذرد
80015 لطفا چند دقیقه دیگر امتحان کنید.
10- اطلاعات وارد شده درست نیست.
555- کد شناسایی دو مرحله‌ای گوگل آتنتیکیتور شما اشتباه است
12- مدت اعتبار کد ارائه شده به اتمام رسیده است
2- شما نمی‌توانید این برداشت را تایید کنید. احتمالا زمان قابل تایید برای این برداشت سپری شده است یا اینکه ارسال شده است.
193- لطفا x ثانیه دیگر امتحان کنید. مقدار برای شما داخل پیام ارسال می‌شود
3- سفارش شما باز نیست و امکان کنسل ندارد(قبلا اجرا شده ی کامل و یا جزیی بوده و یا قبلا کنسل شده است)
32- سفارش ثبت نشد لطفا بعد از چند لحظه دوباره تلاش کنید
32- موقتاً معامله در این بازار متوقف شده است
11- خطا در ثبت سفارش
1- قیمت نمی‌تواند منفی یا صفر باشد
2- مقدار نمی‌تواند منفی یا صفر باشد
3- بازار معتبر نیست
4- نوع معتبر نیست
5- موجودی کافی نیست
6- خطا در ثبت سفارش؛ لطفا مقادیر خود را چک کنید
7- به دلیل به روزرسانی اکسچینج، ثبت سفارش برای دقایقی امکان پذیر نمی‌باشد
8- خطا در ثبت سفارش؛ حداقل ارزش سفارش ۱۰ تتر است.
9- خطا در ثبت سفارش؛ حداقل ارزش سفارش ۱ میلیون ریال است.
9- قیمت نامعتبر است، در تعیین قیمت دقت کنید!
42- به دلیل مشکل فنی حساب شما قادر به ثبت سفارش نیستید. لطفا به پشتیبانی مراجعه کنید
20 شما احراز نشده‌اید
2 حداقل واریز ۱ میلیون ریال است
112 شماره همراه ارایه نشده یا اشتباه است. لطفا اطلاعات خود را از بخش احراز هویت تکمیل بفرمایید.
111 برای واریز نیاز به شماره همراه شما است لطفا اطلاعات خود را از بخش احراز هویت تکمیل بفرمایید.
12 برای این شبکه امکان ایجاد آدرس وجود ندارد
442 سفارش ثبت نشد لطفا بعد از چند لحظه دوباره تلاش کنید
442 موجودی شما کافی نمی‌باشد
311 کارت را انتخاب نکرده‌اید. در صورتی که نمی‌توانید کارت را انتخاب کنید اپلیکیشن خود را بروز کنید
14 برای ثبت درخواست ارتقا به سطح طلایی باید حداقل سه روز از اولین واریز ریال به مبلغ حداقل یک میلیون تومان شما گذشته باشد!

لیست استاتوس‌های داخلی رمزینکس

استاتوس توضیحات
100000 به دلیل به روزرسانی اکسچینج، ثبت سفارش برای دقایقی امکان پذیر نمی باشد
100001 به دلیل مشکل فنی حساب شما، قادر به ثبت سفارش نیستید. لطفا به پشتیبانی پیام دهید.
300000 ثبت سفارش موفق
300001 قیمت نمی‌تواند صفر یا منفی باشد
300002 مقدار نمی‌تواند منفی یا صفر باشد
300003 بازار معتبر نیست
300004 نوع معتبر نیست
300005 موجودی کافی نیست
300006 خطا در ثبت سفارش؛ حداقل ارزش سفارش 10 تتر است.
300007 خطا در ثبت سفارش؛ حداقل ارزش سفارش 1 میلیون ریال است.
300008 قیمت نامعتبر است، در تعیین قیمت دقت کنید!
300009 خطا در ثبت سفارش؛ لطفا مقادیر خود را چک کنید
300010 سفارش ثبت نشد لطفا بعد از چند لحظه دوباره تلاش کنید
300011 یک دقیقه ی دیگر امتحان کنید
300012 موقتا معامله در این بازار متوقف شده است
300013 موقتا حداقل سفارش در این بازار به X ریال تغییر کرده است.
300014 خطا در ثبت سفارش؛ حداقل ارزش سفارش 3 میلیون ریال است.
300015 خطا در ثبت سفارش
300500 لغو سفارش موفق
300501 سفارش معتبر نیست
300502 سفارش شما باز نیست و امکان کنسل ندارد (قبلا اجرا شده ی کامل و یا جزیی بوده و یا قبلا کنسل شده است)