Interface GetAggregatePriceResponse

Response expected from an GetAggregatePriceRequest.

interface GetAggregatePriceResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        entire_set: { mean: string; size: number; standard_deviation: string };
        ledger_current_index: number;
        median: string;
        time: number;
        trimmed_set?: { mean: string; size: number; standard_deviation: string };
        validated: boolean;
    };
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Hierarchy (View Summary)

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

Optionalapi_version

api_version?: number

Optionalforwarded

forwarded?: boolean

id

id: string | number

result

result: {
    entire_set: { mean: string; size: number; standard_deviation: string };
    ledger_current_index: number;
    median: string;
    time: number;
    trimmed_set?: { mean: string; size: number; standard_deviation: string };
    validated: boolean;
}

Type declaration

  • entire_set: { mean: string; size: number; standard_deviation: string }

    The statistics from the collected oracle prices.

    • mean: string

      The simple mean.

    • size: number

      The size of the data set to calculate the mean.

    • standard_deviation: string

      The standard deviation.

  • ledger_current_index: number

    The ledger index of the ledger version that was used to generate this response.

  • median: string

    The median of the collected oracle prices.

  • time: number

    The most recent timestamp out of all LastUpdateTime values.

  • Optionaltrimmed_set?: { mean: string; size: number; standard_deviation: string }

    The trimmed statistics from the collected oracle prices. Only appears if the trim field was specified in the request.

    • mean: string

      The simple mean of the trimmed data.

    • size: number

      The size of the data to calculate the trimmed mean.

    • standard_deviation: string

      The standard deviation of the trimmed data.

  • validated: boolean

    If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties