the-odds-api 0.2.0

A Rust SDK for The Odds API - sports odds and scores
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
//! End-to-end tests that hit the real Odds API.
//!
//! All tests are marked `#[ignore]` so they only run explicitly.
//! Run with `--test-threads=1` to avoid rate limiting:
//!
//! ```sh
//! ODDS_API_KEY=your_key cargo test --test e2e -- --ignored --test-threads=1
//! ```

use chrono::{Duration, Utc};
use the_odds_api::{Error, Market, OddsFormat, Region, TheOddsApiClient};

/// Create a client from the `ODDS_API_KEY` env var (loaded from `.env` if present).
fn client() -> TheOddsApiClient {
    let _ = dotenvy::dotenv();
    let api_key =
        std::env::var("ODDS_API_KEY").expect("ODDS_API_KEY must be set in .env or environment");
    TheOddsApiClient::new(api_key)
}

/// Returns true (and prints a message) if the error is a rate limit or plan
/// restriction, so the test can skip gracefully.
fn should_skip(err: &Error) -> bool {
    match err {
        Error::RateLimited { .. } => {
            eprintln!("  SKIPPED: rate limited — try again later or upgrade API plan");
            true
        }
        Error::Unauthorized => {
            eprintln!("  SKIPPED: unauthorized — endpoint may require a paid plan");
            true
        }
        _ => false,
    }
}

/// Unwrap a Result, skipping the test on rate limit / unauthorized errors.
macro_rules! unwrap_or_skip {
    ($result:expr) => {
        match $result {
            Ok(v) => v,
            Err(ref e) if should_skip(e) => return,
            Err(e) => panic!("unexpected error: {e}"),
        }
    };
}

// =============================================================================
// Free endpoints (no quota cost)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_sports() {
    let resp = unwrap_or_skip!(client().get_sports().await);

    assert!(!resp.data.is_empty(), "should return at least one sport");

    let sport = &resp.data[0];
    assert!(!sport.key.is_empty(), "sport key should be non-empty");
    assert!(!sport.title.is_empty(), "sport title should be non-empty");
    assert!(!sport.group.is_empty(), "sport group should be non-empty");
    assert!(
        !sport.description.is_empty(),
        "sport description should be non-empty"
    );

    // get_sports (without all=true) should only return active sports
    for s in &resp.data {
        assert!(s.active, "get_sports should only return active sports");
    }
}

#[tokio::test]
#[ignore]
async fn test_get_all_sports() {
    let client = client();
    let resp = unwrap_or_skip!(client.get_all_sports().await);

    assert!(!resp.data.is_empty(), "should return at least one sport");

    let active_count = resp.data.iter().filter(|s| s.active).count();
    let inactive_count = resp.data.iter().filter(|s| !s.active).count();

    assert!(active_count > 0, "should have at least one active sport");
    assert!(
        inactive_count > 0,
        "all sports should include at least one inactive sport"
    );
}

#[tokio::test]
#[ignore]
async fn test_get_events() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty(), "need at least one active sport");
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(client.get_events(sport_key).send().await);

    for event in &resp.data {
        assert!(!event.id.is_empty(), "event id should be non-empty");
        assert_eq!(
            &event.sport_key, sport_key,
            "event sport_key should match requested sport"
        );
        assert!(
            !event.sport_title.is_empty(),
            "event sport_title should be non-empty"
        );
    }
}

#[tokio::test]
#[ignore]
async fn test_get_events_with_time_filter() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let now = Utc::now();
    let in_a_week = now + Duration::days(7);

    let resp = unwrap_or_skip!(
        client
            .get_events(sport_key)
            .commence_time_from(now)
            .commence_time_to(in_a_week)
            .send()
            .await
    );

    for event in &resp.data {
        assert!(
            event.commence_time >= now - Duration::seconds(1),
            "event commence_time {} should be >= now {}",
            event.commence_time,
            now
        );
        assert!(
            event.commence_time <= in_a_week + Duration::seconds(1),
            "event commence_time {} should be <= in_a_week {}",
            event.commence_time,
            in_a_week
        );
    }
}

// =============================================================================
// Odds endpoint (costs: markets × regions)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_odds() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(
        client
            .get_odds(sport_key)
            .regions(&[Region::Us])
            .markets(&[Market::H2h])
            .send()
            .await
    );

    assert!(
        resp.usage.requests_remaining.is_some(),
        "requests_remaining should be present"
    );
    assert!(
        resp.usage.requests_used.is_some(),
        "requests_used should be present"
    );

    for event in &resp.data {
        assert!(!event.id.is_empty());
        assert_eq!(&event.sport_key, sport_key);
        assert!(!event.sport_title.is_empty());

        for bookmaker in &event.bookmakers {
            assert!(!bookmaker.key.is_empty(), "bookmaker key should be non-empty");
            assert!(
                !bookmaker.title.is_empty(),
                "bookmaker title should be non-empty"
            );
            assert!(
                !bookmaker.markets.is_empty(),
                "bookmaker should have at least one market"
            );

            for market in &bookmaker.markets {
                assert_eq!(market.key, "h2h", "requested h2h market");
                assert!(
                    !market.outcomes.is_empty(),
                    "market should have at least one outcome"
                );
                for outcome in &market.outcomes {
                    assert!(!outcome.name.is_empty(), "outcome name should be non-empty");
                    assert!(outcome.price > 0.0, "decimal odds should be positive");
                }
            }
        }
    }
}

#[tokio::test]
#[ignore]
async fn test_get_odds_missing_regions_errors() {
    let client = client();

    let result = client.get_odds("americanfootball_nfl").send().await;

    assert!(result.is_err(), "should error without regions");
    assert!(
        matches!(
            result.unwrap_err(),
            the_odds_api::Error::MissingParameter("regions")
        ),
        "should be MissingParameter(regions)"
    );
}

#[tokio::test]
#[ignore]
async fn test_get_odds_american_format() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(
        client
            .get_odds(sport_key)
            .regions(&[Region::Us])
            .markets(&[Market::H2h])
            .odds_format(OddsFormat::American)
            .send()
            .await
    );

    for event in &resp.data {
        for bookmaker in &event.bookmakers {
            for market in &bookmaker.markets {
                for outcome in &market.outcomes {
                    assert!(
                        outcome.price.abs() >= 100.0,
                        "American odds should have absolute value >= 100, got {}",
                        outcome.price
                    );
                }
            }
        }
    }
}

#[tokio::test]
#[ignore]
async fn test_get_odds_spreads() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(
        client
            .get_odds(sport_key)
            .regions(&[Region::Us])
            .markets(&[Market::Spreads])
            .send()
            .await
    );

    for event in &resp.data {
        for bookmaker in &event.bookmakers {
            for market in &bookmaker.markets {
                assert_eq!(market.key, "spreads");
                for outcome in &market.outcomes {
                    assert!(
                        outcome.point.is_some(),
                        "spreads outcomes should have a point value"
                    );
                }
            }
        }
    }
}

// =============================================================================
// Scores endpoint (costs: 1, or 2 with days_from)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_scores() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(client.get_scores(sport_key).send().await);

    for event in &resp.data {
        assert!(!event.id.is_empty());
        assert_eq!(&event.sport_key, sport_key);
        assert!(!event.sport_title.is_empty());
    }
}

#[tokio::test]
#[ignore]
async fn test_get_scores_with_days_from() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(client.get_scores(sport_key).days_from(3).send().await);

    for event in &resp.data {
        assert!(!event.id.is_empty());
        if event.completed {
            assert!(
                event.scores.is_some(),
                "completed event {} should have scores",
                event.id
            );
            let scores = event.scores.as_ref().unwrap();
            for score in scores {
                assert!(!score.name.is_empty(), "score name should be non-empty");
            }
        }
    }
}

// =============================================================================
// Event Odds endpoint (costs: markets × regions)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_event_odds() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let events = unwrap_or_skip!(client.get_events(sport_key).send().await);
    if events.data.is_empty() {
        eprintln!("  SKIPPED: no events available for {sport_key}");
        return;
    }
    let event_id = &events.data[0].id;

    let resp = unwrap_or_skip!(
        client
            .get_event_odds(sport_key, event_id)
            .regions(&[Region::Us])
            .markets(&[Market::H2h])
            .send()
            .await
    );

    assert_eq!(&resp.data.id, event_id, "event id should match requested");
    assert_eq!(&resp.data.sport_key, sport_key);
    assert!(!resp.data.sport_title.is_empty());

    for bookmaker in &resp.data.bookmakers {
        assert!(!bookmaker.key.is_empty());
        assert!(!bookmaker.title.is_empty());
        assert!(!bookmaker.markets.is_empty());
    }
}

#[tokio::test]
#[ignore]
async fn test_get_event_odds_missing_regions_errors() {
    let client = client();

    let result = client
        .get_event_odds("americanfootball_nfl", "fake_event_id")
        .send()
        .await;

    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        the_odds_api::Error::MissingParameter("regions")
    ));
}

// =============================================================================
// Event Markets endpoint (costs: 1)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_event_markets() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let events = unwrap_or_skip!(client.get_events(sport_key).send().await);
    if events.data.is_empty() {
        eprintln!("  SKIPPED: no events available for {sport_key}");
        return;
    }
    let event_id = &events.data[0].id;

    let resp = unwrap_or_skip!(
        client
            .get_event_markets(sport_key, event_id)
            .regions(&[Region::Us])
            .send()
            .await
    );

    assert_eq!(&resp.data.id, event_id);
    assert_eq!(&resp.data.sport_key, sport_key);

    for bookmaker in &resp.data.bookmakers {
        assert!(!bookmaker.key.is_empty());
        assert!(!bookmaker.title.is_empty());
        assert!(
            !bookmaker.markets.is_empty(),
            "bookmaker {} should list at least one market",
            bookmaker.key
        );
        for market in &bookmaker.markets {
            assert!(!market.key.is_empty(), "market key should be non-empty");
        }
    }
}

// =============================================================================
// Participants endpoint (costs: 1)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_participants() {
    let client = client();

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(client.get_participants(sport_key).await);

    assert!(
        !resp.data.is_empty(),
        "should return at least one participant"
    );

    for participant in &resp.data {
        assert!(
            !participant.id.is_empty(),
            "participant id should be non-empty"
        );
        assert!(
            !participant.full_name.is_empty(),
            "participant full_name should be non-empty"
        );
    }
}

// =============================================================================
// Historical Events endpoint (costs: 1)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_historical_events() {
    let client = client();

    let past_date = Utc::now() - Duration::days(7);

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(
        client
            .get_historical_events(sport_key)
            .date(past_date)
            .send()
            .await
    );

    let hist = &resp.data;
    for event in &hist.data {
        assert!(!event.id.is_empty());
        assert_eq!(&event.sport_key, sport_key);
        assert!(!event.sport_title.is_empty());
    }
}

#[tokio::test]
#[ignore]
async fn test_get_historical_events_missing_date_errors() {
    let client = client();

    let result = client
        .get_historical_events("americanfootball_nfl")
        .send()
        .await;

    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        the_odds_api::Error::MissingParameter("date")
    ));
}

// =============================================================================
// Historical Odds endpoint (costs: 10 × markets × regions)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_historical_odds() {
    let client = client();

    let past_date = Utc::now() - Duration::days(7);

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let resp = unwrap_or_skip!(
        client
            .get_historical_odds(sport_key)
            .date(past_date)
            .regions(&[Region::Us])
            .markets(&[Market::H2h])
            .send()
            .await
    );

    let hist = &resp.data;
    for event in &hist.data {
        assert!(!event.id.is_empty());
        assert_eq!(&event.sport_key, sport_key);
        for bookmaker in &event.bookmakers {
            assert!(!bookmaker.key.is_empty());
            for market in &bookmaker.markets {
                assert_eq!(market.key, "h2h");
                for outcome in &market.outcomes {
                    assert!(!outcome.name.is_empty());
                    assert!(outcome.price > 0.0);
                }
            }
        }
    }
}

#[tokio::test]
#[ignore]
async fn test_get_historical_odds_missing_params_errors() {
    let client = client();

    // Missing both date and regions
    let result = client
        .get_historical_odds("americanfootball_nfl")
        .send()
        .await;
    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        the_odds_api::Error::MissingParameter("date")
    ));

    // Has date but missing regions
    let result = client
        .get_historical_odds("americanfootball_nfl")
        .date(Utc::now() - Duration::days(7))
        .send()
        .await;
    assert!(result.is_err());
    assert!(matches!(
        result.unwrap_err(),
        the_odds_api::Error::MissingParameter("regions")
    ));
}

// =============================================================================
// Historical Event Odds endpoint (costs: markets × regions)
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_get_historical_event_odds() {
    let client = client();

    let past_date = Utc::now() - Duration::days(7);

    let sports = unwrap_or_skip!(client.get_sports().await);
    assert!(!sports.data.is_empty());
    let sport_key = &sports.data[0].key;

    let hist_events = unwrap_or_skip!(
        client
            .get_historical_events(sport_key)
            .date(past_date)
            .send()
            .await
    );

    if hist_events.data.data.is_empty() {
        eprintln!("  SKIPPED: no historical events for {sport_key} at {past_date}");
        return;
    }
    let event_id = &hist_events.data.data[0].id;
    let snapshot_date = hist_events.data.timestamp;

    let resp = unwrap_or_skip!(
        client
            .get_historical_event_odds(sport_key, event_id)
            .date(snapshot_date)
            .regions(&[Region::Us])
            .markets(&[Market::H2h])
            .send()
            .await
    );

    let hist = &resp.data;
    assert_eq!(&hist.data.id, event_id);
    assert_eq!(&hist.data.sport_key, sport_key);
}

// =============================================================================
// Client configuration
// =============================================================================

#[tokio::test]
#[ignore]
async fn test_unauthorized_with_bad_key() {
    let client = TheOddsApiClient::new("invalid_api_key_12345");

    let result = client.get_sports().await;

    assert!(result.is_err(), "bad API key should return an error");
    assert!(
        matches!(result.unwrap_err(), the_odds_api::Error::Unauthorized),
        "should be Unauthorized error"
    );
}

#[tokio::test]
#[ignore]
async fn test_builder_with_custom_base_url() {
    let _ = dotenvy::dotenv();
    let api_key =
        std::env::var("ODDS_API_KEY").expect("ODDS_API_KEY must be set in .env or environment");

    let client = TheOddsApiClient::builder(&api_key)
        .base_url("https://api.the-odds-api.com")
        .build();

    let resp = unwrap_or_skip!(client.get_sports().await);
    assert!(!resp.data.is_empty());
}

#[tokio::test]
#[ignore]
async fn test_upcoming_odds() {
    let client = client();

    let resp = unwrap_or_skip!(
        client
            .get_upcoming_odds()
            .regions(&[Region::Us])
            .markets(&[Market::H2h])
            .send()
            .await
    );

    for event in &resp.data {
        assert!(!event.id.is_empty());
        assert!(!event.sport_key.is_empty());
        assert!(!event.sport_title.is_empty());
    }
}