Queries
Vertex Queries - Websocket and REST API
All queries go through the following endpoint; the exact details of the query are specified by query params or Websocket
messages.
Websocket:
WEBSOCKET [GATEWAY_WEBSOCKET_ENDPOINT]
REST:
GET [GATEWAY_REST_ENDPOINT]/query
orPOST [GATEWAY_REST_ENDPOINT]/query
Overview
Amounts and Prices
In general, amounts come back normalized to 18 decimal places. Meaning that for a balance of 1 USDC, regardless of the number of decimals USDC has on-chain, a value of 1e18 will be returned.
Prices are in x18
, so if the price of one wBTC is $20,000, regardless of the number of decimals wBTC has on-chain, the price will be returned as 20,000 * 1e18
.
API Response
All queries
return in the format:
{
"status": "success" | "failure",
"data"?: {data},
"error"?: "{error_msg}",
"error_code"?: {error_code},
"request_type": "{request_type}"
}
Last updated