مستندات API معاملات همتا به همتا (P2P) کوینکس

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

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

1. کاربران هدف

هر کاربری که تأیید هویت فروشنده معاملات همتا به همتا را در کوینکس تکمیل کرده باشد. اگر هنوز به عنوان فروشنده تأیید نشده‌اید، قبل از استفاده از خدمات API، باید در صفحه معاملات همتا به همتا برای وضعیت فروشنده P2P درخواست دهید.

2. کارایی اجرا و محتوا

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

3. ماژول‌های پشتیبانی شده

• مدیریت وضعیت فروشگاه معاملات همتا به همتا

• مدیریت آگهی‌های معاملات همتا به همتا

• لیست آگهی‌های کاربر در معاملات همتا به همتا

• لیست آگهی‌های بازار معاملات همتا به همتا

• لیست سفارش‌های معاملات همتا به همتا

• تغییر قیمت آگهی معاملات همتا به همتا

• داده‌های عمق بازار معاملات همتا به همتا

مستندات نقاط پایانی API معاملات همتا به همتا

لطفاً قبل از استفاده از نقاط پایانی زیر، برای احراز هویت به مستندات API عمومی کوینکس مراجعه کنید.

1. مدیریت وضعیت فروشگاه معاملات همتا به همتا

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/exchange-status

• روش درخواست: POST

• توضیحات: تنظیم وضعیت کسب و کار فروشگاه معاملات همتا به همتا (باز یا بسته)

• مجوز: نیاز به احراز هویت دارد

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

بدنه درخواست

مثال درخواست

POST /v2/p2p/exchange-status HTTP/1.1
Host: api.coinex.com
Content-Type: application/json
{
  "status": "OPEN"
}

پارامترهای پاسخ

مثال پاسخ

{
  "code": 0,
  "message": "OK",
  "data": {
    "status": "OPEN"
  }
}

2. مدیریت آگهی‌های معاملات همتا به همتا

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/manage-ads

• روش درخواست: POST

• توضیحات: مدیریت دسته‌ای آگهی‌های معاملات همتا به همتا (آنلاین یا آفلاین)

• مجوز: نیاز به احراز هویت دارد

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

بدنه درخواست

نمونه درخواست

POST /v2/p2p/manage-ads HTTP/1.1
Host: api.coinex.com
Content-Type: application/json
{
  "status": "ONLINE",
  "ad_ids": ["5f7c8b9d1a2b3c4d5e6f7g8h", "5f7c8b9d1a2b3c4d5e6f7g9i"]
}

پارامترهای پاسخ

نمونه پاسخ

{
  "code": 0,
  "message": "OK",
  "data": {
    "affected_ad_ids": ["5f7c8b9d1a2b3c4d5e6f7g8h", "5f7c8b9d1a2b3c4d5e6f7g9i"]
  }
}

3. فهرست تبلیغات کاربر P2P

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/ads

• روش درخواست: GET

• توضیح: دریافت تمامی تبلیغات کاربر فعلی

• دسترسی: نیازمند احراز هویت
  
   

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

ندارد

 

نمونه درخواست

GET /v2/p2p/ads HTTP/1.1

Host: api.coinex.com

پارامترهای پاسخ

هر شیء تبلیغ شامل فیلدهای زیر است:

نمونه پاسخ

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
      "created_at": 1618456789000,
      "updated_at": 1618456789000,
      "ad_number": "AD123456789",
      "ad_side": "BUY",
      "base_ccy": "BTC",
      "quote_ccy": "CNY",
      "price": "200000",
      "available_amount": "0.5",
      "quote_min_limit": "500",
      "quote_max_limit": "50000",
      "status": "ONLINE"
    },
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g9i",
      "created_at": 1618456790000,
      "updated_at": 1618456790000,
      "ad_number": "AD123456790",
      "ad_side": "SELL",
      "base_ccy": "ETH",
      "quote_ccy": "CNY",
      "price": "10000",
      "available_amount": "5",
      "quote_min_limit": "200",
      "quote_max_limit": "20000",
      "status": "OFFLINE"
    }
  ]
}

 

4. لیست آگهی‌های بازار P2P

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/market/ads

• روش درخواست: GET

• توضیحات: دریافت لیست آگهی‌های بازار P2P

• مجوز: احراز هویت نیاز نیست

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

پارامترهای پرس و جو

نمونه درخواست

GET /v2/p2p/market/ads?base_ccy=BTC&quote_ccy=CNY&order_side=BUY&page=1&limit=10 HTTP/1.1

Host: api.coinex.com

پارامترهای پاسخ

نمونه پاسخ

{
  "code": 0,
  "message": "OK",
  "data": [
        {
            "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
            "created_at": 1618456789000,
            "updated_at": 1618456789000,
            "ad_number": "AD123456789",
            "ad_side": "BUY",
            "base_ccy": "BTC",
            "quote_ccy": "CNY",
            "price": "200000",
            "available_amount": "0.5",
            "quote_min_limit": "500",
            "quote_max_limit": "50000",
            "status": "ONLINE"
        },
    ],
    "pagination": {
      "total": 50,
      "has_next": true
    }
}

 

5. لیست سفارش‌های P2P

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/order

• روش درخواست: GET

• توضیحات: دریافت لیست سفارش‌های P2P کاربر

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

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

پارامترهای پرس و جو

مثال درخواست

GET /v2/p2p/order?start_time=1618456789000&end_time=1618556789000&status=CREATED&page=1&limit=10 HTTP/1.1

Host: api.coinex.com

پارامترهای پاسخ

هر شیء سفارش شامل فیلدهای زیر است:

مثال پاسخ

{
  "code": 0,
  "message": "OK",
  "data": [
      {
        "order_id": 12345,
        "order_num": "P2P123456789",
        "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
        "status": "FINISHED",
        "created_at": 1618456789000,
        "finished_at": 1618466789000,
        "confirm_due_at": 1618476789000,
        "payment_due_at": 1618486789000,
        "order_side": "BUY",
        "price": "200000",
        "base_ccy": "BTC",
        "base_ccy_amount": "0.1",
        "quote_ccy": "CNY",
        "quote_ccy_amount": "20000",
        "cancel_type": ""
      },
    ],
    "pagination": {
      "total": 25,
      "has_next": true
    }
}

 

6. تغییر قیمت آگهی P2P

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/modify-ads

• روش درخواست: POST

• توضیحات: تغییر دسته‌ای قیمت‌های آگهی P2P

• مجوز: نیاز به احراز هویت دارد

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

بدنه درخواست

هر عنصر در آرایه ads شامل فیلدهای زیر است:

مثال درخواست

POST /v2/p2p/modify-ads HTTP/1.1
Host: api.coinex.com
Content-Type: application/json
{
  "ads": [
    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
      "price": "210000"
    },


    {
      "ad_id": "5f7c8b9d1a2b3c4d5e6f7g9i",
      "price": "11000"
    }
  ]
}

پارامترهای پاسخ

پاسخ آرایه‌ای از نتایج برای هر آگهی تغییر یافته را برمی‌گرداند. هر عنصر شامل فیلدهای زیر است:

مثال پاسخ

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "code": 0,
      "message": "OK",
      "data": {
        "ad_id": "5f7c8b9d1a2b3c4d5e6f7g8h",
        "created_at": 1618456789000,
        "updated_at": 1618556789000,
        "ad_number": "AD123456789",
        "ad_side": "BUY",
        "base_ccy": "BTC",
        "quote_ccy": "CNY",
        "price": "210000",
        "available_amount": "0.5",
        "quote_min_limit": "500",
        "quote_max_limit": "50000",
        "status": "ONLINE"
      }
    },
    {
      "code": 11002,
      "message": "adv not exists",
      "data": null
    }
  ]
}

 

7. داده‌های عمق بازار P2P

اطلاعات نقطه پایانی

• مسیر URL: /v2/p2p/market/depth

• روش درخواست: GET

• توضیحات: دریافت داده‌های عمق بازار P2P

• مجوز: احراز هویت نیاز نیست

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

پارامترهای پرس‌وجو

مثال درخواست

GET /v2/p2p/market/depth?base_ccy=BTC&quote_ccy=CNY HTTP/1.1

Host: api.coinex.com

پارامترهای پاسخ

هر عنصر در آرایه‌های عمق شامل فیلدهای زیر است:

مثال پاسخ

{
  "code": 0,
  "message": "OK",
  "data": {
    "base_ccy": "BTC",
    "quote_ccy": "CNY",
    "index_price": "200000",
    "depth": {
      "bids": [
        {
          "price": "199000",
          "amount": "1.5",
        },
        {
          "price": "198000",
          "amount": "2.0",
        }
      ],
      "asks": [
        {
          "price": "201000",
          "amount": "1.0",
        },
        {
          "price": "202000",
          "amount": "1.8",
        },
      ]
    }
  }
}