parcllabs 0.1.3

Rust SDK for the Parcl Labs API - Real-time U.S. housing market data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Price feed endpoints for Parcl exchange trading data.

use crate::endpoints::market_metrics::MetricsParams;
use crate::error::Result;
use crate::models::{BatchMetricsResponse, MetricsResponse, PriceFeedEntry};
use crate::ParclClient;

/// Client for price feed API endpoints.
pub struct PriceFeedClient<'a> {
    client: &'a ParclClient,
}

impl<'a> PriceFeedClient<'a> {
    pub(crate) fn new(client: &'a ParclClient) -> Self {
        Self { client }
    }

    /// Retrieves historical price feed data for a market.
    pub async fn history(
        &self,
        parcl_id: i64,
        params: Option<MetricsParams>,
    ) -> Result<MetricsResponse<PriceFeedEntry>> {
        let params = params.unwrap_or_default();
        let url = format!(
            "{}/v1/price_feed/{}/history{}",
            self.client.base_url,
            parcl_id,
            params.to_query_string()
        );
        let resp = super::common::get_with_pagination(
            &self.client.http,
            &self.client.api_key,
            &url,
            params.auto_paginate,
            &self.client.retry_config,
        )
        .await?;
        self.client.update_credits(&resp.account);
        Ok(resp)
    }

    /// Retrieves historical rental price feed data for a market.
    pub async fn rental_history(
        &self,
        parcl_id: i64,
        params: Option<MetricsParams>,
    ) -> Result<MetricsResponse<PriceFeedEntry>> {
        let params = params.unwrap_or_default();
        let url = format!(
            "{}/v1/price_feed/{}/rental_price_feed{}",
            self.client.base_url,
            parcl_id,
            params.to_query_string()
        );
        let resp = super::common::get_with_pagination(
            &self.client.http,
            &self.client.api_key,
            &url,
            params.auto_paginate,
            &self.client.retry_config,
        )
        .await?;
        self.client.update_credits(&resp.account);
        Ok(resp)
    }

    // --- Batch POST methods ---

    /// Batch retrieves historical price feed data for multiple markets.
    pub async fn batch_history(
        &self,
        parcl_ids: Vec<i64>,
        params: Option<MetricsParams>,
    ) -> Result<BatchMetricsResponse<PriceFeedEntry>> {
        let params = params.unwrap_or_default();
        let body = params.to_batch_body(&parcl_ids);
        let url = format!("{}/v1/price_feed/history", self.client.base_url);
        let resp = super::common::post_with_pagination(
            &self.client.http,
            &self.client.api_key,
            &url,
            &body,
            params.auto_paginate,
            &self.client.retry_config,
        )
        .await?;
        self.client.update_credits(&resp.account);
        Ok(resp)
    }

    /// Batch retrieves historical rental price feed data for multiple markets.
    pub async fn batch_rental_history(
        &self,
        parcl_ids: Vec<i64>,
        params: Option<MetricsParams>,
    ) -> Result<BatchMetricsResponse<PriceFeedEntry>> {
        let params = params.unwrap_or_default();
        let body = params.to_batch_body(&parcl_ids);
        let url = format!("{}/v1/price_feed/rental_price_feed", self.client.base_url);
        let resp = super::common::post_with_pagination(
            &self.client.http,
            &self.client.api_key,
            &url,
            &body,
            params.auto_paginate,
            &self.client.retry_config,
        )
        .await?;
        self.client.update_credits(&resp.account);
        Ok(resp)
    }
}