borsa-alphavantage 0.2.0

Alpha Vantage API connector for the borsa ecosystem.
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

# borsa-alphavantage

[![Crates.io](https://img.shields.io/crates/v/borsa-alphavantage)](https://crates.io/crates/borsa-alphavantage)
[![Docs.rs](https://docs.rs/borsa-alphavantage/badge.svg)](https://docs.rs/borsa-alphavantage)
[![Downloads](https://img.shields.io/crates/d/borsa-alphavantage)](https://crates.io/crates/borsa-alphavantage)
[![License](https://img.shields.io/crates/l/borsa-alphavantage)](https://crates.io/crates/borsa-alphavantage)

Alpha Vantage connector for the borsa financial data ecosystem.

## Overview

`borsa-alphavantage` implements the `BorsaConnector` trait using the Alpha Vantage API to provide quotes, historical data, and fundamentals.

This connector is experimental and lightly tested due to API key requirements. Maintenance is best‑effort: I review PRs and may update when time allows, so it may lag behind breaking `borsa` releases. Treat it as a proof of concept and validate for your workloads before relying on it in production.

## Installation

```toml
[dependencies]
borsa-alphavantage = "0.2.0"
borsa-core = "0.2.0"
```

## Usage

Refer to the main `borsa` crate for how to register connectors. This crate implements `BorsaConnector` and can be added to a `borsa` client builder.

> **Feature flag:** Closure-based adapter helpers (for dependency-free tests) live behind the
> optional `test-adapters` feature. Enable it in `Cargo.toml` or via
> `cargo test --features borsa-alphavantage/test-adapters` whenever you depend on the mocks.

### Examples

Run a local example that loads your Alpha Vantage API key from a `.env` file.

1. Create a `.env` file at the repo root with:

   ```dotenv
   ALPHAVANTAGE_API_KEY=your_api_key_here
   ```

2. Run the showcase example:

   ```bash
   cargo run --example showcase
   ```

This will demonstrate quotes, history, search, earnings, and a simple forex request using `AvConnector`.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md). Please also read our [Code of Conduct](CODE_OF_CONDUCT.md).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.