# Whop Rust Library
[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fwhopio%2Fwhopsdk-rust)
[](https://crates.io/crates/whop_sdk)
The Whop SDK gives you typed access to the Whop API. Pass your API key to the client explicitly — the SDK reads no environment variables, so a client built without a key sends unauthenticated requests and the API answers 401.
## Table of Contents
- [Documentation](#documentation)
- [Installation](#installation)
- [Reference](#reference)
- [Usage](#usage)
- [Environments](#environments)
- [Errors](#errors)
- [Request Types](#request-types)
- [Advanced](#advanced)
- [Retries](#retries)
- [Timeouts](#timeouts)
- [Additional Headers](#additional-headers)
- [Additional Query String Parameters](#additional-query-string-parameters)
- [Custom Client](#custom-client)
- [Contributing](#contributing)
## Documentation
API reference documentation is available [here](https://docs.whop.com/api-reference).
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
whop_sdk = "1.0.14"
```
Or install via cargo:
```sh
cargo add whop_sdk
```
## Reference
A full reference for this library is available [here](https://github.com/whopio/whopsdk-rust/blob/HEAD/./reference.md).
## Usage
Instantiate and use the client with the following:
```rust
use whop_sdk::prelude::*;
#[tokio::main]
async fn main() {
let config = ClientConfig {
token: Some("<token>".to_string()),
..Default::default()
};
let client = Whop::new(config).expect("Failed to build client");
client
.access_tokens
.create(
&CreateAccessTokensRequest {
..Default::default()
},
None,
)
.await;
}
```
## Environments
This SDK allows you to configure different environments for API requests.
```rust
use whop_sdk::prelude::{*};
let config = ClientConfig {
base_url: Environment::Default.url().to_string(),
..Default::default()
};
let client = Client::new(config).expect("Failed to build client");
```
## Errors
When the API returns a non-success status code (4xx or 5xx response), an error will be returned.
```rust
match client.access_tokens.create(None)?.await {
Ok(response) => {
println!("Success: {:?}", response);
},
Err(ApiError::HTTP { status, message }) => {
println!("API Error {}: {:?}", status, message);
},
Err(e) => {
println!("Other error: {:?}", e);
}
}
```
## Request Types
The SDK exports all request types as Rust structs. Simply import them from the crate to access them:
```rust
use whop_sdk::prelude::{*};
let request = CreateAccessTokensRequest {
...
};
```
## Advanced
### Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (Internal Server Error)
The `retryStatusCodes` configuration controls which [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) status codes are retried:
- `legacy` (default): Retries `408`, `429`, and all `>= 500`
- `recommended`: Retries `408`, `429`, `502`, `503`, `504` only (excludes `500 Internal Server Error` to avoid retrying non-idempotent failures)
Use the `max_retries` method to configure this behavior.
```rust
let response = client.access_tokens.create(
Some(RequestOptions::new().max_retries(3))
)?.await;
```
### Timeouts
The SDK defaults to a 30 second timeout. Use the `timeout` method to configure this behavior.
```rust
let response = client.access_tokens.create(
Some(RequestOptions::new().timeout_seconds(30))
)?.await;
```
### Additional Headers
You can add custom headers to requests using `RequestOptions`.
```rust
let response = client.access_tokens.create(
Some(
RequestOptions::new()
.additional_header("X-Custom-Header", "custom-value")
.additional_header("X-Another-Header", "another-value")
)
)?
.await;
```
### Additional Query String Parameters
You can add custom query parameters to requests using `RequestOptions`.
```rust
let response = client.access_tokens.create(
Some(
RequestOptions::new()
.additional_query_param("filter", "active")
.additional_query_param("sort", "desc")
)
)?
.await;
```
### Custom Client
The SDK builds its own `reqwest` client by default, but you can supply your own through
`ClientConfig.reqwest_client` (or `ApiClientBuilder::reqwest_client`) when you need control over the
transport — custom root certificates, client certificates, proxies or connection tuning. The supplied
client is used as-is; authentication, custom headers and retries are still applied by the SDK.
```rust
use whop_sdk::prelude::*;
let certificate = reqwest::Certificate::from_pem(&std::fs::read("ca.pem")?)?;
let reqwest_client = reqwest::Client::builder()
.add_root_certificate(certificate)
.build()
.expect("Failed to build reqwest client");
let config = ClientConfig {
reqwest_client: Some(reqwest_client),
..Default::default()
};
let client = Whop::new(config).expect("Failed to build client");
```
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!