deribit-http 0.6.0

Deribit HTTP Client (deribit_http)

Production-ready asynchronous HTTP client for the Deribit API v2. Version 0.6.0 provides ~95% coverage of all HTTP-compatible Deribit endpoints.

Designed for server integrations, batch jobs, and tooling that prefer REST/HTTP over WebSocket. Built on reqwest and tokio, with full WASM/Cloudflare Workers support.

Key features

• 100+ endpoints implemented across public and private APIs
• Pure async HTTP with reqwest + tokio (native) or fetch (WASM)
• Cross-platform: Native, WASM browsers, and Cloudflare Workers
• OAuth2 authentication with automatic token renewal
• Token-bucket rate limiting per endpoint category
• 40+ strongly-typed models with Serde serialization
• 126 unit tests ensuring reliability

Installation

Add to your Cargo.toml:

[dependencies]
deribit-http = "0.6"
tokio = { version = "1", features = ["full"] }

Quick start

use deribit_http::DeribitHttpClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // true = testnet, false = mainnet
    let client = DeribitHttpClient::new();

    // Public calls (no authentication required)
    let currencies = client.get_currencies().await?;
    println!("Supports {} currencies", currencies.len());

    // Example: ticker
    let ticker = client.get_ticker("BTC-PERPETUAL").await?;
    println!("Mark price: {}", ticker.mark_price);

    Ok(())
}

Authentication and private endpoints

• OAuth2 (Client Credentials): DeribitHttpClient::authenticate_oauth2(client_id, client_secret) returns an AuthToken and keeps it in the AuthManager.
• Helpers: is_authenticated(), get_auth_token().
• Session management: exchange_token(refresh_token, subject_id, scope) and fork_token(refresh_token, session_name, scope).
• API Key: the authenticate_api_key method exists but is currently not implemented and will return an error.

Configuration

• Environment shortcut: DeribitHttpClient::new() for Testnet and new(false) for Production.
• Custom configuration: DeribitHttpClient::with_config(HttpConfig) lets you set base_url, timeout, user_agent, testnet, and optional credentials.
• Validation: configuration is validated on client creation.

Project structure (modules)

• auth: AuthManager (OAuth2, token management) and related types (e.g. AuthRequest).
• client: DeribitHttpClient, public/private methods, auth helpers, exchange_token and fork_token.
• config: HttpConfig and environment helpers (testnet/production) and headers/base_url.
• connection and session: infrastructure support types (shared across the ecosystem).
• endpoints: HTTP implementation of public and private methods (see coverage below).
• error: HttpError variants such as NetworkError, RequestFailed, InvalidResponse, AuthenticationFailed, ConfigError.
• message and model: HTTP types (ApiResponse, ApiError, AuthToken, etc.).
• rate_limit: RateLimiter and categorize_endpoint with per-category limits.
• constants: base URLs (production/testnet), endpoint routes, and common headers.

Public endpoints (30+)

Private endpoints (70+)

Require valid authentication (OAuth2):

Limitations and important notes

• This crate does not implement WebSocket or streaming. Some Deribit endpoints exist only over WS (for example, /public/hello and /private/logout) and are not available in this HTTP client.
• API Key authentication: the authenticate_api_key stub exists but is not yet implemented in the HTTP client.
• Deribit uses JSON-RPC over HTTP; this client exposes ergonomic methods that build URLs with query params and parse ApiResponse<T> in a strongly-typed manner.

Error handling

The HttpError type centralizes common failures: network issues (NetworkError), non-success HTTP responses (RequestFailed), parsing/structure errors (InvalidResponse), authentication failures (AuthenticationFailed), and configuration conditions (ConfigError).

Rate limiting

The RateLimiter categorizes each URL and applies a token-bucket scheme per category (Trading, MarketData, Account, Auth, General). You can inspect it via rate_limiter().

Examples

See the examples/ directory for comprehensive examples:

• Public examples (16 binaries): Market data, instruments, trades, funding, settlements
• Private examples (7 binaries): Trading, orders, positions, account management, mass quotes

# Run a public example
cargo run --bin check_currencies

# Run a private example (requires .env with credentials)
cargo run --bin trading_endpoints

Platform support

Contribution and Contact

We welcome contributions to this project! If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that the project still builds and all tests pass.
4. Commit your changes and push your branch to your forked repository.
5. Submit a pull request to the main repository.

If you have any questions, issues, or would like to provide feedback, please feel free to contact the project maintainer:

Contact Information

• Author: Joaquín Béjar García
• Email: jb@taunais.com
• Telegram: @joaquin_bejar
• Repository: https://github.com/joaquinbejar/deribit-http
• Documentation: https://docs.rs/deribit-http

We appreciate your interest and look forward to your contributions!

✍️ License

Licensed under MIT license

Disclaimer

This software is not officially associated with Deribit. Trading financial instruments carries risk, and this library is provided as-is without any guarantees. Always test thoroughly with a demo account before using in a live trading environment.