Honeycluster Docs – Get aggregated oracle price

Returns an aggregated price from multiple oracle instances, with optional outlier trimming.

{ "result": { "entire_set": { "mean": "0.53", "size": 5, "standard_deviation": "0.02" }, "median": "0.53", "time": 750171900, "trimmed_set": { "mean": "0.53", "size": 4, "standard_deviation": "0.01" }, "ledger_index": 89012345 }, "status": "success", "type": "response", "id": 1 }

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`base_asset`	string	The base asset for the price quote (e.g. "USD").
`quote_asset`	string	The quote asset for the price quote (e.g. "XRP").
`oracles`	object[]	Array of oracle instances to aggregate prices from.
`oracles[].account` required	string	The oracle provider account address.
`oracles[].oracle_document_id` required	integer	The oracle document ID on the account.
`trim`	integer	Percentage of outlier prices to trim before aggregating (1-25).
`time_threshold`	integer	Maximum age in seconds for oracle data to be considered fresh.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Field

Type

Description

command

required

string

WebSocket command name

id

object

Client-supplied identifier to correlate requests with responses.

base_asset

string

The base asset for the price quote (e.g. "USD").

quote_asset

string

The quote asset for the price quote (e.g. "XRP").

oracles

object[]

Array of oracle instances to aggregate prices from.

oracles[].account

required

string

The oracle provider account address.

oracles[].oracle_document_id

required

integer

The oracle document ID on the account.

trim

integer

Percentage of outlier prices to trim before aggregating (1-25).

time_threshold

integer

Maximum age in seconds for oracle data to be considered fresh.

api_version

object

API version for the response format. Version 2 is the default for rippled 2.0+.

{ "command": "get_aggregate_price", "id": 1, "base_asset": "XRP", "quote_asset": "USD", "oracles": [ { "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn", "oracle_document_id": 1 } ], "trim": 20 }

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Field

Type

Description

result

object

status

enum<string>

Available

successerror

type

string

id

stringnumber

Echo of the client-provided correlation ID

const ws = new WebSocket('wss://honeycluster.io'); ws.addEventListener('open', () => { const request = { "command": "get_aggregate_price", "id": 1, "base_asset": "XRP", "quote_asset": "USD", "oracles": [ { "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn", "oracle_document_id": 1 } ], "trim": 20 }; ws.send(JSON.stringify(request)); }); ws.addEventListener('message', (event: MessageEvent<string>) => { const response: unknown = JSON.parse(event.data); console.log(response); ws.close(); });