Struct PythClient

pub struct PythClient { /* private fields */ }

Client type for Pyth Hermes.

See the documentation for each endpoint in Swagger.

Implementations

impl PythClient

Streams

pub async fn stream_price_updates( &self, ids: Vec<PriceIdInput>, encoding: Option<EncodingType>, parsed: Option<bool>, allow_unordered: Option<bool>, benchmarks_only: Option<bool>, ) -> Result<impl Stream<Item = Result<PriceUpdate, Error>> + use<>, Error>

Available on crate feature stream only.

SSE route handler for streaming price updates.

Arguments:

• ids: Get the most recent price update for this set of price feed ids.
• encoding: Optional encoding type. If set, return the price update in the encoding specified by the encoding parameter. Default is EncodingType::Hex.
• parsed: If true, include the parsed price update in PriceUpdate::parsed. Defaults to false for this client.
• allow_unordered: If true, allows unordered price updates to be included in the stream.
• benchmarks_only: If true, only include benchmark prices that are the initial price updates at a given timestamp (i.e., prevPubTime != pubTime).

/v2/updates/price/stream

impl PythClient

pub fn new(url: Url) -> Self

pub fn new_with_client(client: Client, url: Url) -> Self

pub async fn price_feeds( &self, query: String, asset_type: Option<AssetType>, ) -> Result<Vec<PriceFeedMetadata>, Error>

Get the set of price feeds.

This endpoint fetches all price feeds from the Pyth network. It can be filtered by asset type and query string.

Arguments:

• query: If provided, the results will be filtered to all price feeds whose symbol contains the query string. Query string is case insensitive. Example: “bitcoin”
• asset_type: If provided, the results will be filtered by asset type.

/v2/price_feeds

pub async fn latest_price_update( &self, ids: Vec<PriceIdInput>, encoding: Option<EncodingType>, parsed: Option<bool>, ) -> Result<PriceUpdate, Error>

Get the latest price updates by price feed id.

Given a collection of price feed ids, retrieve the latest Pyth price for each price feed.

Arguments:

• ids: Get the most recent price update for this set of price feed ids.
• encoding: Optional encoding type. If set, return the price update in the encoding specified by the encoding parameter. Default is EncodingType::Hex.
• parsed: If true, include the parsed price update in PriceUpdate::parsed. Defaults to false for this client.

/v2/updates/price/latest

pub async fn price_update( &self, publish_time: u64, ids: Vec<PriceIdInput>, encoding: Option<EncodingType>, parsed: Option<bool>, ) -> Result<PriceUpdate, Error>

Get the latest price updates by price feed id.

Given a collection of price feed ids, retrieve the latest Pyth price for each price feed.

Arguments:

• publish_time: The unix timestamp in seconds. This endpoint will return the first update whose publish_time is >= the provided value.
• ids: Get the price update for this set of price feed ids.
• encoding: Optional encoding type. If set, return the price update in the encoding specified by the encoding parameter. Default is EncodingType::Hex.
• parsed: If true, include the parsed price update in PriceUpdate::parsed. Defaults to false for this client.

/v2/updates/price/{publish_time}

Trait Implementations

impl Clone for PythClient

fn clone(&self) -> PythClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PythClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.