Merge branch 'main' into bump-version-1.0.6

Author: thrishank

Cargo.lock

@@ -1,4 +1,4 @@
-use jup_ag_sdk::{JupiterClient, types::TokenPriceRequest};
+use jup_ag_sdk::{JupiterClient, client};
 
 pub async fn token_balances() {
     let client = JupiterClient::new("https://lite-api.jup.ag");
@@ -31,48 +31,22 @@ pub async fn token_price() {
         "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN".to_string(),
     ];
 
-    let params = TokenPriceRequest::new(&token_mints);
-
-    let price = client
-        .get_token_price(&params)
-        .await
-        .expect("Failed to get token price");
-
-    let sol_price = price
-        .data
-        .get(token_mints[0].as_str())
-        .expect("SOL price not found");
-
-    println!("1 SOL price in USDC: {}", sol_price.price);
-
-    let jup_price = price
-        .data
-        .get(token_mints[1].as_str())
-        .expect("Jup Token price not found");
-
-    println!("1 JUP price USDC:  {}", jup_price.price);
-
-    let params = TokenPriceRequest::new(&token_mints)
-        .with_vs_token("So11111111111111111111111111111111111111112");
-
     let price = client
-        .get_token_price(&params)
+        .get_tokens_price(&token_mints)
         .await
         .expect("Failed to get token price");
 
     let sol_price = price
-        .data
         .get(token_mints[0].as_str())
         .expect("SOL price not found");
 
-    println!("1 SOL price in SOL: {}", sol_price.price);
+    println!("1 SOL price in USDC: {}", sol_price.usd_price);
 
     let jup_price = price
-        .data
         .get(token_mints[1].as_str())
         .expect("Jup Token price not found");
 
-    println!("1 JUP price in SOL:  {}", jup_price.price);
+    println!("1 JUP price USDC:  {}", jup_price.usd_price);
 }
 
 pub async fn token_info() {
@@ -115,3 +89,18 @@ pub async fn get_tokens_from_tags() {
 
     println!("mints: {}", mints.len())
 }
+
+pub async fn get_trending_tokens() {
+    let client = JupiterClient::new("https:://lite-api.jup.ag");
+
+    let tokens = client
+        .get_tokens_by_category(
+            jup_ag_sdk::types::Category::TopTrending,
+            jup_ag_sdk::types::Interval::TwentyFourHours,
+            Some(10),
+        )
+        .await
+        .expect("failed to get trending tokens");
+
+    println!("trending tokens: {:?}", tokens.len());
+}

examples/src/token.rs

@@ -1,10 +1,210 @@
+use std::collections::HashMap;
+
 use super::JupiterClient;
 use crate::{
     error::{JupiterClientError, handle_response},
-    types::{NewTokens, TokenInfoResponse, TokenPriceRequest, TokenPriceResponse},
+    types::{
+        Category, Interval, NewTokens, Price, TokenInfo, TokenInfoResponse, TokenPriceRequest,
+        TokenPriceResponse,
+    },
 };
 
 impl JupiterClient {
+    /// search for a token and its information by its symbol, name or mint address
+    ///
+    /// Limit to 100 mint addresses in query
+    /// Default to 20 mints in response when searching via symbol or name
+    ///
+    /// # Arguments
+    ///
+    /// * `mints` - A slice of mint addresses (`&[String]`) to inspect.
+    ///
+    /// # Returns
+    ///
+    /// * `Ok(Vec<TokenInfo>)` containing token safety metadata.
+    /// * `Err` if the request or deserialization fails.
+    ///
+    /// # Jupiter API Reference
+    ///
+    /// - [Search Endpoint](https://dev.jup.ag/docs/api/ultra-api/search)
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// let mints = vec![
+    ///     String::from("EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"),
+    ///     String::from("JUP")
+    /// ];
+    /// let token_info = client.token_search(&mints).await?;
+    /// ```
+    pub async fn token_search(
+        &self,
+        mints: &[String],
+    ) -> Result<Vec<TokenInfo>, JupiterClientError> {
+        let query_params = vec![("query", mints.join(","))];
+
+        let response = match self
+            .client
+            .get(format!("{}/tokens/v2/search", self.base_url))
+            .query(&query_params)
+            .send()
+            .await
+        {
+            Ok(resp) => resp,
+            Err(e) => return Err(JupiterClientError::RequestError(e)),
+        };
+
+        let response = handle_response(response).await?;
+
+        match response.json::<Vec<TokenInfo>>().await {
+            Ok(data) => Ok(data),
+            Err(e) => Err(JupiterClientError::DeserializationError(e.to_string())),
+        }
+    }
+
+    /// Returns a list of mints with specified tag(s) along with their metadata.
+    /// tags: verified, lst, token-2022, etc
+    /// ```
+    ///
+    /// let tags = vec![String::from("verified")];
+    /// let tagged = client
+    /// .get_mints_by_tags(&tags)
+    ///    .await
+    ///    .expect("failed to get mints by tags");
+    /// ```
+    pub async fn get_mints_by_tags(
+        &self,
+        tags: &[String],
+    ) -> Result<Vec<TokenInfo>, JupiterClientError> {
+        let query_params = vec![("query", tags.join(","))];
+
+        let response = match self
+            .client
+            .get(format!("{}/tokens/v2/tag", self.base_url))
+            .query(&query_params)
+            .send()
+            .await
+        {
+            Ok(resp) => resp,
+            Err(e) => return Err(JupiterClientError::RequestError(e)),
+        };
+
+        let response = handle_response(response).await?;
+
+        match response.json::<Vec<TokenInfo>>().await {
+            Ok(mints) => Ok(mints),
+            Err(e) => Err(JupiterClientError::DeserializationError(e.to_string())),
+        }
+    }
+
+    /// Returns a list of mints and their information for the given category and time interval.
+    ///
+    /// # Parameters
+    /// - `category` (`Category`) — Required  
+    ///   The token ranking category. Possible values:  
+    ///   - `toporganicscore` — Top tokens by organic score  
+    ///   - `toptraded` — Top traded tokens  
+    ///   - `toptrending` — Top trending tokens  
+    ///
+    /// - `interval` (`Interval`) — Required  
+    ///   Time interval for the ranking query. Possible values:  
+    ///   - `5m` — Last 5 minutes  
+    ///   - `1h` — Last 1 hour  
+    ///   - `6h` — Last 6 hours  
+    ///   - `24h` — Last 24 hours  
+    ///
+    /// - `limit` (`Option<u8>`) — Optional  
+    ///   Maximum number of results to return (default is 50, maximum is 100).  
+    ///   Must be between 1 and 100 inclusive if provided.  
+    ///   ```
+    ///   let tokens = client
+    ///    .get_mints_by_category(Category::TopTrending, Interval::OneHour, None)
+    ///    .await.expect("failed to get tokens");
+    ///   ```
+    pub async fn get_tokens_by_category(
+        &self,
+        category: Category,
+        interval: Interval,
+        limit: Option<u8>,
+    ) -> Result<Vec<TokenInfo>, JupiterClientError> {
+        let url = format!("{}/tokens/v2/{}/{}", self.base_url, category, interval);
+
+        let mut request = self.client.get(url);
+
+        if let Some(limit) = limit {
+            request = request.query(&[("limit", limit)]);
+        }
+
+        let response = match request.send().await {
+            Ok(resp) => resp,
+            Err(e) => return Err(JupiterClientError::RequestError(e)),
+        };
+
+        let response = handle_response(response).await?;
+
+        match response.json::<Vec<TokenInfo>>().await {
+            Ok(mints) => Ok(mints),
+            Err(e) => Err(JupiterClientError::DeserializationError(e.to_string())),
+        }
+    }
+
+    /// Returns an vec of mints that recently had their first created pool
+    /// Default to 30 mints in response
+    pub async fn get_recent_tokens(&self) -> Result<Vec<TokenInfo>, JupiterClientError> {
+        let url = format!("{}/tokens/v2/recent", self.base_url);
+
+        let response = match self.client.get(&url).send().await {
+            Ok(resp) => resp,
+            Err(e) => return Err(JupiterClientError::RequestError(e)),
+        };
+
+        let response = handle_response(response).await?;
+
+        match response.json::<Vec<TokenInfo>>().await {
+            Ok(mints) => Ok(mints),
+            Err(e) => Err(JupiterClientError::DeserializationError(e.to_string())),
+        }
+    }
+
+    /// Returns prices of specified tokens.
+    ///
+    /// ```
+    /// let client = JupiterClient::new("https://lite-api.jup.ag");
+    ///
+    /// let mints = vec![
+    ///     String::from("So11111111111111111111111111111111111111112"),
+    ///     String::from("JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN"),
+    /// ];
+    ///
+    /// let price = client.get_tokens_price(&mints).await.expect("failed to get token price");
+    /// let jup_price = price.get(&mints[1]).expect("jup not found").usd_price;
+    /// ```
+    pub async fn get_tokens_price(
+        &self,
+        mints: &[String],
+    ) -> Result<HashMap<String, Price>, JupiterClientError> {
+        let query_params = vec![("ids", mints.join(","))];
+
+        let response = match self
+            .client
+            .get(format!("{}/price/v3", self.base_url))
+            .query(&query_params)
+            .send()
+            .await
+        {
+            Ok(resp) => resp,
+            Err(e) => return Err(JupiterClientError::RequestError(e)),
+        };
+
+        let response = handle_response(response).await?;
+
+        match response.json::<HashMap<String, Price>>().await {
+            Ok(token_price) => Ok(token_price),
+            Err(e) => Err(JupiterClientError::DeserializationError(e.to_string())),
+        }
+    }
+
+    #[deprecated(note = "This endpoint is deprecated. use `get_tokens_price` instead")]
     /// Returns prices of specified tokens.
     /// ```
     /// let client = JupiterClient::new("https://lite-api.jup.ag")
@@ -52,6 +252,7 @@ impl JupiterClient {
         }
     }
 
+    #[deprecated]
     /// Returns the specified mint address's token information and metadata.
     ///
     /// ```
@@ -78,6 +279,7 @@ impl JupiterClient {
         }
     }
 
+    #[deprecated]
     /// Returns the mints involved in a market.
     pub async fn get_market_mints(
         &self,
@@ -100,6 +302,7 @@ impl JupiterClient {
         }
     }
 
+    #[deprecated]
     /// Returns a list of all mints tradable via Jupiter routing.
     /// This endpoint returns greater than 32MB amount of data. May take a while to complete.
     pub async fn get_tradable_mints(&self) -> Result<Vec<String>, JupiterClientError> {
@@ -117,34 +320,7 @@ impl JupiterClient {
         }
     }
 
-    /// Returns a list of mints with specified tag(s) along with their metadata.
-    /// tags: verified, lst, token-2022, etc
-    /// ```
-    ///
-    /// let tags = vec![String::from("verified")];
-    /// let tagged = client
-    /// .get_mints_by_tags(&tags)
-    ///    .await
-    ///    .expect("failed to get mints by tags");
-    /// ```
-    pub async fn get_mints_by_tags(
-        &self,
-        tags: &[String],
-    ) -> Result<Vec<TokenInfoResponse>, JupiterClientError> {
-        let url = format!("{}/tokens/v1/tagged/{}", self.base_url, tags.join(","));
-        let response = match self.client.get(&url).send().await {
-            Ok(resp) => resp,
-            Err(e) => return Err(JupiterClientError::RequestError(e)),
-        };
-
-        let response = handle_response(response).await?;
-
-        match response.json::<Vec<TokenInfoResponse>>().await {
-            Ok(mints) => Ok(mints),
-            Err(e) => Err(JupiterClientError::DeserializationError(e.to_string())),
-        }
-    }
-
+    #[deprecated(note = "This fn is deprecated. Use `get_recent_tokens` instead.")]
     /// get new tokens with metadata, created at timestamp and markets.
     pub async fn get_new_tokens(
         &self,
@@ -175,6 +351,7 @@ impl JupiterClient {
         }
     }
 
+    #[deprecated]
     /// Returns all tokens with all metadata.
     /// Do note that calling this endpoint's resource will return a large payload of 300+MB, which would introduce some latency in the call.
     /// Please use carefully and intentionally, else utilize the other endpoints.