spotClearinghouseState

spotClearinghouseState

post

https://api.hyperlink.xyzhttps://api.hyperlink-testnet.xyzhttp://localhost:8080

/exchange

Body

application/json

Request envelope for read-only actions submitted to /exchange.

Same structure as [ExchangeRequest] but with [ReadOnlyActionRequest] as the action type. Used for signed read-only queries (balances, positions, orders, portfolio).

expiresAfterinteger · nullableOptional

Optional expiry for signed query requests.

nonceinteger · int64Required

Request nonce (Unix timestamp in milliseconds)

vaultAddressstring · nullableOptional

Optional vault address for vault operations

Responses

200

Request successful. Response format depends on the requested action.

application/json

anyOptional

400

Request body was not valid JSON

text/plain

422

JSON body did not match a supported exchange schema

text/plain

500

Internal server error

application/json

post/exchange

HTTPcURLJavaScriptPython

POST /exchange HTTP/1.1
Host: api.hyperlink.xyz
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "action": {
    "type": "spotClearinghouseState"
  },
  "expiresAfter": null,
  "nonce": 1,
  "signature": {
    "r": "text",
    "s": "text",
    "v": 1
  },
  "vaultAddress": null
}

[
  {
    "coin": "BTC",
    "side": "A",
    "limitPx": "29792.0",
    "sz": "5.0",
    "oid": 91490942,
    "timestamp": 1681247412573,
    "origSz": "5.0",
    "cloid": "0x1234567890abcdef1234567890abcdef"
  }
]