Skip to main content

A simple Python client to interact with the Kraken cryptocurrency exchange API.

Project description

KrakenCLI

This is a Python module for interacting with Kraken's REST and WebSocket APIs.

Usage

Setting Up API Credentials

To use kraken-python, you need to provide your API credentials through environment variables. For security reasons, using a .env file is not allowed.

Set the following environment variables in your terminal:

  • KRAKEN_PYTHON_API_KEY: Your Kraken API key.
  • KRAKEN_PYTHON_API_SECRET: Your Kraken API secret.

To set them in your terminal (Linux/macOS):

export KRAKEN_PYTHON_API_KEY="your_api_key_here"
export KRAKEN_PYTHON_API_SECRET="your_api_secret_here"

On Windows (Command Prompt):

set KRAKEN_PYTHON_API_KEY="your_api_key_here"
set KRAKEN_PYTHON_API_SECRET="your_api_secret_here"

Contributions

All contributors are welcome! Since we are still in the early stages of development, we will be writing a guide about contributing soon.

In the meantime, just make sure you fork the repo, run the tests, and ensure that coverage is not reduced.

We understand that this process may be frustrating, especially for those making the effort to raise a PR and receiving unexpected comments. Once we have a proper guide, these issues should be mitigated. If you're not comfortable with this for now, it's perfectly okay to hold off on contributing.

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

krakenstream-0.1.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

krakenstream-0.1.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file krakenstream-0.1.0.tar.gz.

File metadata

  • Download URL: krakenstream-0.1.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.6

File hashes

Hashes for krakenstream-0.1.0.tar.gz
Algorithm Hash digest
SHA256 20a7c0091d036f3eb59bfdc5d9dcf77f76baea00a006e5fa7bfc3339775a9cf9
MD5 7b3ac306ff8f040ff25c0a574c997c1c
BLAKE2b-256 bfab7839b36d985515c2ae7a8cc9450dd4aad67c986a70b922bf3fb3d479a133

See more details on using hashes here.

File details

Details for the file krakenstream-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: krakenstream-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.6

File hashes

Hashes for krakenstream-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 63e798d10dde185c154dbdfde4379ffd6150313a6d353b94d074e8dbb7159080
MD5 e222c05bb2baec147215f3508f54f9ef
BLAKE2b-256 84c251b650acb035ce0e7fae4dbae28fe30df08dce8751dfc6434e8cc6cae9d9

See more details on using hashes here.

Supported by

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