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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Company data command group.

use clap::Subcommand;

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

/// Company data subcommands.
#[derive(Debug, Subcommand)]
pub(crate) enum Cmd {
    /// Get company profile for a stock ticker.
    #[command(
        about = help::COMPANY_PROFILE_ABOUT,
        long_about = help::COMPANY_PROFILE_LONG
    )]
    Profile(SymbolArgs),

    /// Get key executives for a stock ticker.
    #[command(
        about = help::COMPANY_EXECUTIVES_ABOUT,
        long_about = help::COMPANY_EXECUTIVES_LONG
    )]
    Executives(SymbolArgs),

    /// Get peer company tickers for a stock ticker.
    #[command(
        about = help::COMPANY_PEERS_ABOUT,
        long_about = help::COMPANY_PEERS_LONG
    )]
    Peers(SymbolArgs),

    /// Get financial quality scores for a company.
    #[command(
        about = help::COMPANY_FINANCIAL_SCORES_ABOUT,
        long_about = help::COMPANY_FINANCIAL_SCORES_LONG
    )]
    Scores(SymbolArgs),

    /// Get share float data for a stock ticker.
    #[command(
        about = help::COMPANY_SHARE_FLOAT_ABOUT,
        long_about = help::COMPANY_SHARE_FLOAT_LONG
    )]
    Float(SymbolArgs),

    /// Get analyst rating consensus for a stock ticker.
    #[command(
        about = help::COMPANY_RATING_ABOUT,
        long_about = help::COMPANY_RATING_LONG
    )]
    Rating(SymbolArgs),

    /// Get historical company ratings for a stock ticker.
    #[command(
        about = help::COMPANY_HISTORICAL_RATING_ABOUT,
        long_about = help::COMPANY_HISTORICAL_RATING_LONG
    )]
    HistoricalRating(SymbolLimitArgs),

    /// Get comprehensive company outlook for a stock ticker.
    #[command(
        about = help::COMPANY_OUTLOOK_ABOUT,
        long_about = help::COMPANY_OUTLOOK_LONG
    )]
    Outlook(SymbolArgs),

    /// List delisted companies.
    #[command(
        about = help::COMPANY_DELISTED_ABOUT,
        long_about = help::COMPANY_DELISTED_LONG
    )]
    Delisted(PagedArgs),
}

/// Dispatch a company subcommand.
pub(crate) async fn dispatch(client: &FmpClient, cmd: &Cmd) -> Result<CommandPayload> {
    match cmd {
        Cmd::Profile(args) => run_by_symbol(client, crate::endpoint::PROFILE, &args.symbol).await,
        Cmd::Executives(args) => {
            run_by_symbol(client, crate::endpoint::KEY_EXECUTIVES, &args.symbol).await
        }
        Cmd::Peers(args) => run_by_symbol(client, crate::endpoint::STOCK_PEERS, &args.symbol).await,
        Cmd::Scores(args) => {
            run_by_symbol(client, crate::endpoint::FINANCIAL_SCORES, &args.symbol).await
        }
        Cmd::Float(args) => {
            run_by_symbol(client, crate::endpoint::SHARES_FLOAT, &args.symbol).await
        }
        Cmd::Rating(args) => {
            run_by_symbol(client, crate::endpoint::GRADES_CONSENSUS, &args.symbol).await
        }
        Cmd::HistoricalRating(args) => {
            run_by_symbol_limit(
                client,
                crate::endpoint::RATINGS_HISTORICAL,
                &args.symbol,
                args.limit,
            )
            .await
        }
        Cmd::Outlook(_) => unavailable_endpoint(
            crate::endpoint::COMPANY_OUTLOOK.path(),
            "FMP only documents company outlook as a legacy endpoint; no stable API path is available for this command",
        ),
        Cmd::Delisted(args) => {
            run_paged(
                client,
                crate::endpoint::DELISTED_COMPANIES,
                args.page,
                args.limit,
            )
            .await
        }
    }
}