rhood-core 0.1.4

Async Rust client library for the Robinhood trading 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
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
//! Authenticated HTTP verb helpers for [`RobinhoodClient`].
//!
//! Wraps reqwest with the auth header, futures contract header, pagination
//! follow-through, and uniform 4xx/5xx/429 handling so endpoint methods stay
//! free of transport boilerplate.

use super::{
    DEFAULT_RETRY_AFTER_SECS, FUTURES_CONTRACT_HEADER, FUTURES_CONTRACT_HEADER_VALUE,
    RobinhoodClient,
};
use crate::pagination::{CursorPaginatedResponse, PaginatedResponse};
use crate::{Result, RhoodError};
use serde::Serialize;
use serde::de::DeserializeOwned;

impl RobinhoodClient {
    /// Sends an authenticated GET request and deserializes the JSON response.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn get<T: DeserializeOwned>(&self, url: &str) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .get(url)
            .header("Authorization", &auth)
            .send()
            .await?;
        handle_response(res).await
    }

    /// Sends an authenticated GET request with query parameters and deserializes
    /// the JSON response.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn get_with_params<T: DeserializeOwned>(
        &self,
        url: &str,
        params: &[(&str, &str)],
    ) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .get(url)
            .header("Authorization", &auth)
            .query(params)
            .send()
            .await?;
        handle_response(res).await
    }

    /// Sends an authenticated GET request and follows pagination links to collect
    /// all results into a single `Vec`.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn get_paginated<T: DeserializeOwned>(
        &self,
        url: &str,
        params: &[(&str, &str)],
    ) -> Result<Vec<T>> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .get(url)
            .header("Authorization", &auth)
            .query(params)
            .send()
            .await?;
        let mut page: PaginatedResponse<T> = handle_response(res).await?;
        let mut all_results = page.results;
        while let Some(next_url) = page.next {
            let res = self
                .http
                .get(&next_url)
                .header("Authorization", &auth)
                .send()
                .await?;
            page = handle_response(res).await?;
            all_results.extend(page.results);
        }
        Ok(all_results)
    }

    /// Sends an authenticated GET request with the futures contract header.
    ///
    /// All Robinhood futures endpoints require `Rh-Contract-Protected: true`.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub(crate) async fn get_futures<T: DeserializeOwned>(&self, url: &str) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .get(url)
            .header("Authorization", &auth)
            .header(FUTURES_CONTRACT_HEADER, FUTURES_CONTRACT_HEADER_VALUE)
            .send()
            .await?;
        handle_response(res).await
    }

    /// Sends an authenticated GET request with query params and the futures
    /// contract header.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub(crate) async fn get_futures_with_params<T: DeserializeOwned>(
        &self,
        url: &str,
        params: &[(&str, &str)],
    ) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .get(url)
            .header("Authorization", &auth)
            .header(FUTURES_CONTRACT_HEADER, FUTURES_CONTRACT_HEADER_VALUE)
            .query(params)
            .send()
            .await?;
        handle_response(res).await
    }

    /// Sends authenticated GET requests with the futures contract header,
    /// following cursor-based pagination to collect all results.
    ///
    /// Unlike [`get_paginated`](Self::get_paginated), this re-requests the same
    /// base URL with `cursor=<token>` appended to the original params.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub(crate) async fn get_futures_cursor_paginated<T: DeserializeOwned>(
        &self,
        url: &str,
        params: &[(&str, &str)],
    ) -> Result<Vec<T>> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .get(url)
            .header("Authorization", &auth)
            .header(FUTURES_CONTRACT_HEADER, FUTURES_CONTRACT_HEADER_VALUE)
            .query(params)
            .send()
            .await?;
        let mut page: CursorPaginatedResponse<T> = handle_response(res).await?;
        let mut all_results = page.results;
        while let Some(cursor) = page.next {
            let mut next_params: Vec<(&str, &str)> = params.to_vec();
            let cursor_owned = cursor;
            next_params.push(("cursor", &cursor_owned));
            let res = self
                .http
                .get(url)
                .header("Authorization", &auth)
                .header(FUTURES_CONTRACT_HEADER, FUTURES_CONTRACT_HEADER_VALUE)
                .query(&next_params)
                .send()
                .await?;
            page = handle_response(res).await?;
            all_results.extend(page.results);
        }
        Ok(all_results)
    }

    /// Sends an authenticated POST request with a form-encoded body and
    /// deserializes the JSON response.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn post_form<T: DeserializeOwned, P: Serialize + ?Sized>(
        &self,
        url: &str,
        payload: &P,
    ) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .post(url)
            .header("Authorization", &auth)
            .form(payload)
            .send()
            .await?;
        handle_response(res).await
    }

    /// Sends an authenticated POST request with a JSON body and deserializes
    /// the JSON response.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn post_json<T: DeserializeOwned, P: Serialize + ?Sized>(
        &self,
        url: &str,
        payload: &P,
    ) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .post(url)
            .header("Authorization", &auth)
            .json(payload)
            .send()
            .await?;
        handle_response(res).await
    }

    /// Sends an authenticated POST request with an empty body.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn post_empty(&self, url: &str) -> Result<()> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .post(url)
            .header("Authorization", &auth)
            .send()
            .await?;
        let status = res.status();
        let body = res.text().await.unwrap_or_default();
        tracing::debug!(
            status = status.as_u16(),
            url = %url,
            body = %body,
            "API response"
        );
        if status.is_success() {
            Ok(())
        } else {
            Err(RhoodError::Api {
                status: status.as_u16(),
                message: body,
            })
        }
    }

    /// Sends an authenticated DELETE request.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn delete(&self, url: &str) -> Result<()> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .delete(url)
            .header("Authorization", &auth)
            .send()
            .await?;
        let status = res.status();
        let body = res.text().await.unwrap_or_default();
        tracing::debug!(
            status = status.as_u16(),
            url = %url,
            body = %body,
            "API response"
        );
        if status.is_success() {
            Ok(())
        } else {
            Err(RhoodError::Api {
                status: status.as_u16(),
                message: body,
            })
        }
    }

    /// Sends an authenticated PATCH request with a JSON body and deserializes
    /// the JSON response.
    ///
    /// # Errors
    ///
    /// Returns [`RhoodError::NotAuthenticated`] if the client is not logged in,
    /// or a transport/API error on failure.
    pub async fn patch_json<T: DeserializeOwned, P: Serialize + ?Sized>(
        &self,
        url: &str,
        payload: &P,
    ) -> Result<T> {
        let auth = self.require_auth().await?;
        let res = self
            .http
            .patch(url)
            .header("Authorization", &auth)
            .json(payload)
            .send()
            .await?;
        handle_response(res).await
    }
}

async fn handle_response<T: DeserializeOwned>(res: reqwest::Response) -> Result<T> {
    let status = res.status();
    if status.as_u16() == 429 {
        let retry_after = res
            .headers()
            .get("retry-after")
            .and_then(|header| header.to_str().ok())
            .and_then(|text| text.parse().ok())
            .unwrap_or(DEFAULT_RETRY_AFTER_SECS);
        return Err(RhoodError::RateLimited {
            retry_after_secs: retry_after,
        });
    }
    let url = res.url().clone();
    let body = res.text().await.unwrap_or_default();
    tracing::debug!(
        status = status.as_u16(),
        url = %url,
        body = %body,
        "API response"
    );
    if !status.is_success() {
        return Err(RhoodError::Api {
            status: status.as_u16(),
            message: body,
        });
    }
    serde_json::from_str::<T>(&body).map_err(|e| RhoodError::Api {
        status: status.as_u16(),
        message: format!("Failed to parse response from {url}: {e}"),
    })
}

#[cfg(test)]
mod tests {
    use super::super::test_config_with_tempdir;
    use super::*;
    use crate::auth::AuthState;
    use secrecy::SecretString;
    use serde::Deserialize;
    use wiremock::matchers::{
        body_string_contains, header, method, path, query_param, query_param_is_missing,
    };
    use wiremock::{Mock, MockServer, ResponseTemplate};

    #[derive(Debug, Deserialize, PartialEq, Eq)]
    struct TestBody {
        value: String,
    }

    async fn authenticated_client(base_url: &str) -> (tempfile::TempDir, RobinhoodClient) {
        let dir = tempfile::tempdir().unwrap();
        let mut config = test_config_with_tempdir(&dir);
        config.api.base_url = base_url.to_string();
        let client = RobinhoodClient::with_config(config).unwrap();
        *client.auth_state.write().await = AuthState::Authenticated {
            access_token: SecretString::from("access-token"),
            token_type: "Bearer".to_string(),
            refresh_token: SecretString::from("refresh-token"),
        };
        (dir, client)
    }

    #[test]
    fn futures_header_constant_is_correct() {
        assert_eq!(FUTURES_CONTRACT_HEADER, "Rh-Contract-Protected");
        assert_eq!(FUTURES_CONTRACT_HEADER_VALUE, "true");
    }

    #[tokio::test]
    async fn get_sends_auth_header_and_deserializes_json() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/plain"))
            .and(header("Authorization", "Bearer access-token"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "value": "ok"
            })))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let body: TestBody = client
            .get(&format!("{}/plain", server.uri()))
            .await
            .unwrap();

        assert_eq!(body, TestBody { value: "ok".into() });
    }

    #[tokio::test]
    async fn get_with_params_sends_query_params() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/search"))
            .and(query_param("symbol", "HOOD"))
            .and(query_param("active", "true"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "value": "found"
            })))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let body: TestBody = client
            .get_with_params(
                &format!("{}/search", server.uri()),
                &[("symbol", "HOOD"), ("active", "true")],
            )
            .await
            .unwrap();

        assert_eq!(body.value, "found");
    }

    #[tokio::test]
    async fn get_paginated_follows_next_links() {
        let server = MockServer::start().await;
        let next_url = format!("{}/page-2", server.uri());
        Mock::given(method("GET"))
            .and(path("/page-1"))
            .and(query_param("nonzero", "true"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "results": [1, 2],
                "next": next_url,
                "previous": null
            })))
            .mount(&server)
            .await;
        Mock::given(method("GET"))
            .and(path("/page-2"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "results": [3],
                "next": null,
                "previous": null
            })))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let values: Vec<i32> = client
            .get_paginated(&format!("{}/page-1", server.uri()), &[("nonzero", "true")])
            .await
            .unwrap();

        assert_eq!(values, vec![1, 2, 3]);
    }

    #[tokio::test]
    async fn futures_gets_include_contract_header_and_cursor_pagination() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/futures"))
            .and(header(
                FUTURES_CONTRACT_HEADER,
                FUTURES_CONTRACT_HEADER_VALUE,
            ))
            .and(query_param("symbol", "ES"))
            .and(query_param_is_missing("cursor"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "results": [10],
                "next": "cursor-2"
            })))
            .mount(&server)
            .await;
        Mock::given(method("GET"))
            .and(path("/futures"))
            .and(header(
                FUTURES_CONTRACT_HEADER,
                FUTURES_CONTRACT_HEADER_VALUE,
            ))
            .and(query_param("symbol", "ES"))
            .and(query_param("cursor", "cursor-2"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "results": [20],
                "next": null
            })))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let values: Vec<i32> = client
            .get_futures_cursor_paginated(&format!("{}/futures", server.uri()), &[("symbol", "ES")])
            .await
            .unwrap();

        assert_eq!(values, vec![10, 20]);
    }

    #[tokio::test]
    async fn get_futures_with_params_includes_header_and_query() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/futures/quote"))
            .and(header(
                FUTURES_CONTRACT_HEADER,
                FUTURES_CONTRACT_HEADER_VALUE,
            ))
            .and(query_param("symbol", "ES"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "value": "quote"
            })))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let body: TestBody = client
            .get_futures_with_params(
                &format!("{}/futures/quote", server.uri()),
                &[("symbol", "ES")],
            )
            .await
            .unwrap();

        assert_eq!(body.value, "quote");
    }

    #[tokio::test]
    async fn post_helpers_send_expected_body_shapes() {
        let server = MockServer::start().await;
        Mock::given(method("POST"))
            .and(path("/form"))
            .and(body_string_contains("name=rhood"))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "value": "form-ok"
            })))
            .mount(&server)
            .await;
        Mock::given(method("POST"))
            .and(path("/json"))
            .and(body_string_contains(r#""name":"rhood""#))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "value": "json-ok"
            })))
            .mount(&server)
            .await;
        Mock::given(method("POST"))
            .and(path("/empty"))
            .respond_with(ResponseTemplate::new(204))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let form: TestBody = client
            .post_form(&format!("{}/form", server.uri()), &[("name", "rhood")])
            .await
            .unwrap();
        let json: TestBody = client
            .post_json(
                &format!("{}/json", server.uri()),
                &serde_json::json!({ "name": "rhood" }),
            )
            .await
            .unwrap();
        client
            .post_empty(&format!("{}/empty", server.uri()))
            .await
            .unwrap();

        assert_eq!(form.value, "form-ok");
        assert_eq!(json.value, "json-ok");
    }

    #[tokio::test]
    async fn delete_and_patch_json_handle_successful_responses() {
        let server = MockServer::start().await;
        Mock::given(method("DELETE"))
            .and(path("/resource"))
            .respond_with(ResponseTemplate::new(200).set_body_string("deleted"))
            .mount(&server)
            .await;
        Mock::given(method("PATCH"))
            .and(path("/resource"))
            .and(body_string_contains(r#""enabled":true"#))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
                "value": "patched"
            })))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        client
            .delete(&format!("{}/resource", server.uri()))
            .await
            .unwrap();
        let body: TestBody = client
            .patch_json(
                &format!("{}/resource", server.uri()),
                &serde_json::json!({ "enabled": true }),
            )
            .await
            .unwrap();

        assert_eq!(body.value, "patched");
    }

    #[tokio::test]
    async fn handle_response_maps_rate_limit_with_header() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/limited"))
            .respond_with(ResponseTemplate::new(429).insert_header("retry-after", "17"))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let err = client
            .get::<serde_json::Value>(&format!("{}/limited", server.uri()))
            .await
            .unwrap_err();

        assert!(matches!(
            err,
            RhoodError::RateLimited {
                retry_after_secs: 17
            }
        ));
    }

    #[tokio::test]
    async fn handle_response_uses_default_rate_limit_when_header_is_invalid() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/limited"))
            .respond_with(ResponseTemplate::new(429).insert_header("retry-after", "soon"))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let err = client
            .get::<serde_json::Value>(&format!("{}/limited", server.uri()))
            .await
            .unwrap_err();

        assert!(matches!(
            err,
            RhoodError::RateLimited {
                retry_after_secs: DEFAULT_RETRY_AFTER_SECS
            }
        ));
    }

    #[tokio::test]
    async fn handle_response_maps_api_and_parse_errors() {
        let server = MockServer::start().await;
        Mock::given(method("GET"))
            .and(path("/api-error"))
            .respond_with(ResponseTemplate::new(503).set_body_string("unavailable"))
            .mount(&server)
            .await;
        Mock::given(method("GET"))
            .and(path("/bad-json"))
            .respond_with(ResponseTemplate::new(200).set_body_string("not json"))
            .mount(&server)
            .await;
        let (_dir, client) = authenticated_client(&server.uri()).await;

        let api_err = client
            .get::<serde_json::Value>(&format!("{}/api-error", server.uri()))
            .await
            .unwrap_err();
        let parse_err = client
            .get::<serde_json::Value>(&format!("{}/bad-json", server.uri()))
            .await
            .unwrap_err();

        assert!(matches!(
            api_err,
            RhoodError::Api {
                status: 503,
                message
            } if message == "unavailable"
        ));
        assert!(matches!(
            parse_err,
            RhoodError::Api {
                status: 200,
                message
            } if message.contains("Failed to parse response")
        ));
    }
}