ticksupply 0.1.0

Official Rust client for the Ticksupply market data API
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

# Ticksupply Rust Client

[![crates.io](https://img.shields.io/crates/v/ticksupply.svg)](https://crates.io/crates/ticksupply)
[![docs.rs](https://docs.rs/ticksupply/badge.svg)](https://docs.rs/ticksupply)

Official Rust client for the [Ticksupply](https://ticksupply.com) market data API.

## Installation

```toml
[dependencies]
ticksupply = "0.1"
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
```

Minimum Supported Rust Version: **1.75**.

## Quick Start

```rust
use ticksupply::Client;

#[tokio::main]
async fn main() -> ticksupply::Result<()> {
    // Reads TICKSUPPLY_API_KEY from the environment.
    let client = Client::new()?;

    for exchange in client.exchanges().list().await? {
        println!("{}: {}", exchange.code, exchange.display_name);
    }

    // Create a subscription.
    let sub = client.subscriptions().create(12_345).send().await?;

    // Manage it.
    client.subscriptions().pause(&sub.id).send().await?;
    client.subscriptions().resume(&sub.id).send().await?;
    client.subscriptions().delete(&sub.id).send().await?;

    Ok(())
}
```

## Configuration

| Field          | Default                           | How to set                                              |
|----------------|-----------------------------------|---------------------------------------------------------|
| `api_key`      | `$TICKSUPPLY_API_KEY` (required)  | `Client::with_api_key(...)` or `.api_key(...)`          |
| `base_url`     | `https://api.ticksupply.com/v1`   | `.base_url(...)`                                        |
| `timeout`      | 30 s                              | `.timeout(Duration::from_secs(60))`                     |
| `max_retries`  | 3                                 | `.max_retries(5)`                                       |
| `user_agent`   | `ticksupply-rust/<version>`       | `.user_agent("my-bot/1.2")` (appended to prefix)        |
| `http_client`  | internal `reqwest::Client`        | `.http_client(custom)` — for proxies / custom TLS       |

```rust
use std::time::Duration;
let client = ticksupply::Client::builder()
    .api_key("key_xxx.secret")
    .timeout(Duration::from_secs(60))
    .max_retries(5)
    .build()?;
```

## Resources

- `client.exchanges()` — exchanges and per-exchange instruments
- `client.datastreams()` — datastream catalog with filters across exchanges/instruments
- `client.subscriptions()` — manage subscriptions
- `client.exports()` — create and download historical exports
- `client.availability()` — query data availability
- `client.export_schemas()` — list, inspect, and delete saved output schemas. Creating or editing saved schemas is not yet in the Rust SDK; for custom columns today, pass a schema object to `client.exports().create(...).inline_schema(...)`. Full CRUD (including the draft → publish flow the Python client exposes) is planned for a future release.
- `client.billing()` — inspect plan, access status, usage

## Error Handling

```rust
use ticksupply::{Client, Error};

async fn demo(client: &Client) {
    match client.subscriptions().get("sub_invalid").await {
        Ok(sub) => println!("{:?}", sub),
        Err(Error::NotFound { message, request_id }) => {
            eprintln!("not found: {message} (req_id={request_id:?})");
        }
        Err(Error::RateLimited { retry_after, .. }) => {
            eprintln!("backoff for {retry_after:?}s");
        }
        Err(e) => eprintln!("other error: {e}"),
    }
}
```

## Feature Flags

| Feature        | Default | Purpose                                                                |
|----------------|---------|------------------------------------------------------------------------|
| `chrono`       | yes     | Accept / produce `chrono::DateTime<Utc>` values.                       |
| `time`         | no      | Accept / produce `time::OffsetDateTime` values.                        |
| `rust_decimal` | no      | Parse `Decimal` wire values into `rust_decimal::Decimal` losslessly.   |

Disable defaults when you only need raw `i64` nanoseconds:

```toml
ticksupply = { version = "0.1", default-features = false }
```

## Development

```bash
cargo build --all-features
cargo test --all-features
cargo clippy --all-features -- -D warnings
cargo fmt --all
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-features
```

## License

MIT