borsa 0.2.0

High-level, pluggable market data API for Rust with multi-provider support.
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

use crate::Borsa;
use crate::borsa_router_method;

impl Borsa {
    borsa_router_method! {
        /// Fetch percentages for major holder categories.
        ///
        /// Notes: category definitions may vary across providers; values are passed
        /// through without normalization.
        method: major_holders(inst: &borsa_core::Instrument) -> Vec<borsa_core::MajorHolder>,
        provider: MajorHoldersProvider,
        accessor: as_major_holders_provider,
        capability: "major-holders",
        not_found: "holders",
        call: major_holders(inst)
    }

    borsa_router_method! {
        /// Fetch institutional holders.
        ///
        /// Behavior: lists can be large; pagination is handled by providers when
        /// present and results are combined.
        method: institutional_holders(inst: &borsa_core::Instrument) -> Vec<borsa_core::InstitutionalHolder>,
        provider: InstitutionalHoldersProvider,
        accessor: as_institutional_holders_provider,
        capability: "institutional-holders",
        not_found: "holders",
        call: institutional_holders(inst)
    }

    borsa_router_method! {
        /// Fetch mutual fund holders.
        method: mutual_fund_holders(inst: &borsa_core::Instrument) -> Vec<borsa_core::InstitutionalHolder>,
        provider: MutualFundHoldersProvider,
        accessor: as_mutual_fund_holders_provider,
        capability: "mutual-fund-holders",
        not_found: "holders",
        call: mutual_fund_holders(inst)
    }

    borsa_router_method! {
        /// Fetch insider transactions.
        ///
        /// Notes: reported insider activity may be delayed; fields reflect provider
        /// disclosures and are not audited.
        method: insider_transactions(inst: &borsa_core::Instrument) -> Vec<borsa_core::InsiderTransaction>,
        provider: InsiderTransactionsProvider,
        accessor: as_insider_transactions_provider,
        capability: "insider-transactions",
        not_found: "holders",
        call: insider_transactions(inst)
    }

    borsa_router_method! {
        /// Fetch the insider roster.
        method: insider_roster_holders(inst: &borsa_core::Instrument) -> Vec<borsa_core::InsiderRosterHolder>,
        provider: InsiderRosterHoldersProvider,
        accessor: as_insider_roster_holders_provider,
        capability: "insider-roster",
        not_found: "holders",
        call: insider_roster_holders(inst)
    }

    borsa_router_method! {
        /// Fetch net share purchase activity summary for insiders.
        ///
        /// Behavior: returns `None` when a provider offers no aggregate; consumers
        /// should handle optionality.
        method: net_share_purchase_activity(inst: &borsa_core::Instrument) -> Option<borsa_core::NetSharePurchaseActivity>,
        provider: NetSharePurchaseActivityProvider,
        accessor: as_net_share_purchase_activity_provider,
        capability: "net-share-purchase-activity",
        not_found: "holders",
        call: net_share_purchase_activity(inst)
    }
}