Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update description on the includeAssetInfo parameter which belongs to the getTrades request #828

Open
ipr0310 opened this issue Jun 6, 2024 · 0 comments
Labels
API DOC Problems/Improveements related to the API Documentiation enhancement New feature or request

Comments

@ipr0310
Copy link
Member

ipr0310 commented Jun 6, 2024

This is the current state on the documentation API
GET /api?requestType=getTrades
image

Describe the solution you would like
The description of that parameter must say the following:
If set true (default), the tokens name, decimals and price is included in the response

Additional context

Example when the includeAssetInfo parameter is true

{
  "trades": [
    {
      "timestamp": 306172592,
      "quantityQNT": "420000",
      "priceNQT": "4200",
      "asset": "14175641444126570597",
      "askOrder": "11227378257886935022",
      "bidOrder": "1455229592601475755",
      "askOrderHeight": 1250718,
      "seller": "11451648408407344687",
      "sellerRS": "S-M3KH-KRBW-7QJK-BF5VX",
      "buyer": "647216736578535364",
      "buyerRS": "S-8ZY6-87G9-WULJ-22VYK",
      "block": "421354682316313547",
      "height": 1269498,
      "tradeType": "sell",
      "name": "stTRT",
      "decimals": 4,
      "price": "42000000"
    }
  ],
  "nextIndex": 1,
  "requestProcessingTime": 3
}

Example when the includeAssetInfo parameter is false

{
  "trades": [
    {
      "timestamp": 306172592,
      "quantityQNT": "420000",
      "priceNQT": "4200",
      "asset": "14175641444126570597",
      "askOrder": "11227378257886935022",
      "bidOrder": "1455229592601475755",
      "askOrderHeight": 1250718,
      "seller": "11451648408407344687",
      "sellerRS": "S-M3KH-KRBW-7QJK-BF5VX",
      "buyer": "647216736578535364",
      "buyerRS": "S-8ZY6-87G9-WULJ-22VYK",
      "block": "421354682316313547",
      "height": 1269498,
      "tradeType": "sell"
    }
  ],
  "nextIndex": 1,
  "requestProcessingTime": 8
}
@ipr0310 ipr0310 added enhancement New feature or request API DOC Problems/Improveements related to the API Documentiation labels Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API DOC Problems/Improveements related to the API Documentiation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant