Documentation
Log In
Documentation

Monitor status of active orders.

📘

If you want to get orders from all markets just use path without market symbol:
"path": "offers"

{
 "action": "subscribe-private",
 "module": "trading",
 "path": "offers/{market_code}",
 "hashSignature": "8892f16e0713c5f3e3d7e9fa26c5a5f2817b09fc48fece72ed5712ae33547c92e91e735b1818397136beea760efae61d1449a93e48ee2f80789dfa24830ef720",
  "publicKey": "12345f6f-1b1d-1234-a973-a10b1bdba1a1",
  "requestTimestamp": 1529897422
}
{
  "action": "push",
  "topic": "trading/offers/btc-pln",
  "message": {
    "entryType": "Buy",
    "rate": "1",
    "action": "update",
    "offerId": "90996f21-27e5-11ea-8d5d-0242ac110008",
    "market": "BTC-PLN",
    "state": {
      "market": "BTC-PLN",
      "offerType": "Buy",
      "id": "90996f21-27e5-11ea-8d5d-0242ac110008",
      "currentAmount": "15",
      "lockedAmount": "15.00",
      "rate": "1",
      "startAmount": "15",
      "time": "1577367751519",
      "postOnly": false,
      "hidden": false,
      "mode": "Limit",
      "receivedAmount": "0.0",
      "balances": {
        "first": "36b3e538-7aac-4fe9-8834-a0577f7706a2",
        "second": "00a6680d-f453-41dd-beca-7594e5680f5a"
      },
    },
    "timestamp": "1577367751519"
  },
  "timestamp": "1577367751519",
  "seqNo": 16
}
{
  "requestId": "4976d5bd-b1d0-c547-9245-44e4e419e12f",
  "operation-id": "eec35603-dcf6-f5c2-ac43-99086209ee40",
  "action": "proxy",
  "module": "trading",
  "path": "offer",
  "token": "c6349a27-592c-45c6-84ac-120ede3fd352"
}
{
  "action": "proxy-response",
  "requestId": "4976d5bd-b1d0-c547-9245-44e4e419e12f",
  "statusCode": 200,
  "body": {
    "status": "Ok",
    "items": [
      {
        "market": "BTC-PLN",
        "offerType": "Buy",
        "id": "90996f21-27e5-11ea-8d5d-0242ac110008",
        "currentAmount": "15",
        "lockedAmount": "15.00",
        "rate": "1",
        "startAmount": "15",
        "time": "1577367751519",
        "postOnly": false,
        "hidden": false,
        "mode": "limit",
        "receivedAmount": "0.0",
        "firstBalanceId": "380c5b41-44e4-4962-aa8b-451d32d4d352",
        "secondBalanceId": "6c25f724-4b07-4a0f-bad2-8432ffc07b22"
      }
    ]
  }
}

Response details

KeyTypeDescription
entryTypearrayOrder type: buy / sell.
ratedecimalPrice of the order.
actionstringType of change: remove / update.
offerIdUUIDOrder UUID.
marketstringSymbol of the market.
statearrayArray of detailed informations about order.
* marketstringSymbol of the market.
* offerTypestringOrder type: buy / sell.
* idUUIDOrder UUID.
* currentAmountdecimalCurrent amount of cryptocurrency in the order.
* lockedAmountdecimalLocked amount of cryptocurrency on a account.
* ratedecimalPrice of the order.
* startAmountdecimalStarting amount of cryptocurrency in the order.
* timeUNIX timestampTime of execute on server. For this time all above values are actual.
* balancesarrayAn array of the wallets on which offer will be executed.
* * firstUUIDUUID of the wallet for first currency in pair.
* * secondUUIDUUID of the wallet for second currency in pair.
* postOnlybooleanDo order is postOnly.
* modestringOrder mode: limit / market.
* receivedAmountdecimalAmount of receive cryptocurrency.