Skip to main content

SDK for CryptoDock's remote API. Includes an semantic API interface, Strategy Wrapper and Backtest Wrapper. The SDK is meant to be leveraged with strategies bootstrapped from the CryptoDock desktop interface. Strategy trading and backtesting is managed through the desktop app interface.

Project description

CryptoDock Python SDK

CryptoDock SDK is a Python package used alongside the CryptoDock desktop iOS app, the CryptoDock remote API.

When bootstrapping a trading strategy in the CryptoDock desktop app the SDK is copied into the target local directory for your use in strategy development. It communicates with the remote API to pull historic and current trading data from multiple exchanges.

Additionally the SDK provides a Strategy Wrapper and Backtest Layer that is managed from the CryptoDock desktop interface.

Using this method we can normalize the structures of data from across the exchanges, run comprehensive and adaptable backtest, and provide a semantic interface, allowing for a much more efficient strategy development and research process.

Installation

To install the SDK run: pip install cryptodock-sdk, or pip install cryptodock-sdk==0.0.1

This package will not work unless used alongside CryptoDock.

Usage

Import Package(s)

  • from cryptodock import CryptoDockSdk
  • from cryptodock import CryptoDockApi, CryptoDockStrategy, CryptoDockBacktest

Initialize SDK

  • full_sdk = CryptoDockSdk()

  • full_sdk.Api.Local.get_products(exchanges="coinbasepro")

  • full_sdk.Strategy

  • full_sdk.Backtest(<your_strategy>)

  • api = CryptoDockApi(base=<base_url>, port=<port>, version=<api_version>)

  • api.Local.get_exchanges()

  • api.CoinbasePro.get_trade_histories('BTC-USDT')

  • YourStrategy(CryptoDockStrategy)

  • backtest = CryptoDockBacktest(YourStrategy)

  • backtest.run_test(data)

History

  • Initial Release
  • Integrating backtest and strategy wrapper, not just api sdk

Credits

  • Company: ©2019 The Launch
  • Author: Daniel Griffiths
  • Role: Founder and Engineer
  • Project: ©2020 CryptoDock

License

MIT Licence ©2020 Daniel Griffiths

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cryptodock-sdk-0.1.3.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

cryptodock_sdk-0.1.3-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file cryptodock-sdk-0.1.3.tar.gz.

File metadata

  • Download URL: cryptodock-sdk-0.1.3.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.0

File hashes

Hashes for cryptodock-sdk-0.1.3.tar.gz
Algorithm Hash digest
SHA256 70b5e1081c4412a5429c0a178d4f628be54fc32285156e7c663b2f4a8b3e867c
MD5 9e5cba97a337f34ba8d1663ecd0eacee
BLAKE2b-256 876e7a65c1e7efc5f4676db76559dd3206957d2772f65ba3d62d54fb8d9885dc

See more details on using hashes here.

File details

Details for the file cryptodock_sdk-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: cryptodock_sdk-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.0

File hashes

Hashes for cryptodock_sdk-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3d386457bff2141b8b16444d8c38ccff06a2166a2a441377a6a6a6d73f4f3f82
MD5 c47229f0a4a23c0263442ebf68735259
BLAKE2b-256 19fc9eecd5a86323b354c6ae8d05491bda3fed3425ae6d5cf5406bad6e3d8e61

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page