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 Market Status methods:
  • Market Status Query method
  • Market Status Subscribe method
  • Market Status Unsubscribe method
  1. Exchange API Documentation
  2. Public methods | WEBSOKET

Market Status methods

Used to get information about market activity for a specific pair

PreviousMarket Price methodsNextDeals methods

Last updated 7 months ago

List of Market Status methods:

  • - used for one-time data get requests.

  • - used to subscribe to receive real-time updates.

  • - used to unsubscribe from the method.

Market Status Query method

Used for one-time data get requests.

Method

state.query

Request "params" parameters

Name
Type
Description
Example

market*

STRING

Any public pair

BTC_USDT

period*

NUMERIC

Time interval (60 = 1 min, 900 = 15 min, 1800 = 30 min, 3600 = 1 h, 14400 = 4 h, 86400 = 1 d, etc)

86400

Request example

{
  "method":"state.query",
  "params":
    [
      "BTC_USDT",
      86400
    ],
  "id":1
}

Response "result" parameters

Name
Type

period

NUMERIC

last

STRING

open

STRING

close

STRING

high

STRING

low

STRING

deal

STRING

volume

STRING

change

STRING

Response example

{
    "id": 1,
    "params": [
        "BTC_USDT",
        86400
    ],
    "result": {
        "period": 86400,                       // period
        "last": "63740.5",                     // last price 24h
        "open": "64262.69",                    // open price 24h
        "close": "63746.175",                  // close price 24h
        "high": "64814.0909212",               // highest price 24h
        "low": "63409.39",                     // lowest price 24h
        "deal": "9728980.6793573261265715",    // deal
        "volume": "151.92971388",              // volume
        "change": "-0.81"                      // % change
    },
    "error": null
}

Market Status Subscribe method

Used to subscribe to receive real-time updates.

Method

state.subscribe

Request "prarams" paramaeters

Name
Type
Desciption
Example

market*

STRING

Any public pair

ETH_BTC

period*

NUMERIC

Time interval (60 = 1 min, 900 = 15 min, 1800 = 30 min, 3600 = 1 h, 14400 = 4 h, 86400 = 1 d, etc)

86400

Request example

{
  "method":"state.subscribe",
  "params":
    [
      "ETH_BTC",
      86400
    ],
  "id":1
}

Response example (successfully subscribed)

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

Response "result" parameters ("state.update")

Name
Type

period

NUMERIC

volume

STRING

last

STRING

open

STRING

low

STRING

close

STRING

high

STRING

deal

STRING

Response example ("state.update")

{
  "result":
    {
      "period": 86400,                    // period
      "volume": "192238.62392908",        // volume 
      "last": "0.018295",                 // last price 24h
      "open": "0.017526",                 // open price 24h
      "low": "0.0174",                    // lowest price 24h
      "close": "0.018295",                // close price 24h
      "high": "0.02",                     // highest price 24h
      "deal": "3479.25570915213257"       // deal
    },
  "error": null,
  "id": null
}

Market Status Unsubscribe method

Method

state.unsubscribe

Request example

{
  "method":"state.unsubscribe",
  "params":[],
  "id":2
}

Response example (successfully unsubscribed)

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

Used to unsubscribe from the method.

Market Status Query
Market Status Subscribe
Market Status Unsubscribe
Market Status Subscribe
Market Status Subscribe