A Python wrapper for seamless integration with Deribit's trading API, offering easy access to market data, account management, and trading operations.
Project description
deribit-wrapper
Overview
This Python script provides a comprehensive client for interacting with the Deribit API. It encapsulates functionality for both public and private endpoints, covering market data, account information, trading operations, and more. It supports both the production and test environments, making it suitable for developers at all stages of application development.
Features
- Environment Switching: Easily switch between the production and test environments.
- Market Data Retrieval: Access to market data including contract sizes, currencies, ticker information, book summaries, and historical data.
- Account Management: Functionality to authenticate, retrieve account summaries, positions, and transaction logs.
- Trading Operations: Support for placing buy and sell orders, including market and limit orders, as well as bulk ordering.
- Utility Functions: Helper functions to convert timestamps, retrieve specific instruments or markets, and calculate margins.
Installation
Install deribit-wrapper
using pip:
pip install deribit-wrapper
Configuration
Instantiate the DeribitClient
class with the appropriate parameters:
client_id
: Your Deribit client ID.client_secret
: Your Deribit client secret.simulated
: Set toTrue
to use the test environment orFalse
to use the production environment.env
: Choose between'test'
and'prod'
environments. Defaults to'prod'
.
Example:
from deribit_wrapper import DeribitClient
client = DeribitClient(client_id='your_client_id', client_secret='your_client_secret')
Usage
Market Data
- Get Contract Size:
get_contract_size(asset)
- Get Currencies:
get_currencies()
- Get Ticker Information:
get_ticker(asset)
- Get Book Summary by Currency:
get_complete_market_book()
- and more...
Account Information
- Authenticate: Automatically handled during requests to private endpoints.
- Get Account Summary:
get_account_summary(currency)
- Get Positions:
get_positions(currency, kind)
- and more...
Trading
- Place an Order:
order(asset, amount, limit=None, label=None, reduce_only=False)
- Place a Market Order:
market_order(asset, amount, label=None, reduce_only=False)
- Bulk Orders:
bulk_order(orders, label=None)
- and more...
Examples
- Retrieving Market Data:
ticker_info = client.get_ticker('BTC-25JUN21')
print(ticker_info)
- Placing a Market Order:
order_response = client.market_order('BTC-25JUN21', 1)
print(order_response)
- Getting Account Summary:
account_summary = client.get_account_summary('BTC')
print(account_summary)
Getting Help
If you encounter any issues or have questions about using deribit-wrapper
,
please create an issue in the GitHub repository.
Contributing
Contributions to deribit-wrapper
are welcome!
Whether it's bug reports, feature requests, or code contributions, please feel free to make a contribution. For code
contributions, please:
- Fork the repository.
- Create a new branch for your feature or fix.
- Submit a pull request.
Please ensure your code adheres to the project's coding standards and includes appropriate tests.
License
deribit-wrapper
is released under the MIT License. See the LICENSE file for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file deribit_wrapper-0.3.3.tar.gz
.
File metadata
- Download URL: deribit_wrapper-0.3.3.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff9ceaf6db914581fa047fbb3d6b6d8f058878958fcc170b90be6f1308c27e7b |
|
MD5 | 7b34e3818bc2dd7f8ff2372c69d110e5 |
|
BLAKE2b-256 | 770b1363cd0ec791b4e215f48166ce2e471da71738bef99019c1737236ae6408 |
File details
Details for the file deribit_wrapper-0.3.3-py3-none-any.whl
.
File metadata
- Download URL: deribit_wrapper-0.3.3-py3-none-any.whl
- Upload date:
- Size: 23.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 063ac4760ec253ab256c8b3a866b2ede8197f85f6af71d8bdf9379ac015ccd91 |
|
MD5 | ea6fd89870b86f7bc6b7f8c80a116bcd |
|
BLAKE2b-256 | edda6864d14d8ef2a5725bcc61119dd36a55cb6d7bfcfcef2a561da4ae5f0d2d |