rusty-fmp 0.5.3

JSON CLI and client library for Financial Modeling Prep
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

//! Analyst command group.

use clap::Subcommand;

use crate::cli::args::SymbolArgs;
use crate::cli::dispatch::{run_by_symbol, unavailable_endpoint};
use crate::cli::help;
use crate::cli::output::CommandPayload;
use crate::client::FmpClient;
use crate::endpoint;
use crate::error::Result;

/// Analyst command variants.
#[derive(Debug, Subcommand)]
pub(crate) enum Cmd {
    /// Get analyst price target consensus for a stock ticker.
    #[command(
        about = help::ANALYST_PRICE_TARGET_CONSENSUS_ABOUT,
        long_about = help::ANALYST_PRICE_TARGET_CONSENSUS_LONG
    )]
    PriceTargetConsensus(SymbolArgs),

    /// Get analyst price target summary for a stock ticker.
    #[command(
        about = help::ANALYST_PRICE_TARGET_SUMMARY_ABOUT,
        long_about = help::ANALYST_PRICE_TARGET_SUMMARY_LONG
    )]
    PriceTargetSummary(SymbolArgs),

    /// Get analyst grade action history for a stock ticker.
    #[command(about = help::ANALYST_GRADES_ABOUT, long_about = help::ANALYST_GRADES_LONG)]
    Grades(SymbolArgs),

    /// Get analyst upgrades and downgrades for a stock ticker.
    #[command(
        about = help::ANALYST_UPGRADES_DOWNGRADES_ABOUT,
        long_about = help::ANALYST_UPGRADES_DOWNGRADES_LONG
    )]
    UpgradesDowngrades(SymbolArgs),

    /// Get a snapshot of current analyst ratings for a stock ticker.
    #[command(
        about = help::ANALYST_RATINGS_SNAPSHOT_ABOUT,
        long_about = help::ANALYST_RATINGS_SNAPSHOT_LONG
    )]
    RatingsSnapshot(SymbolArgs),

    /// Get earnings surprises for a stock ticker.
    #[command(
        about = help::ANALYST_EARNINGS_SURPRISES_ABOUT,
        long_about = help::ANALYST_EARNINGS_SURPRISES_LONG
    )]
    EarningsSurprises(SymbolArgs),

    /// Get analyst price targets for a stock ticker.
    #[command(
        about = help::ANALYST_PRICE_TARGET_ABOUT,
        long_about = help::ANALYST_PRICE_TARGET_LONG
    )]
    PriceTarget(SymbolArgs),
}

/// Dispatch an analyst command.
pub(crate) async fn dispatch(client: &FmpClient, cmd: &Cmd) -> Result<CommandPayload> {
    match cmd {
        Cmd::PriceTargetConsensus(args) => {
            run_by_symbol(client, endpoint::PRICE_TARGET_CONSENSUS, &args.symbol).await
        }
        Cmd::PriceTargetSummary(args) => {
            run_by_symbol(client, endpoint::PRICE_TARGET_SUMMARY, &args.symbol).await
        }
        Cmd::Grades(args) => run_by_symbol(client, endpoint::GRADES, &args.symbol).await,
        Cmd::UpgradesDowngrades(_) => unavailable_endpoint(
            endpoint::UPGRADES_DOWNGRADES.path(),
            "FMP only documents upgrades and downgrades as a legacy endpoint; use `analyst grades` for the stable analyst grade actions endpoint",
        ),
        Cmd::RatingsSnapshot(args) => {
            run_by_symbol(client, endpoint::RATINGS_SNAPSHOT, &args.symbol).await
        }
        Cmd::EarningsSurprises(_) => unavailable_endpoint(
            endpoint::EARNINGS_SURPRISES.path(),
            "FMP only documents symbol earnings surprises as a legacy endpoint; no stable per-symbol API path is available for this command",
        ),
        Cmd::PriceTarget(_) => unavailable_endpoint(
            endpoint::PRICE_TARGET.path(),
            "FMP only documents historical price targets as a legacy endpoint; use `analyst price-target-consensus` or `analyst price-target-summary` for stable price target data",
        ),
    }
}