https://github.com/allancalix/rplaid
An async client library for Plaid APIs.
https://github.com/allancalix/rplaid
api-bindings async client-library finance plaid rust
Last synced: 6 months ago
JSON representation
An async client library for Plaid APIs.
- Host: GitHub
- URL: https://github.com/allancalix/rplaid
- Owner: allancalix
- License: mit
- Created: 2021-09-03T17:42:29.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-13T06:34:59.000Z (over 1 year ago)
- Last Synced: 2025-03-10T07:36:59.936Z (7 months ago)
- Topics: api-bindings, async, client-library, finance, plaid, rust
- Language: Rust
- Homepage:
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rplaid
[](https://crates.io/crates/rplaid)
[](https://docs.rs/rplaid)
[](./LICENSE)
[](https://github.com/allancalix/rplaid/actions?query=workflow%3ATEST)
**rplaid** is an async client for the [Plaid API](https://plaid.com/docs/api/).
With minimal features, the client is meant to be extensible and lightweight.
Additional features can be enabled to improve ergonomics of the API at the
cost of additional dependencies.
The goal is to provide expressive bindings that provide sensible defaults where
possible for ease of use.
See official [API docs](https://plaid.com/docs/) for more information about
endpoints or specific products.
__These are not official Plaid bindings.__
```rust
use rplaid::client::{Builder, Credentials};
use rplaid::model::*;
#[tokio::main]
async fn main() {
let client = Builder::new()
.with_credentials(Credentials {
client_id: std::env::var("PLAID_CLIENT_ID").unwrap(),
secret: std::env::var("PLAID_SECRET").unwrap(),
})
.build();
let institutions = client
.get_institutions(&InstitutionsGetRequest {
count: 10,
offset: 0,
country_codes: &["US"],
options: None,
})
.await
.unwrap();
println!("{:?}", institutions);
}
```
## Glossary
* Item - A Item represents a connection to a single financial instution.
Typically links are associated with a pair of credentials and an
`access_token`. Items are associated to one or more accounts.
* Link - Link is a client-side component that Plaid provides to link to accounts.
See https://plaid.com/docs/link/#introduction-to-link for more
information.
* Account - An account is a financial account that is linked to an Item. An item,
or financial institution, may have multiple accounts for a single
user (e.g. a checking account and a credit account).
* Product - Entities with services offered by Plaid, see
https://plaid.com/docs/api/products/ for more information.
## Features
* Idiomatic futures generator for easily reading multiple pages of transactions.
* Extensible HttpClient interfaces supports multiple HTTP clients with minimal
effort (surf, H1, and reqwest). The trait can also be implemented to have full
control over the HTTP client used.
* Rust types, including variant types, for most API return types.
## Limitations
Some endpoints are production specific or beta products and are not yet
supported by the client.
For a breakdown of endpoint support visit:
https://docs.google.com/spreadsheets/d/1xqUXdfllo37Rx5MVrQODbVqNQvuktiCVL5Uh8y9mYYw
## License
[MIT](LICENSE)