# `quiverquant.rs`: 

[![crates.io](https://img.shields.io/crates/v/quiverquant.svg)](https://crates.io/crates/quiverquant)
[![Docs](https://docs.rs/quiverquant/badge.svg)][docs-rs]
[![rustc](https://img.shields.io/badge/rustc-1.44+-blue.svg)](https://blog.rust-lang.org/2020/06/18/Rust.1.44.1.html)
[![License](https://img.shields.io/crates/l/quiverquant)](https://raw.githubusercontent.com/ajmwagar/quiverquant/master/LICENSE)

An API Wrapper for the [QuiverQuant Data API][quiverquant-doc].


## Features
- Full QuiverQuant Tier 1 & Tier 2 API Support
- `async`/`.await` support (regardless of runtime)
- `serde` support for all data-types.
- Set the API URL to point at a another server for back-testing.

## Getting Started

1. You'll need an API Key from QuiverQuant. Get one [here][quiverquant-api]
2. QuiverQuant has two tiers, one is $10 a month, and the other is $75. Some API methods need a Tier 2 API Key. See [QuiverQuant's Documentation][quiverquant-doc] for more info.

```toml
[dependencies]
quiverquant = "1"
tokio = { version = "1", features = ["macros"] } # Note: async-std may be used as well
```

```rust
use quiverquant::Client;

#[tokio::main]
async fn main() {
  let client = Client::new("<api-key>");
  let trades = client.congress_trades().await;
}
```
> Get recent trades from Congressional members

```rust
use quiverquant::Client;

#[tokio::main]
async fn main() {
  let client = Client::new("<api-key>");
  let trades = client.congress_trades_by_ticker("TSLA").await;
}
```
> Get recent TSLA trades from Congressional members

Want to run these examples in your terminal?

```bash
git clone git@github.com:ajmwagar/quiverquant.rs
cd quiverquant.rs
QQ_API_KEY=<api_key> cargo run --example congress
```

See the full example [here][example-congress].

Please refer to the full [documentation][docs-rs] for more details.

## Development

### Testing

Run tests with: `QQ_API_KEY=<api_key> cargo test`

### Issues & PRs

Both are accepted and appreciated. `Much <3`.

[example-congress]: https://github.com/ajmwagar/quiverquant.rs/blob/main/examples/congress.rs
[docs-rs]: https://docs.rs/crate/quiverquant
[quiverquant]: https://quiverquant.com
[quiverquant-doc]: https://api.quiverquant.com/docs/