A Rust client library (SDK) for interacting with the Bitcoin.de Trading API (Version 4), with an optional Axum-based backend feature providing HTTP endpoints.
Note: While many core API methods are implemented in the SDK, comprehensive
A Rust client library and command-line tool for interacting with the Bitcoin.de Trading API v4.
This project provides a comprehensive SDK for the Bitcoin.de cryptocurrency trading platform API. It allows developers to programmatically access trading functionality, account information, and market data through a clean, type-safe Rust interface.
- Complete implementation of the Bitcoin.de Trading API v4
- Support for all trading operations (view orderbook, create/delete orders, execute trades)
- Account management (view info, deposits, withdrawals)
- Secure authentication using HMAC-SHA256 signatures
- Comprehensive error handling with detailed error codes
- Command-line interface for quick operations
- Fully documented API methods and data structures
- Create SVG Charts out of the provided CSV (usually done by the cronjob) (new in 0.1.2)
- Rust 1.56 or later
- API credentials from Bitcoin.de
cargo install bitcoin_degit clone https://github.com/holg/bitcoin_de.git
cd bitcoin_de
cargo build --releaseOn bitcoin.de you need to set up your API token and secret: https://www.bitcoin.de/de/userprofile/tapi
Create a .env file in the project root with your Bitcoin.de API credentials:
API_KEY=your_bitcoin_de_api_key
API_SECRET=your_bitcoin_de_api_secretYou can use the provided .env.sample as a template.
Alternatively, you can pass the --api-key and --api-secret to the command line.
// Example: Get Account Info and Orderbook using the Bitcoin.de Trading API v4
// Import necessary types from your crate
use bitcoin_de::bitcoin_de_trading_api_sdk_v4::TradingApiSdkV4;
// We don't need to import ApiCredentials anymore as TradingApiSdkV4::new takes strings directly
// use bitcoin_de::bitcoin_de_trading_api_sdk_v4::config::ApiCredentials; // Remove this import
// Import other types needed for the example
use std::collections::HashMap; // Needed for show_orderbook parameters
use bitcoin_de::bitcoin_de_trading_api_sdk_v4::method_settings::constants::SHOW_ORDERBOOK_PARAMETER_TYPE; // Need this constant for show_orderbook params
use bitcoin_de::bitcoin_de_trading_api_sdk_v4::responses::order::ShowOrderbookResponse; // Import the response struct type for show_orderbook
use bitcoin_de::bitcoin_de_trading_api_sdk_v4::responses::account::ShowAccountInfoResponse; // Import the response struct type for show_account_info
use bitcoin_de::bitcoin_de_trading_api_sdk_v4::errors::Error; // Import the custom Error type
// Add an async runtime setup for the example main function
// Using tokio as it's used by your default CLI
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// In a real application, get your API key and secret securely
// from environment variables, a configuration file, etc.
// For this example, replace with your actual credentials or environment variable loading logic.
let api_key = "your_api_key".to_string(); // Replace with your API Key
let api_secret = "your_api_secret".to_string(); // Replace with your API Secret
// Create a new API client with your credentials
// TradingApiSdkV4::new takes the key and secret directly as Strings
let client = TradingApiSdkV4::new(api_key, api_secret);
// --- Example 1: Get Account Info ---
println!(">>> Calling showAccountInfo...");
// Call the async SDK method and await its result
let account_info_result: Result<ShowAccountInfoResponse, Error> = client.show_account_info().await;
match account_info_result {
Ok(response) => {
println!("showAccountInfo successful Response: {:?}", response);
// Access deserialized data, e.g.:
// if let Some(account_details) = response.account_info_details {
// println!("Username: {}", account_details.username);
// }
}
Err(e) => {
eprintln!("Error getting account info: {}", e);
}
}
// --- Example 2: Get the current orderbook for BTC/EUR (Buy side) ---
println!("\n>>> Calling showOrderbook...");
// show_orderbook takes the trading pair as a String and Option<HashMap> for other params
let mut params = HashMap::new();
// Add the 'type=buy' parameter to the HashMap
params.insert(SHOW_ORDERBOOK_PARAMETER_TYPE, "buy".to_string());
// Call the async SDK method and await its result
// show_orderbook returns Result<ShowOrderbookResponse, Error>
let orderbook_result: Result<ShowOrderbookResponse, Error> = client.show_orderbook("btceur".to_string(), Some(params)).await; // Pass trading pair as String and params
match orderbook_result {
Ok(response) => {
println!("Orderbook: {:?}", response);
// Access deserialized data, e.g.:
// for order in response.orders {
// println!("{:?}", order);
// }
}
Err(e) => {
eprintln!("Error getting orderbook: {}", e);
}
}
// Return Ok(()) for the async main function on success
Ok(())
}bitcoin_de_trading_api_client --showrates btceur,bcheur,btgeur,etheur,ltceur,xrpeur,dogeeur,soleur,trxeur,usdteur,usdceur --amounts 2.01,2.01,2.01,2,2.01,2.01,2.01 --csv-output test2.csvbitcoin_de_trading_api_client show-orderbook --trading-pair btceur --type buybitcoin_de_trading_api_client create-order --trading-pair btceur --type buy --amount 0.1 --price 50000bitcoin_de_trading_api_client show-account-infobitcoin_de_trading_api_client --helpThe library provides detailed error codes for troubleshooting API interactions. For example:
ERROR_CODE_ORDER_NOT_FOUND(13): The requested order could not be foundERROR_CODE_INSUFFICIENT_CREDITS(22): The user has insufficient credits to complete the operationERROR_CODE_INVALID_TRADING_PAIR(32): The trading pair specified is invalid
See the documentation for a complete list of error codes and their meanings.
The client supports all Bitcoin.de Trading API v4 methods, including:
- Market data:
show_orderbook,show_rates,show_public_trade_history - Order management:
create_order,delete_order,show_my_orders - Trading:
execute_trade,mark_trade_as_paid,mark_trade_as_payment_received - Account operations:
show_account_info,show_account_ledger - Deposits and withdrawals:
create_withdrawal,request_deposit_address
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
This software is not affiliated with Bitcoin.de. Use at your own risk. Always verify important operations before executing trades or transfers.