Knowledge Base
  • 💡Welcome To PointPay
  • 📃WhitePapper v 1.0
    • Disclaimer
    • Market Overview
      • Overview of 2018-2023
      • Evolution and Statement
      • Challenges and Opportunities
    • PointPay 2.0
      • Ecosystem Overview
      • Services Synergy
    • Crypto Exchange
      • Main Benefits
      • Security Measures
      • Customer Support
    • Digital Vault
      • Role in Ecosystem
      • Features and Benefits
      • Integration with other Services
    • PointPay Token
      • Token Info
      • Utility and Benefits
    • Project Future
      • Project Vision
      • Upcoming Features
    • Conclusion
  • 📈Tokenomics
  • ⚖️Token Swap Flow
  • 🔗Network
    • Mainnet&TestNet
    • Smart contracts
      • Contract Deployment
      • Deploy with Remix IDE
      • Deploy with Thirdweb
    • Explorer API
    • RPC API
  • Exchange API Documentation
    • Public endpoints | HTTP
      • Pairs List
      • Pairs Stats
      • Specific Pair Stats
      • Order Book Data
      • Market History
      • Market History Data
      • Products
      • Symbols
      • Depth List
      • Chart Data KLine
    • Private endpoints | HTTP
      • Authentication and API Keys
      • Create Limit Order
      • Cancel Order
      • My Active Orders
      • All My Trade Balances
      • My Specific Trade Balance
      • My Order Info
      • My Trades Info
      • My Order History
      • My Order History List
    • Basic structure | WEBSOKET
    • Public methods | WEBSOKET
      • Ping-Pong
      • System Time
      • KLine methods
      • Market Price methods
      • Market Status methods
      • Deals methods
      • Depth methods
    • Private methods | WEBSOKET
      • Authorization
      • My Assets methods
      • My Orders methods
Powered by GitBook
On this page
  • List of My Balances methods:
  • Order Query method
  • Order History method
  • Order Subscribe method
  • Order Unsubscribe method
  1. Exchange API Documentation
  2. Private methods | WEBSOKET

My Orders methods

Used to get information on orders for a specific user from which the request is made. After establishing the WebSocket connection, the user has to be authorized to use this methods.

PreviousMy Assets methods

Last updated 7 months ago

List of My Balances methods:

  • - used for one-time data get requests on active orders.

  • - used for one-time data get requests on orders history.

  • - used to subscribe to receive real-time updates on active orders (when orders are placed, canceled, executed, or changed).

  • - used to unsubscribe from the method.

Order Query method

Used for one-time data get requests on active orders.

Method name

order.query

Request "params" parameters

Name
Type
Description
Example

market*

STRING

Any public pair (use "" for all orders)

PXP_USDT

offset*

NUMERIC

Amount of first orders to skip

0

limit*

NUMERIC

Amount of orders to show

2

Request example

{
  "method":"order.query",
  "params":
    [
      "PXP_USDT", // market
      0,          // offset
      2          // limit
    ],
  "id":1
}

Response "result" parameters

Name
Type
Description

market_name

STRING

Pair name

offset

NUMERIC

Amount of first orders to skip

limit

NUMERIC

Amount of orders to show

total

NUMERIC

Total number of orders

id

NUMERIC

Order ID

market

STRING

Pair name

price

STRING

Order price

amount

STRING

Order amount (in first ticker of pair)

left

STRING

Available order amount (in first ticker of pair) (if not traded = deal_stock, if order finished = 0)

user

NUMERIC

User ID

platform

NUMERIC

0 = Limit / Market, 1 = Stop-limit, 2 = OCO

algorithm

NUMERIC

Spot = 0, Margin = 1

type

NUMERIC

1 = Limit, 2 = Market

side

NUMERIC

1 = Sell (Ask), 2 = Buy (Bid)

ctime

NUMERIC

Time of order creation (TimeStamp format)

mtime

NUMERIC

Order matching time (TimeStamp format)

taker_fee

STRING

Order tacker fee

maker_fee

STRING

Order maker fee

deal_stock

STRING

Order amount (in first ticker of pair)

deal_money

STRING

Order amount (in second ticker of pair)

source

STRING

Custom parameter

Response example

{
    "id": 1,
    "params": [
        "PXP_USDT",
        0,
        2
    ],
    "result": {
        "market_name": "PXP_USDT",
        "offset": 0,
        "limit": 2,
        "total": 2,
        "records": [
            {
                "id": 19251962966,
                "market": "PXP_USDT",
                "price": "0.04",
                "amount": "50",
                "left": "50",
                "user": 28474250985,
                "platform": 0,
                "algorithm": 0,
                "type": 1,
                "side": 2,
                "ctime": 1.727431086915E9,
                "mtime": 0.0,
                "taker_fee": "0.0012",
                "maker_fee": "0.0012",
                "deal_stock": "0",
                "deal_money": "0",
                "source": ""
            },
            {
                "id": 19251932071,
                "market": "PXP_USDT",
                "price": "0.12",
                "amount": "50",
                "left": "50",
                "user": 28474250985,
                "platform": 0,
                "algorithm": 0,
                "type": 1,
                "side": 1,
                "ctime": 1.727430884088E9,
                "mtime": 0.0,
                "taker_fee": "0.0012",
                "maker_fee": "0.0012",
                "deal_stock": "0",
                "deal_money": "0",
                "source": ""
            }
        ]
    },
    "error": null
}

Order History method

Used for one-time data get requests on orders history.

Method name

order.history

Request "params" parameters

Name
Type
Description
Example

market*

STRING

Any public pair (use "" for all orders)

PXP_USDT

start_time*

NUMERIC

Order creation time (unlimited = 0; TimeStamp value for custom time)

0

end_time*

INTEGER

Order finish time (unlimited = 0; TimeStamp value for custom time)

0

offset*

INTEGER

Amount of orders to skip

0

limit*

NUMERIC

Amount of orders to show

2

Request example 1

{
  method: "order.history",
  params:
    [
      "PXP_USDT",
      0,
      0,
      0,
      2
    ],
  id: 2
}

Response "result" parameters

Name
Type
Description

offset

NUMERIC

Amount of first orders to skip

limit

NUMERIC

Amount of orders to show

id

INTEGER

Order ID

market

STRING

Pair name

price

STRING

Order price

amount

NUMERIC

Order amount (in first ticker of pair)

type

INTEGER

1 - =imit, 2 = Market

side

INTEGER

1 = Sell (Ask), 2= Buy (Bid)

platform

INTEGER

0 = Limit / Market, 1 = Stop-limit; 2 = OCO

algorithm

INTEGER

Spot = 0, Margin = 1

ctime

TIMESTAMP

Time of order creation (TimeStamp format)

ftime

INTEGER

Order finish time (TimeStamp format)

taker_fee

STRING

Order taker fee

maker_fee

STRING

Order maker fee

deal_stock

STRING

Order amount (in first ticker of pair)

deal_money

STRING

Order amount (in second ticker of pair)

Response example 1

{
    "id": 2,
    "params": [
        "PXP_USDT",
        0,
        0,
        0,
        2
    ],
    "result": {
        "offset": 0,
        "limit": 2,
        "records": [
            {
                "id": 19251960112,
                "market": "PXP_USDT",
                "price": "0.4",
                "amount": "40",
                "type": 1,
                "side": 2,
                "platform": 0,
                "algorithm": 0,
                "ctime": 1.727431067741E9,
                "ftime": 1.727431067745E9,
                "taker_fee": "0.0012",
                "maker_fee": "0.0012",
                "deal_stock": "40",
                "deal_money": "4.0996"
            },
            {
                "id": 19251929631,
                "market": "PXP_USDT",
                "price": "0.9",
                "amount": "10",
                "type": 1,
                "side": 2,
                "platform": 0,
                "algorithm": 0,
                "ctime": 1.727430866781E9,
                "ftime": 1.727430866784E9,
                "taker_fee": "0.0012",
                "maker_fee": "0.0012",
                "deal_stock": "10",
                "deal_money": "1.0249"
            }
        ]
    },
    "error": null
}

Request example 2

{
  "method": "order.history",
  "params":
    [
      "",             // market
      1727122400,     // start_time
      1727408800,     // end_time
      0,              // offset 
      5               // limit
    ],
  "id": 2
}

Response example 2

{
    "id": 2,
    "params": [
        "",
        1727122400,
        1727408800,
        0,
        5
    ],
    "result": {
        "offset": 0,
        "limit": 5,
        "records": [
            {
                "id": 19238735632,
                "market": "PXP_USDT",
                "price": "0",
                "amount": "100",
                "type": 2,
                "side": 1,
                "platform": 0,
                "algorithm": 0,
                "ctime": 1.727345283783E9,
                "ftime": 1.727345283786E9,
                "taker_fee": "0.0012",
                "maker_fee": "0",
                "deal_stock": "100",
                "deal_money": "9.9324"
            },
            {
                "id": 19238729911,
                "market": "PXP_USDT",
                "price": "0",
                "amount": "10",
                "type": 2,
                "side": 2,
                "platform": 0,
                "algorithm": 0,
                "ctime": 1.727345249433E9,
                "ftime": 1.727345249439E9,
                "taker_fee": "0.0012",
                "maker_fee": "0",
                "deal_stock": "100",
                "deal_money": "10"
            }
        ]
    },
    "error": null
}

Order Subscribe method

Used to subscribe to receive real-time updates on active orders.

Method

order.subscribe

Request "params" parameters

Name
Type
Description

market*

STRING

Any public pair (use "" for all orders)

Request example

{
  "method":"order.subscribe",
  "params":
    [
      "PXP_USDT"  //market
    ],
  "id":3
}

Response example (successfully subscribed)

{
    "id": 3,
    "params": [],
    "result": {
        "status": "success"
    },
    "error": null
}

Response "result" parameters ("order.update", when orders are placed, canceled, executed, or changed)

Name
Type
Description

id

INTEGER

Order ID

market

STRING

Pair name

price

STRING

Order price

amount

NUMERIC

Order amount (in first ticker of pair)

left

STRING

Available order amount (if not traded= deal_stock; if order finished = 0)

user

INTEGER

User ID

platform

INTEGER

0 = Limit / Market, 1 = Stop-limit, 2 = OCO

algorithm

INTEGER

Spot = 0, Margin= 1

type

INTEGER

1 = Limit, 2 = Market

side

INTEGER

1 = Sell (Ask), 2= Buy (Bid)

ctime

TIMESTAMP

Time of order creation (TimeStamp format)

mtime

INTEGER

Order matching time (TimeStamp format)

deal_fee

STRING

User fee coefficient

taker_fee

STRING

Order taker fee

maker_fee

STRING

Order maker fee

deal_money

STRING

Order amount (in second ticker of pair)

deal_stock

STRING

Order amount (in first ticker of pair)

source

STRING

Custom parameter

Response example ("order.update", when orders are placed, canceled, executed, or changed)

{
    "id": null,
    "method": "order.update",
    "params": [
        1,
        {
            "id": 19252619577,
            "market": "PXP_USDT",
            "price": "0.04000000",
            "amount": "40.00000000",
            "left": "40.00000000",
            "user": 28474250985,
            "platform": 0,
            "algorithm": 0,
            "type": 1,
            "side": 2,
            "ctime": 1.727435273489E9,
            "mtime": 1.727435273489E9,
            "deal_fee": "0",
            "taker_fee": "0.00120000",
            "maker_fee": "0.00120000",
            "deal_stock": "0",
            "deal_money": "0",
            "source": ""
        }
    ]
}

Order Unsubscribe method

Method

order.unsubscribe

Request example

{
  "method":"order.unsubscribe",
  "params":[],
  "id":4
}

Response example (successfully unsubscribed)

{
    "id": 4,
    "params": [],
    "result": {
        "status": "success"
    },
    "error": null
}

Used to unsubscribe from the method.

Order Query
Order History
Order Subscribe
Order Unsubscribe
Order Subscribe
Order Subscribe