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.
- 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
Add to your Cargo.toml:
[dependencies]
deribit-http = "0.6"
tokio = { version = "1", features = ["full"] }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(())
}- OAuth2 (Client Credentials):
DeribitHttpClient::authenticate_oauth2(client_id, client_secret)returns anAuthTokenand keeps it in theAuthManager. - Helpers:
is_authenticated(),get_auth_token(). - Session management:
exchange_token(refresh_token, subject_id, scope)andfork_token(refresh_token, session_name, scope). - API Key: the
authenticate_api_keymethod exists but is currently not implemented and will return an error.
- Environment shortcut:
DeribitHttpClient::new()for Testnet andnew(false)for Production. - Custom configuration:
DeribitHttpClient::with_config(HttpConfig)lets you setbase_url,timeout,user_agent,testnet, and optional credentials. - Validation: configuration is validated on client creation.
auth:AuthManager(OAuth2, token management) and related types (e.g.AuthRequest).client:DeribitHttpClient, public/private methods, auth helpers,exchange_tokenandfork_token.config:HttpConfigand environment helpers (testnet/production) and headers/base_url.connectionandsession: infrastructure support types (shared across the ecosystem).endpoints: HTTP implementation of public and private methods (see coverage below).error:HttpErrorvariants such asNetworkError,RequestFailed,InvalidResponse,AuthenticationFailed,ConfigError.messageandmodel: HTTP types (ApiResponse,ApiError,AuthToken, etc.).rate_limit:RateLimiterandcategorize_endpointwith per-category limits.constants: base URLs (production/testnet), endpoint routes, and common headers.
| Category | Endpoints |
|---|---|
| System | get_server_time(), test_connection(), get_status() |
| Currencies | get_currencies(), get_apr_history() |
| Indices | get_index(), get_index_price(), get_index_price_names(), get_index_chart_data() |
| Instruments | get_instrument(), get_instruments(), get_contract_size() |
| Book Summary | get_book_summary_by_currency(), get_book_summary_by_instrument() |
| Market Data | get_ticker(), get_order_book(), get_order_book_by_instrument_id() |
| Trades | get_last_trades(), get_last_trades_by_currency(), get_last_trades_by_*_and_time() |
| Funding | get_funding_chart_data(), get_funding_rate_history(), get_funding_rate_value() |
| Volatility | get_historical_volatility(), get_volatility_index_data() |
| Settlements | get_last_settlements_by_currency(), get_last_settlements_by_instrument() |
| TradingView | get_tradingview_chart_data() |
| Combo Books | get_combo_details(), get_combo_ids(), get_combos() |
| Block RFQ | get_block_rfq_trades() |
Require valid authentication (OAuth2):
| Category | Endpoints |
|---|---|
| Trading | buy_order(), sell_order(), edit_order(), cancel_order(), cancel_all(), cancel_all_by_*() |
| Orders | get_open_orders(), get_order_state(), get_order_history_by_currency(), get_order_history_by_instrument() |
| Positions | get_position(), get_positions(), close_position(), move_positions() |
| User Trades | get_user_trades_by_instrument(), get_user_trades_by_currency(), get_user_trades_by_order() |
| Account | get_account_summary(), get_account_summaries(), get_subaccounts(), get_subaccounts_details() |
| Subaccounts | create_subaccount(), change_subaccount_name(), toggle_subaccount_login(), remove_subaccount() |
| API Keys | create_api_key(), edit_api_key(), remove_api_key(), list_api_keys(), enable_api_key(), disable_api_key() |
| Wallet | get_deposits(), get_withdrawals(), withdraw(), cancel_withdrawal(), create_deposit_address() |
| Transfers | get_transfers(), submit_transfer_to_subaccount(), submit_transfer_between_subaccounts(), cancel_transfer_by_id() |
| Block Trade | execute_block_trade(), verify_block_trade(), get_block_trade(), get_block_trades(), simulate_block_trade() |
| Block RFQ | create_block_rfq(), accept_block_rfq(), add_block_rfq_quote(), cancel_block_rfq(), get_block_rfqs() |
| Combo Books | create_combo(), get_leg_prices() |
| MMP | get_mmp_config(), set_mmp_config(), reset_mmp(), get_mmp_status() |
| Mass Quote | mass_quote(), cancel_quotes() |
| Margins | get_margins(), get_order_margin_by_ids() |
| Settlement | get_settlement_history_by_currency(), get_settlement_history_by_instrument() |
- This crate does not implement WebSocket or streaming. Some Deribit endpoints exist only over WS
(for example,
/public/helloand/private/logout) and are not available in this HTTP client. - API Key authentication: the
authenticate_api_keystub 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.
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).
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().
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| Target | Status |
|---|---|
| Native (tokio) | ✅ Full support |
| WASM (browser) | ✅ Full support |
| Cloudflare Workers | ✅ Full support |
We welcome contributions to this project! If you would like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure that the project still builds and all tests pass.
- Commit your changes and push your branch to your forked repository.
- 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:
- 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!
Licensed under MIT license
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.