Skip to content

Latest commit

 

History

History
2485 lines (2058 loc) · 69.7 KB

Public-Spot-API-en.md

File metadata and controls

2485 lines (2058 loc) · 69.7 KB
Raw

Table of Contents

Phemex Public API

General Public API Information

  • Phemex provides HTTP Rest API for client to operate Orders, all endpoints return a JSON object.
  • The default Rest API base endpoint is: https://api.phemex.com. The High rate limit Rest API base endpoint is: https://vapi.phemex.com. Or for the testnet is: https://testnet-api.phemex.com
  • Phemex provides WebSocket API for client to receive market data, order and position updates.
  • The WebSocket API url is: wss://phemex.com/ws. The High rate limit WebSocket API url is: wss: //vapi.phemex.com/ws. Or for the testnet is: wss://testnet.phemex.com/ws

REST API Standards

Restful API Response

HTTP Return Codes

  • HTTP 401 return code is used when unauthenticated
  • HTTP 403 return code is used when lack of priviledge.
  • HTTP 429 return code is used when breaking a request rate limit.
  • HTTP 5XX return codes are used for Phemex internal errors. Note: This doesn't means the operation failed, the execution status is UNKNOWN and could be Succeed.

Rest Response format

  • All restful API except starting with /md shares same response format.
{
  "code": <code>,
  "msg": <msg>,
  "data": <data>
}
Field Description
code 0 means success, non-zero means error
msg when code is non-zero, it gives short error description
data operation dependant

Error codes

Trading Error Codes

HTTP REST Request Header

Every HTTP Rest Request must have the following Headers:

  • x-phemex-access-token : This is API-KEY (id field) from Phemex site.
  • x-phemex-request-expiry : This describes the Unix EPoch SECONDS to expire the request, normally it should be ( Now() + 1 minute)
  • x-phemex-request-signature : This is HMAC SHA256 signature of the http request. Secret is API Secret, its formula is : HMacSha256( URL Path + QueryString + Expiry + body )

Optional Headers:

  • x-phemex-request-tracing: a unique string to trace http-request, less than 40 bytes. This header is a must in resolving latency issues.

API Rate Limits

X-RateLimit-Remaining-SPOTORDER, # Remaining request permits in this minute
X-RateLimit-Capacity-SPOTORDER, # Request ratelimit capacity
X-RateLimit-Retry-After-SPOTORDER, # Reset timeout in seconds for current ratelimited user

Endpoint security type

  • Each API call must be signed and pass to server in HTTP header x-phemex-request-signature.
  • Endpoints use HMAC SHA256 signatures. The HMAC SHA256 signature is a keyed HMAC SHA256 operation. Use your apiSecret as the key and the string URL Path + QueryString + Expiry + body ) as the value for the HMAC operation.
  • apiSecret = Base64::urlDecode(API Secret)
  • The signature is case sensitive.

Signature Example 1: HTTP GET Request

Singature Example 2: HTTP GET Request with multiple query string

Signature Example 3: HTTP POST Request

  • API REST Request URL: https://api.phemex.com/spot/orders
    • Request Path: /spot/orders
    • Request Query:
    • Request Body:
    {"symbol":"sBTCUSDT","clOrdID":"ece0187f-7e02-44b5-a778-404125f124fa","side":"Buy","qtyType":"ByBase","quoteQtyEv":"0","baseQtyEv":"100000","priceEp":"700000000","stopPxEp":"0","execInst":"","ordType":"Limit","timeInForce":"","text":""}
    • Request Expiry: 1587552407
    • signed string is
     /spot/orders1587552407{"symbol":"sBTCUSDT","clOrdID":"ece0187f-7e02-44b5-a778-404125f124fa","side":"Buy","qtyType":"ByBase","quoteQtyEv":"0","baseQtyEv":"100000","priceEp":"700000000","stopPxEp":"0","execInst":"","ordType":"Limit","timeInForce":"","text":""}

Request/response field explained

Spot Currency and Symbols

  • Spot symbol and its scale factor

All spot symbols use the same price and ratio scale factors (price scale facor(Ep) = 8, ratio scale factor(Er) = 8).

See all spot trading products for details.

Common constants

  • order type
order type description
Limit --
Market --
Stop --
StopLimit --
MarketIfTouched --
LimitIfTouched --
MarketAsLimit --
StopAsLimit --
MarketIfTouchedAsLimit --
  • order Status
order status description
Untriggered Conditional order waiting to be triggered
Triggered Conditional order being triggered
Rejected Order rejected
New Order placed in cross engine
PartiallyFilled Order partially filled
Filled Order fully filled
Canceled Order canceled
  • TimeInForce
timeInForce description
GoodTillCancel --
PostOnly --
ImmediateOrCancel --
FillOrKill --
  • Trigger source
trigger description
ByLastPrice trigger by last price

REST API List

Market API List

Query Product Information

  • Request：
GET /public/products

Market Data API List

Query Order Book

  • Request：
GET /md/orderbook?symbol=<symbol>
Field Type Description Possible values
symbol String symbol name Trading symbols
  • Response:
{
  "error": null,
  "id": 0,
  "result": {
    "book": {
      "asks": [
        [
          <priceEp>,
          <size>
        ],
        ...
        ...
        ...
      ],
      "bids": [
        [
          <priceEp>,
          <size>
        ],
        ...
        ...
        ...
      ],
    ]
    },
    "depth": 30,
    "sequence": <sequence>,
    "timestamp": <timestamp>,
    "symbol": "<symbol>",
    "type": "snapshot"
  }
}
Field Type Description Possible values
timestamp Integer Timestamp in nanoseconds
priceEp Integer Scaled book level price
size Integer Scaled book level size
sequence Integer current message sequence
symbol String Spot symbol name Trading symbols
  • Sample：
GET /md/orderbook?symbol=sBTCUSDT

{
  "error": null,
  "id": 0,
  "result": {
    "book": {
      "asks": [
        [
          877050000000,
          1000000
        ],
        [
          877100000000,
          200000
        ]
      ],
      "bids": [
        [
          877000000000,
          2000000
        ],
        [
          876950000000,
          200000
        ]
      ]
    },
    "depth": 30,
    "sequence": 455476965,
    "timestamp": 1583555482434235628,
    "symbol": "sBTCUSDT",
    "type": "snapshot"
  }
}

Query Recent Trades

  • Request：
GET /md/trade?symbol=<symbol>
Field Type Description Possible values
symbol String symbol name Trading symbols
  • Response:
{
  "error": null,
  "id": 0,
  "result": {
    "type": "snapshot",
    "sequence": <sequence>,
    "symbol": "<symbol>",
    "trades": [
      [
        <timestamp>,
        "<side>",
        <priceEp>,
        <size>
      ],
      ...
      ...
      ...
    ]
  }
}
Field Type Description Possible values
timestamp Integer Timestamp in nanoseconds
side String Trade side string Buy, Sell
priceEp Integer Scaled trade price
size Integer Scaled trade size
sequence Integer Current message sequence
symbol String Spot symbol name Trading symbols
  • Sample：
GET /md/trade?symbol=sBTCUSDT

{
  "error": null,
  "id": 0,
  "result": {
    "sequence": 15934323,
    "symbol": "sBTCUSDT",
    "trades": [
      [
        1579164056368538508,
        "Sell",
        869600000000,
        1210000
      ],
      [
        1579164055036820552,
        "Sell",
        869600000000,
        580000
      ]
    ],
    "type": "snapshot"
  }
}

Query 24 Hours Ticker

  • Request：
GET /md/spot/ticker/24hr?symbol=<symbol>
Field Type Description Possible values
symbol String symbol name Trading symbols
  • Response:
{
  "error": null,
  "id": 0,
  "result": {
    "openEp": <open priceEp>,
    "highEp": <high priceEp>,
    "lowEp": <low priceEp>,
    "lastEp": <last priceEp>,
    "bidEp": <bid priceEp>,
    "askEp": <ask priceEp>,
    "symbol": "<symbol>",
    "turnoverEv": <turnoverEv>,
    "volumeEv": <volumeEv>,
    "timestamp": <timestamp>
  }
}
Field Type Description Possible values
open priceEp Integer The scaled open price in last 24 hours
high priceEp Integer The scaled highest price in last 24 hours
low priceEp Integer The scaled lowest price in last 24 hours
last priceEp Integer The scaled last price
bid priceEp Integer Scaled bid price
ask priceEp Integer Scaled ask price
timestamp Integer Timestamp in nanoseconds
symbol String symbol name Trading symbols
turnoverEv Integer The scaled turnover value in last 24 hours
volumeEv Integer The scaled trade volume in last 24 hours
  • Sample：
GET /md/spot/ticker/24hr?symbol=sBTCUSDT

{
  "error": null,
  "id": 0,
  "result": {
    "askEp": 892100000000,
    "bidEp": 891835000000,
    "highEp": 898264000000,
    "lastEp": 892486000000,
    "lowEp": 870656000000,
    "openEp": 896261000000,
    "symbol": "sBTCUSDT",
    "timestamp": 1590571240030003249,
    "turnoverEv": 104718804814499,
    "volumeEv": 11841148100
  }
}

Market Data API List

Query Order Book

  • Request：
GET /v1/md/orderbook?symbol=<symbol>
Field Type Description Possible values
symbol String Spot symbol name Trading symbols
  • Response:
{
  "error": null,
  "id": 0,
  "result": {
    "book": {
      "asks": [
        [
          <priceEp>,
          <size>
        ],
        ...
        ...
        ...
      ],
      "bids": [
        [
          <priceEp>,
          <size>
        ],
        ...
        ...
        ...
      ],
    ]
    },
    "depth": 30,
    "sequence": <sequence>,
    "symbol": "<symbol>",
    "timestamp": "<timestamp>",
    "type": "snapshot"
  }
}
Field Type Description Possible values
timestamp Integer Timestamp in nanoseconds
priceEp Integer Scaled book level price
size Integer Scaled book level size
sequence Integer current message sequence
symbol String Spot symbol name Trading symbols
  • Sample：
GET /v1/md/orderbook?symbol=sBTCUSDT

{
  "error": null,
  "id": 0,
  "result": {
    "book": {
      "asks": [
        [
          87705000000,
          1000000
        ],
        [
          87710000000,
          200000
        ]
      ],
      "bids": [
        [
          877000000000,
          2000000
        ],
        [
          876950000000,
          200000
        ]
      ]
    },
    "depth": 30,
    "sequence": 455476965,
    "symbol": "sBTCUSDT",
    "timestamp": 1583552267253988998,
    "type": "snapshot"
  }
}

Spot Trading Api List

  • Http Request:
PUT /spot/orders/create?symbol=<symbol>&trigger=<trigger>&clOrdID=<clOrdID>&priceEp=<priceEp>&baseQtyEv=<baseQtyEv>&quoteQtyEv=<quoteQtyEv>&stopPxEp=<stopPxEp>&text=<text>&side=<side>&qtyType=<qtyType>&ordType=<ordType>&timeInForce=<timeInForce>&execInst=<execInst>
Field Type Required Description Possible values
symbol String Yes Spot Trading symbols
side Enum Yes Sell, Buy
qtyType Enum Yes default ByBase ByBase, ByQuote
quoteQtyEv Number -- Required when qtyType = ByQuote
baseQtyEv Number -- Required when qtyType = ByBase
priceEp Number Scaled price
stopPxEp Number -- used in conditional order
trigger Enum -- Required in conditional order ByLastPrice
timeInForce Enum No Default GoodTillCancel GoodTillCancel, PostOnly,ImmediateOrCancel,FillOrKill
ordType Enum No Default to Limit Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched
  • Http Response
{
  "code": 0,
  "msg": "",
  "data": {
    "orderID": "d1d09454-cabc-4a23-89a7-59d43363f16d",
    "clOrdID": "309bcd5c-9f6e-4a68-b775-4494542eb5cb",
    "priceEp": 0,
    "action": "New",
    "trigger": "UNSPECIFIED",
    "pegPriceType": "UNSPECIFIED",
    "stopDirection": "UNSPECIFIED",
    "bizError": 0,
    "symbol": "sBTCUSDT",
    "side": "Buy",
    "baseQtyEv": 0,
    "ordType": "Limit",
    "timeInForce": "GoodTillCancel",
    "ordStatus": "Created",
    "cumFeeEv": 0,
    "cumBaseQtyEv": 0,
    "cumQuoteQtyEv": 0,
    "leavesBaseQtyEv": 0,
    "leavesQuoteQtyEv": 0,
    "avgPriceEp": 0,
    "cumBaseAmountEv": 0,
    "cumQuoteAmountEv": 0,
    "quoteQtyEv": 0,
    "qtyType": "ByBase",
    "stopPxEp": 0,
    "pegOffsetValueEp": 0
  }
}

Place order

  • Http Request:
POST /spot/orders

{
  "symbol": "sBTCUSDT",
  "clOrdID": "",
  "side": "Buy/Sell",
  "qtyType": "ByBase/ByQuote",
  "quoteQtyEv": 0,
  "baseQtyEv": 0,
  "priceEp": 0,
  "stopPxEp": 0,
  "trigger": "UNSPECIFIED",
  "ordType": "Limit",
  "timeInForce": "GoodTillCancel"
}

Amend Order

  • Http Request
PUT /spot/orders?symbol=<symbol>&orderID=<orderID>&origClOrdID=<origClOrdID>&clOrdID=<clOrdID>&priceEp=<priceEp>&baseQtyEV=<baseQtyEV>&quoteQtyEv=<quoteQtyEv>&stopPxEp=<stopPxEp>

  • Http Response

    • amended order

Cancel Order

DELETE /spot/orders?symbol=<symbol>&orderID=<orderID>
DELETE /spot/orders?symbol=<symbol>&clOrdID=<clOrdID>
  • Http Response
    • Canceled order

Cancel all order by symbol

DELETE /spot/orders/all?symbol=<symbol>&untriggered=<untriggered>
Field Type Required Description
symbol Enum Yes The symbol to cancel
untriggered Boolean No set false to cancel non-conditiaonal order, true to conditional order
  • Http Response
    • Total orders canceled

Query Open order by clOrdID or orderID

  • Http Request
GET /spot/orders/active?symbol=<symbol>&orderID=<orderID>
GET /spot/orders/active?symbol=<symbol>&clOrDID=<clOrdID>

  • Http Response

    • Order object

Query all open orders by symbol

  • Http Request
GET /spot/orders?symbol=<symbol>
  • Http Response
    • List of orders

Query wallets

  • Query spot wallet by currency

  • Http Request

GET /spot/wallets?currency=<currency>
  • Http Response
{
  "code": 0,
  "msg": "",
  "data": [
    {
      "currency": "BTC",
      "balanceEv": 0,
      "lockedTradingBalanceEv": 0,
      "lockedWithdrawEv": 0,
      "lastUpdateTimeNs": 0
    }
  ]
}

Query spot closed orders

* Query closed orders by symbol

NOTE: deprecated, recommend Query Orders by IDs

  • Http Request
GET /exchange/spot/order?symbol=<symbol>&ordStatus=<ordStatus1,orderStatus2>ordType=<ordType1,orderType2>&start=<start>&end=<end>&limit=<limit>&offset=<offset>
Field Type Required Description Possible Values
symbol String Yes symbol to query Trading symbols
ordStatus enum No order status filter common constants for order status
ordType enum No order type filter common constants for order type
start integer No Epoch millisecond, start of time range within 3 month
end integer No Epoch millisecond, end of time range within 3 months

  • Http Response

    • return a list of spot order model.
{
  "code": 0,
  "msg": "OK",
  "data": {
    "total": 2,
    "rows": [
      {
        "orderID": "string",
        "stopPxEp": 0,
        "avgPriceEp": 0,
        "qtyType": "<ByQuote/ByBase>",
        "leavesBaseQtyEv": 0,
        "leavesQuoteQtyEv": 0,
        "baseQtyEv": "0",
        "feeCurrency": "string",
        "stopDirection": "UNSPECIFIED",
        "symbol": "string",
        "side": "enum",
        "quoteQtyEv": 0,
        "priceEp": 0,
        "ordType": "enum",
        "timeInForce": "enum",
        "ordStatus": "enum",
        "execStatus": "enum",
        "createTimeNs": 0,
        "cumFeeEv": 0,
        "cumBaseValueEv": 0,
        "cumQuoteValueEv": 0
      }
    ]
  }
}
  • Sample Response
{
  "code": 0,
  "msg": "OK",
  "data": {
    "total": 2,
    "rows": [
      {
        "orderID": "b2b7018d-f02f-4c59-b4cf-051b9c2d2e83",
        "stopPxEp": 0,
        "avgPriceEp": 970056000000,
        "qtyType": "ByQuote",
        "leavesBaseQtyEv": 0,
        "leavesQuoteQtyEv": 0,
        "baseQtyEv": "0",
        "feeCurrency": "1",
        "stopDirection": "UNSPECIFIED",
        "symbol": "sBTCUSDT",
        "side": "Buy",
        "quoteQtyEv": 1000000000,
        "priceEp": 970056000000,
        "ordType": "Limit",
        "timeInForce": "GoodTillCancel",
        "ordStatus": "Filled",
        "execStatus": "MakerFill",
        "createTimeNs": 1589449348601287000,
        "cumFeeEv": 0,
        "cumBaseValueEv": 103000,
        "cumQuoteValueEv": 999157680
      }
    ]
  }
}

Query spot history trades

  • Query spot history trades by symbol

NOTE: Deprecated, recommend Query Trades

  • Http Request
GET /exchange/spot/order/trades?symbol=<symbol>&start=<start>&end=<end>&limit=<limit>&offset=<offset>
Field Type Required Description Possible values
symbol string Yes symbol to query spot symbol list
start integer No Epoch millisecond, start of time range
end integer No Epoch millisecond, end of time range
  • Http Response
{
  "code": 0,
  "msg": "OK",
  "data": {
    "total": 1,
    "rows": [
      {
        "qtyType": "ByQuote/ByBase",
        "transactTimeNs": 0,
        "clOrdID": "string"
        "orderID": "string",
        "symbol": "string",
        "side": "enum",
        "priceEP": 0,
        "baseQtyEv": 0,
        "quoteQtyEv": 0,
        "action": "enum",
        "execStatus": "enum",
        "ordStatus": "enum",
        "ordType": "enum",
        "execInst": "enum",
        "timeInForce": "enum",
        "stopDirection": "enum",
        "tradeType": "enum",
        "stopPxEp": 0,
        "execId": "0",
        "execPriceEp": 0,
        "execBaseQtyEv": 0,
        "execQuoteQtyEv": 0,
        "leavesBaseQtyEv": 0,
        "leavesQuoteQtyEv": 0,
        "execFeeEv": 0,
        "feeRateEr": 0
      }
    ]
  }
}
  • Sample Response
{
  "code": 0,
  "msg": "OK",
  "data": {
    "total": 1,
    "rows": [
      {
        "qtyType": "ByQuote",
        "transactTimeNs": 1589450974800550100,
        "clOrdID": "8ba59d40-df25-d4b0-14cf-0703f44e9690",
        "orderID": "b2b7018d-f02f-4c59-b4cf-051b9c2d2e83",
        "symbol": "sBTCUSDT",
        "side": "Buy",
        "priceEP": 970056000000,
        "baseQtyEv": 0,
        "quoteQtyEv": 1000000000,
        "action": "New",
        "execStatus": "MakerFill",
        "ordStatus": "Filled",
        "ordType": "Limit",
        "execInst": "None",
        "timeInForce": "GoodTillCancel",
        "stopDirection": "UNSPECIFIED",
        "tradeType": "Trade",
        "stopPxEp": 0,
        "execId": "c6bd8979-07ba-5946-b07e-f8b65135dbb1",
        "execPriceEp": 970056000000,
        "execBaseQtyEv": 103000,
        "execQuoteQtyEv": 999157680,
        "leavesBaseQtyEv": 0,
        "leavesQuoteQtyEv": 0,
        "execFeeEv": 0,
        "feeRateEr": 0
      }
    ]
  }
}

Spot Asset API

Query deposit address by currency

  • Http Request
GET /exchange/wallets/v2/depositAddress?currency=<currency>&chainName=<chainName>
Field Type Required Description Possible Values
currency String True the currency to query BTC,ETH, USDT ...
chainName String True the chain for this currency BTC, ETH, EOS
  • chainName is provided by below currency settings interface.
GET /exchange/public/cfg/chain-settings?currency=<currency>
  • Response
{
  "address": "1Cdxxxxxxxxxxxxxx",
  "tag": null
}

Query recent deposit history within 3 months

  • Http Request
GET /exchange/wallets/depositList?currency=<currency>&offset=<offset>&limit=<limit>
Field Type Required Description Possible Values
currency String True the currency to query BTC,ETH, ...
  • Response
{
  "address": "1xxxxxxxxxxxxxxxxxx",
  "amountEv": 1000000,
  "confirmations": 1,
  "createdAt": 1574685871000,
  "currency": "BTC",
  "currencyCode": 1,
  "status": "Success",
  "txHash": "9e84xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "type": "Deposit"
}

Query recent withdraw history within 3 months

  • Http Request
GET /exchange/wallets/withdrawList?currency=<currency>&offset=<offset>&limit=<limit>
  • Response
{
  "address": "1Lxxxxxxxxxxx",
  "amountEv": 200000,
  "currency": "BTC",
  "currencyCode": 1,
  "expiredTime": 0,
  "feeEv": 50000,
  "rejectReason": null,
  "status": "Succeed",
  "txHash": "44exxxxxxxxxxxxxxxxxxxxxx",
  "withdrawStatus": ""
}

Spot Data Api List

Query Funds History

  • Http Request
GET /api-data/spots/funds?currency=<currency>
Field Type Required Description Possible Values
currency String True the currency to query BTC,ETH, USDT ...
start Long False start time in millisecond default 2 days ago from the end
end Long False end time in millisecond default now
offset Integer False page start from 0 start from 0, default 0
limit Integer False page size default 20, max 200
  • Response
[
  {
    "action": "string",
    "amountEv": 0,
    "balanceEv": 0,
    "bizCode": 0,
    "createTime": 0,
    "currency": "string",
    "execId": "string",
    "execSeq": 0,
    "feeEv": 0,
    "id": 0,
    "side": "string",
    "text": "string",
    "transactTimeNs": 0
  }
]

Query Orders History

  • Http Request
GET /api-data/spots/orders?symbol=<symbol>
Field Type Required Description Possible Values
symbol String True the currency to query sBTCUSDT ...
start Long False start time in millisecond default 2 days ago from the end
end Long False end time in millisecond default now
offset Integer False page start from 0 start from 0, default 0
limit Integer False page size default 20, max 200
  • Response
[
  {
    "avgPriceEp": 0,
    "avgTransactPriceEp": 0,
    "baseQtyEv": "string",
    "createTimeNs": 0,
    "cumBaseValueEv": 0,
    "cumFeeEv": 0,
    "cumQuoteValueEv": 0,
    "execStatus": "string",
    "feeCurrency": "string",
    "leavesBaseQtyEv": 0,
    "leavesQuoteQtyEv": 0,
    "ordStatus": "string",
    "ordType": "string",
    "orderID": "string",
    "priceEp": 0,
    "qtyType": "string",
    "quoteQtyEv": 0,
    "side": "string",
    "stopDirection": "string",
    "stopPxEp": 0,
    "symbol": "string",
    "timeInForce": "string"
  }
]

Query Orders By Ids

  • Http Request
GET /api-data/spots/orders/by-order-id?symbol=<symbol>&oderId=<orderID>&clOrdID=<clOrdID>
Field Type Required Description Possible Values
symbol String True the currency to query sBTCUSDT ...
orderID String False order id orderID and clOrdID can not be both empty. If both IDs are given, it will return orderID if there is any, otherwise will try to find clOrdID
clOrdID String False client order id refer to orderID
  • Response
[
  {
    "avgPriceEp": 0,
    "avgTransactPriceEp": 0,
    "baseQtyEv": "string",
    "createTimeNs": 0,
    "cumBaseValueEv": 0,
    "cumFeeEv": 0,
    "cumQuoteValueEv": 0,
    "execStatus": "string",
    "feeCurrency": "string",
    "leavesBaseQtyEv": 0,
    "leavesQuoteQtyEv": 0,
    "ordStatus": "string",
    "ordType": "string",
    "orderID": "string",
    "priceEp": 0,
    "qtyType": "string",
    "quoteQtyEv": 0,
    "side": "string",
    "stopDirection": "string",
    "stopPxEp": 0,
    "symbol": "string",
    "timeInForce": "string"
  }
]

Query PNLs

  • Http Request
GET /api-data/spots/pnls
Field Type Required Description Possible Values
start Long False start time in millisecond default 2 days ago from the end
end Long False end time in millisecond default now
  • Response
[
  {
    "collectTime": 0,
    "cumPnlEv": 0,
    "dailyPnlEv": 0,
    "userId": 0
  }
]

Query Trades History

  • Http Request
GET /api-data/spots/trades?symbol=<symbol>
Field Type Required Description Possible Values
symbol String True the currency to query sBTCUSDT ...
start Long False start time in millisecond default 2 days ago from the end
end Long False end time in millisecond default now
offset Integer False page start from 0 start from 0, default 0
limit Integer False page size default 20, max 200
  • Response
[
  {
    "action": "string",
    "baseCurrency": "string",
    "baseQtyEv": 0,
    "clOrdID": "string",
    "execBaseQtyEv": 0,
    "execFeeEv": 0,
    "execId": "string",
    "execInst": "string",
    "execPriceEp": 0,
    "execQuoteQtyEv": 0,
    "execStatus": "string",
    "feeCurrency": "string",
    "feeRateEr": 0,
    "leavesBaseQtyEv": 0,
    "leavesQuoteQtyEv": 0,
    "ordStatus": "string",
    "ordType": "string",
    "orderID": "string",
    "priceEP": 0,
    "qtyType": "string",
    "quoteCurrency": "string",
    "quoteQtyEv": 0,
    "side": "string",
    "stopDirection": "string",
    "stopPxEp": 0,
    "symbol": "string",
    "timeInForce": "string",
    "tradeType": "string",
    "transactTimeNs": 0
  }
]

Query Orders By Ids

  • Http Request
GET /api-data/spots/trades/by-order-id?symbol=<symbol>&oderId=<orderID>&clOrdID=<clOrdID>
Field Type Required Description Possible Values
symbol String True the currency to query sBTCUSDT ...
orderID String False order id orderID and clOrdID can not be both empty. If both IDs are given, it will return orderID if there is any, otherwise will try to find clOrdID
clOrdID String False client order id refer to orderID
  • Response
[
  {
    "action": "string",
    "baseCurrency": "string",
    "baseQtyEv": 0,
    "clOrdID": "string",
    "execBaseQtyEv": 0,
    "execFeeEv": 0,
    "execId": "string",
    "execInst": "string",
    "execPriceEp": 0,
    "execQuoteQtyEv": 0,
    "execStatus": "string",
    "feeCurrency": "string",
    "feeRateEr": 0,
    "leavesBaseQtyEv": 0,
    "leavesQuoteQtyEv": 0,
    "ordStatus": "string",
    "ordType": "string",
    "orderID": "string",
    "priceEP": 0,
    "qtyType": "string",
    "quoteCurrency": "string",
    "quoteQtyEv": 0,
    "side": "string",
    "stopDirection": "string",
    "stopPxEp": 0,
    "symbol": "string",
    "timeInForce": "string",
    "tradeType": "string",
    "transactTimeNs": 0
  }
]

Websocket API Standards

Session Management

  • Each client is required to actively send heartbeat (ping) message to Phemex data gateway ('DataGW' in short) with interval less than 30 seconds, otherwise DataGW will drop the connection. If a client sends a ping message, DataGW will reply with a pong message.
  • Clients can use WS built-in ping message or the application level ping message to DataGW as heartbeat. The heartbeat interval is recommended to be set as 5 seconds, and actively reconnect to DataGW if don't receive messages in 3 heartbeat intervals.

API Rate Limits

  • Each Client has concurrent connection limit to 5 in maximum.
  • Each connection has subscription limit to 20 in maximum.
  • Each connection has throttle limit to 20 request/s.

WebSocket API List

Heartbeat

  • Request：
{
  "id": <id>,
  "method": "server.ping",
  "params": []
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": "pong"
}
  • Sample：
> {
  "id": 1234,
  "method": "server.ping",
  "params": []
}

< {
  "error": null,
  "id": 1234,
  "result": "pong"
}

API User Authentication

Market trade/orderbook are published publicly without user authentication. While for client private account/position/order data, the client should send user.auth message to Data Gateway to authenticate the session.

  • Request
{
  "method": "user.auth",
  "params": [
    "API",
    "<token>",
    "<signature>",
    <expiry>
  ],
  "id": 1234
}
Field Type Description Possible values
type String Token type API
token String API Key
signature String Signature generated by a funtion as HMacSha256(API Key + expiry) with API Secret
expiry Integer A future time after which request will be rejected, in epoch second. Maximum expiry is request time plus 2 minutes
  • Sample:
> {
  "method": "user.auth",
  "params": [
    "API",
    "806066b0-f02b-4d3e-b444-76ec718e1023",
    "8c939f7a6e6716ab7c4240384e07c81840dacd371cdcf5051bb6b7084897470e",
    1570091232
  ],
  "id": 1234
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

Subscribe OrderBook

On each successful subscription, DataGW will immediately send the current Order Book snapshot to client and all later order book updates will be published. Incremental messages are published with depth=30 and 20ms interval.

  • Request
{
  "id": <id>,
  "method": "orderbook.subscribe",
  "params": [
    "<symbol>"
  ]
}
  • Response
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}
  • Sample：
> {
  "id": 1234,
  "method": "orderbook.subscribe",
  "params": [
    "sBTCUSDT"
  ]
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

Subscribe Full OrderBook

On each successful subscription, DataGW will immediately send the current Order Book snapshot to client and all later order book updates will be published. Incremental messages are published with full depth and 100ms interval.

  • Request
{
  "id": <id>,
  "method": "orderbook.subscribe",
  "params": [
    "<symbol>",
    true
  ]
}
  • Response
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}
  • Sample：
> {
  "id": 1234,
  "method": "orderbook.subscribe",
  "params": [
    "sBTCUSDT",
    true
  ]
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

OrderBook Message:

DataGW publishes order book message with types: incremental, snapshot. And snapshot messages are published with 60-second interval for client self-verification.

  • Message Format：
{
  "book": {
    "asks": [
      [
        <priceEp>,
        <qty>
      ],
      .
      .
      .
    ],
    "bids": [
      [
        <priceEp>,
        <qty>
      ],
      .
      .
      .
    ]
  },
  "depth": <depth>,
  "sequence": <sequence>,
  "timestamp": <timestamp>,
  "symbol": "<symbol>"
}
Field Type Description Possible values
side String Price level side bid, ask
priceEp Integer Scaled price
qty Integer Price level size. Non-zero qty indicates price level insertion or updation, and qty 0 indicates price level deletion.
sequence Integer Latest message sequence
depth Integer Market depth 30
type String Message type snapshot, incremental
  • Sample：
< {"book":{"asks":[[892697000000,1781800],[892708000000,7543500],[892718000000,6552500],[892720000000,4714100],[892728000000,8431000],[892735000000,11644800],[892756000000,5909600],[892790000000,9053100],[892798000000,3336400],[892819000000,1689500],[892828000000,1616700],[892855000000,6484000],[892869000000,6873200],[892872000000,1919900],[892875000000,2373200],[892942000000,1875300],[892944000000,3117500],[892962000000,1353500],[892965000000,2589800],[892966000000,11169800],[892973000000,7829700],[892977000000,2697200],[892978000000,2110700],[892985000000,12563700],[892988000000,5374100],[893023000000,3816000],[893031000000,5852700],[893035000000,4990900],[893061000000,3479500],[893083000000,327900]],"bids":[[892376000000,6866500],[892354000000,14209000],[892353000000,5287200],[892348000000,6417800],[892340000000,8074400],[892334000000,3991900],[892303000000,4558000],[892295000000,10154700],[892280000000,16214500],[892277000000,11425300],[892270000000,39156500],[892268000000,13821100],[892260000000,32157500],[892257000000,5466100],[892252000000,11468700],[892241000000,13940300],[892226000000,33832300],[892220000000,3000000],[892171000000,4320400],[892165000000,4454000],[892152000000,5336400],[892144000000,4539200],[892134000000,7472200],[892127000000,5352700],[892087000000,10264400],[892082000000,4908000],[892038000000,1485500],[892031000000,4089200],[892030000000,4895500],[892014000000,3846600]]},"depth":30,"sequence":677996311,"symbol":"sBTCUSDT","timestamp":1590570810187570850,"type":"snapshot"}
< {"book":{"asks":[[892696000000,1669700],[892697000000,10455500],[892728000000,0],[892735000000,0],[892748000000,1550900],[892790000000,0],[892819000000,19087900],[892860000000,17152500],[892882000000,11546100],[892893000000,10986500],[892973000000,0],[892985000000,0],[893004000000,8306500],[893061000000,0],[893065000000,5446400],[893073000000,0],[893083000000,0],[893073000000,0],[893083000000,0]],"bids":[]},"depth":30,"sequence":677996548,"symbol":"sBTCUSDT","timestamp":1590570810819505422,"type":"incremental"}
< {"book":{"asks":[],"bids":[[892387000000,4792900],[892354000000,3170700],[892226000000,0],[892187000000,14425000],[892171000000,6366500],[892165000000,0],[892135000000,11511400],[892134000000,0],[892127000000,0],[892090000000,5446000],[892079000000,4687800],[892041000000,8590200],[892030000000,0],[892014000000,0]]},"depth":30,"sequence":677996941,"symbol":"sBTCUSDT","timestamp":1590570811244188841,"type":"incremental"}

Unsubscribe OrderBook

It unsubscribes all orderbook related subscriptions.

  • Request
{
  "id": <id>,
  "method": "orderbook.unsubscribe",
  "params": []
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}

Subscribe Trade

On each successful subscription, DataGW will send the 200 history trades immediately for the subscribed symbol and all the later trades will be published.

  • Request
{
  "id": <id>,
  "method": "trade.subscribe",
  "params": [
    "<symbol>"
  ]
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}
  • Sample:
> {
  "id": 1234,
  "method": "trade.subscribe",
  "params": [
    "sBTCUSDT"
  ]
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

Trade Message Format：

DataGW publishes trade message with types: incremental, snapshot. Incremental messages are published with 20ms interval. And snapshot messages are published on connection initial setup for client recovery.

{
  "trades": [
    [
      <timestamp>,
      "<side>",
      <priceEp>,
      <qty>
    ],
    .
    .
    .
  ],
  "sequence": <sequence>,
  "symbol": "<symbol>",
  "type": "<type>"
}
Field Type Description Possible values
timestamp Integer Timestamp in nanoseconds for each trade
side String Execution taker side bid, ask
priceEp Integer Scaled execution price
qty Integer Execution size
sequence Integer Latest message sequence
symbol String Spot symbol name
type String Message type snapshot, incremental
  • Sample
< {
  "sequence": 1167852,
  "symbol": "sBTCUSDT",
  "trades": [
    [
      1573716998128563500,
      "Buy",
      867350000000,
      560000
    ],
    [
      1573716995033683000,
      "Buy",
      867350000000,
      520000
    ],
    [
      1573716991485286000,
      "Buy",
      867350000000,
      510000
    ],
    [
      1573716988636291300,
      "Buy",
      867350000000,
      120000
    ]
  ],
  "type": "snapshot"
}

< {
  "sequence": 1188273,
  "symbol": "sBTCUSDT",
  "trades": [
    [
      1573717116484024300,
      "Buy",
      86730000000,
      210000
    ]
  ],
  "type": "incremental"
}

Unsubscribe Trade

It unsubscribes all trade subscriptions.

  • Request
{
  "id": <id>,
  "method": "trade.subscribe",
  "params": [
    "<symbol>"
  ]
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}

Subscribe Kline

On each successful subscription, DataGW will send the 1000 history klines immediately for the subscribed symbol and all the later kline update will be published in real-time.

  • Request
{
  "id": <id>,
  "method": "kline.subscribe",
  "params": [
    "<symbol>",
    "<interval>"
  ]
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}
  • Sample:
# subscribe 1-day kline
> {
  "id": 1234,
  "method": "kline.subscribe",
  "params": [
    "sBTCUSDT",
    86400
  ]
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

Kline Message Format：

DataGW publishes kline message with types: incremental, snapshot. Incremental messages are published with 20ms interval. And snapshot messages are published on connection initial setup for client recovery.

{
  "kline": [
    [
      <timestamp>,
      "<interval>",
      <lastCloseEp>,
      <openEp>,
      <highEp>,
      <lowEp>,
      <closeEp>,
      <volumeEv>,
      <turnoverEv>,
    ],
    .
    .
    .
  ],
  "sequence": <sequence>,
  "symbol": "<symbol>",
  "type": "<type>"
}
Field Type Description Possible values
timestamp Integer Timestamp in nanoseconds for each trade
interval Integer Kline interval type 60, 300, 900, 1800, 3600, 14400, 86400, 604800, 2592000, 7776000, 31104000
lastCloseEp Integer Scaled last close price
openEp Integer Scaled open price
highEp Integer Scaled high price
lowEp Integer Scaled low price
closeEp Integer Scaled close price
volumeEv Integer Scaled trade voulme during the current kline interval
turnoverEv Integer Scaled turnover value
sequence Integer Latest message sequence
symbol String Contract symbol name
type String Message type snapshot, incremental
  • Sample
< {
  "kline": [
    [
      1590019200,
      86400,
      952057000000,
      952000000000,
      955587000000,
      947835000000,
      954446000000,
      1162621600,
      11095452729869
    ],
    [
      1589932800,
      86400,
      977566000000,
      978261000000,
      984257000000,
      935452000000,
      952057000000,
      11785486656,
      113659374080189
    ],
    [
      1589846400,
      86400,
      972343000000,
      972351000000,
      989607000000,
      949106000000,
      977566000000,
      11337554900,
      109928494593609
    ]
  ],
  "sequence": 380876982,
  "symbol": "sBTCUSDT",
  "type": "snapshot"
}

< {
  "kline": [
    [
      1590019200,
      86400,
      952057000000,
      952000000000,
      955587000000,
      928440000000,
      941597000000,
      4231329700,
      40057408967508
    ]
  ],
  "sequence": 396865028,
  "symbol": "sBTCUSDT",
  "type": "incremental"
}

Unsubscribe Kline

It unsubscribes all kline subscriptions or for a symbol.

  • Request
# unsubscribe all Kline subscriptions
{
  "id": <id>,
  "method": "kline.unsubscribe",
  "params": []
}

# unsubscribe all Kline subscriptions of a symbol
{
  "id": <id>,
  "method": "kline.unsubscribe",
  "params": [
    "<symbol>"
  ]
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}

Subscribe Wallet-Order messages

WO subscription requires the session been authorized successfully. DataGW extracts the user information from the given token and sends WO messages back to client accordingly. 0 or more latest WO snapshot messages will be sent to client immediately on subscription, and incremental messages will be sent for later updates. Each account snapshot contains a users' wallets and open / max 100 closed / max 100 filled order event message history.

  • Request
{
  "id": <id>,
  "method": "wo.subscribe",
  "params": [
    "close/fills limits(default 0, means max 100)
  ]
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}
  • Sample
> {
  "id": 1234,
  "method": "wo.subscribe",
  "params": []
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

Wallet-Order Message Sample:

{"wallets":[],"orders":[{"userID":60463,...}],"sequence":11450, "timestamp":<timestamp>, "type":"<type>"}
Field Type Description Possible values
timestamp Integer Transaction timestamp in nanoseconds
sequence Integer Latest message sequence
type String Message type snapshot, incremental
  • Sample:
< {"orders":{"closed":[{"action":"New","avgPriceEp":0,"baseCurrency":"BTC","baseQtyEv":10000,"bizError":0,"clOrdID":"123456","createTimeNs":1587463924959744646,"cumBaseQtyEv":10000,"cumFeeEv":0,"cumQuoteQtyEv":66900000,"curBaseWalletQtyEv":899990000,"curQuoteWalletQtyEv":66900000,"cxlRejReason":0,"feeCurrency":"BTC","leavesBaseQtyEv":0,"leavesQuoteQtyEv":0,"ordStatus":"Filled","ordType":"Limit","orderID":"35217ade-3c6b-48c7-a280-8a1edb88013e","pegOffsetValueEp":0,"priceEp":68000000,"qtyType":"ByBase","quoteCurrency":"USDT","quoteQtyEv":66900000,"side":"Sell","stopPxEp":0,"symbol":"sBTCUSDT","timeInForce":"GoodTillCancel","transactTimeNs":1587463924964876798,"triggerTimeNs":0,"userID":200076}],"fills":[{"avgPriceEp":0,"baseCurrency":"BTC","baseQtyEv":10000,"clOrdID":"123456","execBaseQtyEv":10000,"execFeeEv":0,"execID":"8135ebe3-f767-577b-b70d-1a839d5178e0","execPriceEp":669000000000,"execQuoteQtyEv":66900000,"feeCurrency":"BTC","lastLiquidityInd":"RemovedLiquidity","ordType":"Limit","orderID":"35217ade-3c6b-48c7-a280-8a1edb88013e","priceEp":68000000,"qtyType":"ByBase","quoteCurrency":"USDT","quoteQtyEv":66900000,"side":"Sell","symbol":"sBTCUSDT","transactTimeNs":1587463924964876798,"userID":200076}],"open":[{"action":"New","avgPriceEp":0,"baseCurrency":"BTC","baseQtyEv":100000000,"bizError":0,"clOrdID":"31f793f4-163d-aa3f-5994-0e1164719ba2","createTimeNs":1587547657438535949,"cumBaseQtyEv":0,"cumFeeEv":0,"cumQuoteQtyEv":0,"curBaseWalletQtyEv":630000005401500000,"curQuoteWalletQtyEv":351802500000,"cxlRejReason":0,"feeCurrency":"BTC","leavesBaseQtyEv":100000000,"leavesQuoteQtyEv":0,"ordStatus":"New","ordType":"Limit","orderID":"b98b25c5-6aa4-4158-b9e5-477e37bd46d8","pegOffsetValueEp":0,"priceEp":666500000000,"qtyType":"ByBase","quoteCurrency":"USDT","quoteQtyEv":0,"side":"Sell","stopPxEp":0,"symbol":"sBTCUSDT","timeInForce":"GoodTillCancel","transactTimeNs":1587547657442752950,"triggerTimeNs":0,"userID":200076}]},"sequence":349,"timestamp":1587549121318737606,"type":"snapshot","wallets":[{"balanceEv":0,"currency":"LTC","lastUpdateTimeNs":1587481897840503662,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":351802500000,"currency":"USDT","lastUpdateTimeNs":1587543489127498121,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":630000005401500000,"currency":"BTC","lastUpdateTimeNs":1587547210089640382,"lockedTradingBalanceEv":100000000,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":0,"currency":"ETH","lastUpdateTimeNs":1587481897840503662,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":0,"currency":"XRP","lastUpdateTimeNs":1587481897840503662,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":0,"currency":"LINK","lastUpdateTimeNs":1587481897840503662,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":0,"currency":"XTZ","lastUpdateTimeNs":1587481897840503662,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076}]}
< {"orders":{"closed":[],"fills":[],"open":[{"action":"New","avgPriceEp":0,"baseCurrency":"BTC","baseQtyEv":100000000,"bizError":0,"clOrdID":"0c1099e5-b900-5351-cf60-edb15ea2539c","createTimeNs":1587549529513521745,"cumBaseQtyEv":0,"cumFeeEv":0,"cumQuoteQtyEv":0,"curBaseWalletQtyEv":630000005401500000,"curQuoteWalletQtyEv":351802500000,"cxlRejReason":0,"feeCurrency":"BTC","leavesBaseQtyEv":100000000,"leavesQuoteQtyEv":0,"ordStatus":"New","ordType":"Limit","orderID":"494a6cbb-32b3-4d6a-b9b7-196ea2506fb5","pegOffsetValueEp":0,"priceEp":666500000000,"qtyType":"ByBase","quoteCurrency":"USDT","quoteQtyEv":0,"side":"Sell","stopPxEp":0,"symbol":"sBTCUSDT","timeInForce":"GoodTillCancel","transactTimeNs":1587549529518394235,"triggerTimeNs":0,"userID":200076}]},"sequence":350,"timestamp":1587549529519959388,"type":"incremental","wallets":[{"balanceEv":630000005401500000,"currency":"BTC","lastUpdateTimeNs":1587547210089640382,"lockedTradingBalanceEv":200000000,"lockedWithdrawEv":0,"userID":200076},{"balanceEv":351802500000,"currency":"USDT","lastUpdateTimeNs":1587543489127498121,"lockedTradingBalanceEv":0,"lockedWithdrawEv":0,"userID":200076}]}

Unsubscribe Wallet-Order

  • Request：
{
  "id": <id>,
  "method": "wo.unsubscribe",
  "params": []
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}

Subscribe 24 Hours Ticker

On each successful subscription, DataGW will publish 24-hour ticker metrics for all symbols every 1 second.

  • Request
{
  "id": <id>,
  "method": "spot_market24h.subscribe",
  "params": []
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
    "status": "success"
  }
}
  • Sample:
> {
  "method": "spot_market24h.subscribe",
  "params": [],
  "id": 1234
}

< {
  "error": null,
  "id": 1234,
  "result": {
    "status": "success"
  }
}

Hours Ticker Message Format：

{
  "spot_market24h": {
    "openEp": <open priceEp>,
    "highEp": <high priceEp>,
    "lowEp": <low priceEp>,
    "lastEp": <last priceEp>,
    "bidEp": <bid priceEp>,
    "askEp": <ask priceEp>,
    "symbol": "<symbol>",
    "turnoverEv": <turnoverEv>,
    "volumeEv": <volumeEv>
  },
  "timestamp": <timestamp>
}
Field Type Description Possible values
open priceEp Integer The scaled open price in last 24 hours
high priceEp Integer The scaled highest price in last 24 hours
low priceEp Integer The scaled lowest price in last 24 hours
last priceEp Integer The scaled last price
bid priceEp Integer Scaled bid price
ask priceEp Integer Scaled ask price
timestamp Integer Timestamp in nanoseconds
symbol String Spot Symbol name Trading symbols
turnoverEv Integer The scaled turnover value in last 24 hours
volumeEv Integer The scaled trade volume in last 24 hours
  • Sample:
< {
  "spot_market24h": {
    "askEp": 892100000000,
    "bidEp": 891835000000,
    "highEp": 898264000000,
    "lastEp": 892486000000,
    "lowEp": 870656000000,
    "openEp": 896261000000,
    "symbol": "sBTCUSDT",
    "timestamp": 1590571240030003249,
    "turnoverEv": 104718804814499,
    "volumeEv": 11841148100
  },
  "timestamp": 1576490244024818000
}

All Spot trading currencies

currency value scale factor min value max value need addr arg
BTC 8 1 5e+18 0
USDT 8 1 5e+18 0
ETH 8 1 5e+18 0
XRP 8 1 5e+18 1
LINK 8 1 5e+18 0
XTZ 8 1 5e+18 0
LTC 8 1 5e+18 0
ADA 8 1 5e+18 0
TRX 8 1 5e+18 0
ONT 8 1 5e+18 0
BCH 8 1 5e+18 0
NEO 8 1 5e+18 0
EOS 8 1 5e+18 1
COMP 8 1 5e+18 0
LEND 8 1 5e+18 0
YFI 8 1 5e+18 0
DOT 8 1 5e+18 0
UNI 8 1 5e+18 0
AAVE 8 1 5e+18 0
DOGE 8 1 5e+18 0
BAT 8 1 5e+18 0
CHZ 8 1 5e+18 0
MANA 8 1 5e+18 0
ENJ 8 1 5e+18 0
SUSHI 8 1 5e+18 0
SNX 8 1 5e+18 0
GRT 8 1 5e+18 0
MKR 8 1 5e+18 0
ALGO 8 1 5e+18 0
VET 8 1 5e+18 0
ZEC 8 1 5e+18 0
FIL 8 1 5e+18 0
KSM 8 1 5e+18 0
XMR 8 1 5e+18 0
QTUM 8 1 5e+18 0
XLM 8 1 5e+18 1
ATOM 8 1 5e+18 1
LUNA 8 1 5e+18 1
SOL 8 1 5e+18 0
AXS 8 1 5e+18 0
MATIC 8 1 5e+18 0
SHIB 2 1 5e+18 0
FTM 8 1 5e+18 0
DYDX 8 1 5e+18 0
VPAD 4 1 5e+18 0

All Spot trading products

symbol type price scale factor ratio scale factor baseTickSize baseTickSizeEv quoteTickSize quoteTickSizeEv baseQtyPrecision quoteQtyPrecision pricePrecision minOrderValue minOrderValueEv maxBaseOrderSize maxBaseOrderSizeEv maxOrderValue maxOrderValueEv defaultTakerFee defaultTakerFeeEr defaultMakerFee defaultMakerFeeEr
sBTCUSDT Spot 8 8 0.000001 BTC 100 0.01 USDT 1000000 6 2 2 10 USDT 1000000000 1000 BTC 100000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sETHUSDT Spot 8 8 0.00001 ETH 1000 0.01 USDT 1000000 5 2 2 10 USDT 1000000000 10000 ETH 1000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sXRPUSDT Spot 8 8 0.1 XRP 10000000 0.00001 USDT 1000 1 2 5 10 USDT 1000000000 5000000 XRP 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sLINKUSDT Spot 8 8 0.01 LINK 1000000 0.0001 USDT 10000 2 2 4 10 USDT 1000000000 5000000 LINK 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sXTZUSDT Spot 8 8 0.01 XTZ 1000000 0.0001 USDT 10000 2 2 4 10 USDT 1000000000 2000000 XTZ 200000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sLTCUSDT Spot 8 8 0.00001 LTC 1000 0.01 USDT 1000000 5 2 2 10 USDT 1000000000 100000 LTC 10000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sADAUSDT Spot 8 8 0.1 ADA 10000000 0.00005 USDT 5000 1 2 5 10 USDT 1000000000 5000000 ADA 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sTRXUSDT Spot 8 8 0.1 TRX 10000000 0.00005 USDT 5000 1 2 5 10 USDT 1000000000 5000000 TRX 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sONTUSDT Spot 8 8 0.1 ONT 10000000 0.0005 USDT 50000 1 2 4 10 USDT 1000000000 5000000 ONT 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sBCHUSDT Spot 8 8 0.00001 BCH 1000 0.01 USDT 1000000 5 2 2 10 USDT 1000000000 10000 BCH 1000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sNEOUSDT Spot 8 8 0.001 NEO 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 5000000 NEO 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sEOSUSDT Spot 8 8 0.01 EOS 1000000 0.0001 USDT 10000 2 2 4 10 USDT 1000000000 5000000 EOS 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sDOGEUSDT Spot 8 8 1 DOGE 100000000 0.000001 USDT 100 0 2 6 10 USDT 1000000000 5000000 DOGE 500000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sBATUSDT Spot 8 8 0.01 BAT 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 300000 BAT 30000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sCHZUSDT Spot 8 8 0.01 CHZ 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 700000 CHZ 70000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sMANAUSDT Spot 8 8 0.01 MANA 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 400000 MANA 40000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sENJUSDT Spot 8 8 0.01 ENJ 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 200000 ENJ 20000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sSUSHIUSDT Spot 8 8 0.001 SUSHI 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 40000 SUSHI 4000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sSNXUSDT Spot 8 8 0.001 SNX 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 30000 SNX 3000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sGRTUSDT Spot 8 8 0.01 GRT 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 200000 GRT 20000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sUNIUSDT Spot 8 8 0.001 UNI 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 15000 UNI 1500000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sAAVEUSDT Spot 8 8 0.0001 AAVE 10000 0.01 USDT 1000000 4 2 2 10 USDT 1000000000 1000 AAVE 100000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sYFIUSDT Spot 8 8 0.00001 YFI 1000 0.01 USDT 1000000 5 2 2 10 USDT 1000000000 10 YFI 1000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sCOMPUSDT Spot 8 8 0.0001 COMP 10000 0.01 USDT 1000000 4 2 2 10 USDT 1000000000 1000 COMP 100000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sMKRUSDT Spot 8 8 0.00001 MKR 1000 0.01 USDT 1000000 5 2 2 10 USDT 1000000000 100 MKR 10000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sDOTUSDT Spot 8 8 0.001 DOT 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 10000 DOT 1000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sALGOUSDT Spot 8 8 0.01 ALGO 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 300000 ALGO 30000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sVETUSDT Spot 8 8 0.1 VET 10000000 0.000001 USDT 100 1 2 6 10 USDT 1000000000 2000000 VET 200000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sZECUSDT Spot 8 8 0.0001 ZEC 10000 0.01 USDT 1000000 4 2 2 10 USDT 1000000000 2000 ZEC 200000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sFILUSDT Spot 8 8 0.0001 FIL 10000 0.01 USDT 1000000 4 2 2 10 USDT 1000000000 3000 FIL 300000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sKSMUSDT Spot 8 8 0.0001 KSM 10000 0.01 USDT 1000000 4 2 2 10 USDT 1000000000 1000 KSM 100000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sXMRUSDT Spot 8 8 0.0001 XMR 10000 0.01 USDT 1000000 4 2 2 10 USDT 1000000000 1500 XMR 150000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sQTUMUSDT Spot 8 8 0.001 QTUM 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 30000 QTUM 3000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sXLMUSDT Spot 8 8 0.01 XLM 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 1000000 XLM 100000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sATOMUSDT Spot 8 8 0.001 ATOM 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 20000 ATOM 2000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sLUNAUSDT Spot 8 8 0.001 LUNA 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 40000 LUNA 4000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sSOLUSDT Spot 8 8 0.001 SOL 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 10000 SOL 1000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sAXSUSDT Spot 8 8 0.001 AXS 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 10000 AXS 1000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sMATICUSDT Spot 8 8 0.01 MATIC 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 300000 MATIC 30000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sSHIBUSDT Spot 8 8 1 SHIB 100 0.00000001 USDT 1 0 2 8 10 USDT 1000000000 5000000000 SHIB 500000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sFTMUSDT Spot 8 8 0.01 FTM 1000000 0.00001 USDT 1000 2 2 5 10 USDT 1000000000 200000 FTM 20000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sDYDXUSDT Spot 8 8 0.001 DYDX 100000 0.001 USDT 100000 3 2 3 10 USDT 1000000000 30000 DYDX 3000000000000 5000000 USDT 500000000000000 0.001 100000 0.001 100000
sVPADUSDT Spot 8 8 0.1 VPAD 1000 0.000001 USDT 100 1 2 6 10 USDT 1000000000 15000000 VPAD 150000000000 500000 USDT 50000000000000 0.001 100000 0.001 100000

Subscribe Investment Account

on subscription to investment account then you will get your investment information of each currency type.

  • Request：
{
  "id": <id>,
  "method": "wm.subscribe",
  "params": []
}
  • Response:
{
  "error": null,
  "id": <id>,
  "result": {
      "status":"success"
    }
}
  • Sample：
{
  "id": 1234,
  "method": "wm.subscribe",
  "params": []
}

{
  "error": null,
  "id": 1234,
  "result": {
      "status":"success"
    }
}

Investment Account Message Format：

{
  "investments":[
    {
      "currency":<currency>,
      "balanceEv":<balanceEv>,
      "userId":<userId>,
      "demandPendingInterestBalanceEv":<demandPendingInterestBalanceEv>,
      "demandInterestedBalanceEv":<demandInterestedBalanceEv>,
      "timedDepositBalanceEv":<timedDepositBalanceEv>,
      "currentTimeMillis":<currentTimeMillis>
  ]
}
Field Type Description Possible values
currency String invested currency BTC,ETH
balanceEv Long invested amount 0
userId Long your user id 1234
demandPendingInterestBalanceEv Long pending interest for flexible product 0
demandInterestedBalanceEv Long paid interest for flexible product 0
timedDepositBalanceEv Long amount for fixed product 20000000000
currentTimeMillis Long time in milli 1653972360166
  • Sample：
{
  "investments":[
    {
      "currency":"USDT",
      "balanceEv":21797700000,
      "userId":1234,
      "demandPendingInterestBalanceEv":0,
      "demandInterestedBalanceEv":0,
      "timedDepositBalanceEv":20000000000,
      "currentTimeMillis":1653972360161
    },
    {
      "currency":"BTC",
      "balanceEv":0,
      "userId":1234,
      "demandPendingInterestBalanceEv":0,
      "demandInterestedBalanceEv":0,
      "timedDepositBalanceEv":0,
      "currentTimeMillis":1653972360166
    }
  ]
}