Add MempoolClient::get_address

Author: yukibtc

Cargo.lock

@@ -6,6 +6,7 @@ edition = "2024"
 # TODO: add socks feature
 
 [dependencies]
+bitcoin = { version = "0.32", default-features = false, features = ["std", "serde"] }
 reqwest = { version = "0.12", features = ["json"] }
 serde = { version = "1.0", features = ["derive"] }
 url = "2.5"

Cargo.toml

@@ -1,3 +1,5 @@
+use std::str::FromStr;
+
 use mempoolspace::prelude::*;
 
 #[tokio::main]
@@ -8,4 +10,10 @@ async fn main() {
     // Get prices
     let prices = client.get_prices().await.unwrap();
     println!("{:?}", prices);
+
+    // Get prices
+    let address = Address::from_str("1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv").unwrap();
+    let address = address.assume_checked();
+    let stats = client.get_address(&address).await.unwrap();
+    println!("{:?}", stats);
 }

examples/mempool.rs

@@ -1,10 +1,11 @@
 //! Client
 
+use bitcoin::Address;
 use reqwest::{Client, Response};
 use url::Url;
 
 use crate::error::Error;
-use crate::response::{DifficultyAdjustment, Prices};
+use crate::response::{AddressStats, DifficultyAdjustment, Prices};
 
 /// Mempool Space client
 pub struct MempoolClient {
@@ -44,4 +45,14 @@ impl MempoolClient {
         let response: Response = self.client.get(url).send().await?;
         Ok(response.json().await?)
     }
+
+    /// Get details about an address.
+    pub async fn get_address(&self, address: &Address) -> Result<AddressStats, Error> {
+        let url: Url = self
+            .url
+            .join("/api/address/")?
+            .join(address.to_string().as_str())?;
+        let response: Response = self.client.get(url).send().await?;
+        Ok(response.json().await?)
+    }
 }

src/client.rs

@@ -4,6 +4,7 @@
 #![allow(ambiguous_glob_reexports)]
 #![doc(hidden)]
 
+pub use bitcoin::*;
 pub use url::*;
 
 pub use crate::client::*;

src/prelude.rs

@@ -1,5 +1,7 @@
 //! Responses
 
+use bitcoin::Amount;
+use bitcoin::address::{Address, NetworkUnchecked};
 use serde::{Deserialize, Serialize};
 
 /// Prices
@@ -64,3 +66,29 @@ pub struct DifficultyAdjustment {
     #[serde(rename = "timeOffset")]
     pub time_offset: i64,
 }
+
+/// Bitcoin address statistics
+#[derive(Debug, Serialize, Deserialize)]
+pub struct AddressStats {
+    /// Bitcoin address
+    pub address: Address<NetworkUnchecked>,
+    /// On-chain statistics
+    pub chain_stats: TransactionStats,
+    /// Mempool statistics
+    pub mempool_stats: TransactionStats,
+}
+
+/// Transaction statistics for an address
+#[derive(Debug, Serialize, Deserialize)]
+pub struct TransactionStats {
+    /// Number of funded transaction outputs
+    pub funded_txo_count: u32,
+    /// Total amount of funded transaction outputs
+    pub funded_txo_sum: Amount,
+    /// Number of spent transaction outputs
+    pub spent_txo_count: u32,
+    /// Total amount of spent transaction outputs
+    pub spent_txo_sum: Amount,
+    /// Total number of transactions
+    pub tx_count: u32,
+}