Installation

Install StakeAPI and all its dependencies in seconds.

---

Quick Install

The easiest way to install StakeAPI is with pip:

pip install stakeapi

This installs StakeAPI and all required dependencies:

Dependency	Purpose
aiohttp ≥ 3.8.0	Async HTTP client for API requests
pydantic ≥ 2.0.0	Data validation and type-safe models
python-dotenv ≥ 0.19.0	Environment variable management
websockets ≥ 10.0	Real-time WebSocket connections
cryptography ≥ 3.4.8	Secure token handling

Install from Source

If you want the latest development version:

git clone https://github.com/chipadevteam/StakeAPI.git
cd StakeAPI
pip install -e .

Install with Development Dependencies

For contributors and developers who want to run tests and linting:

pip install -e ".[dev]"

This adds:

Tool	Purpose
pytest	Test framework
pytest-asyncio	Async test support
pytest-cov	Code coverage
black	Code formatting
isort	Import sorting
flake8	Linting
mypy	Type checking
pre-commit	Git hooks

Install with Documentation Dependencies

pip install -e ".[docs]"

Virtual Environment Setup (Recommended)

We recommend using a virtual environment to avoid dependency conflicts:

Using venv (Built-in)

# Create virtual environment
python -m venv .venv

# Activate (Windows)
.venv\Scripts\activate

# Activate (macOS/Linux)
source .venv/bin/activate

# Install StakeAPI
pip install stakeapi

Using conda

conda create -n stakeapi python=3.11
conda activate stakeapi
pip install stakeapi

Using Poetry

poetry add stakeapi

Verify Installation

After installation, verify everything works:

import stakeapi
print(f"StakeAPI version: {stakeapi.__version__}")

You should see output like:

StakeAPI version: 0.1.0

System Requirements

Requirement	Minimum
Python	3.8+
OS	Windows, macOS, Linux
Memory	64 MB
Network	Internet connection required

💡 Don't have a Stake.com account yet? Sign up here to get started and unlock all API features.

Next Steps

Now that StakeAPI is installed, you need a Stake.com account and access token:

• Sign up on Stake.com if you don’t have an account
• Authentication Guide — Learn how to get your access token
• Quick Start — Make your first API call

🎰 Ready to experience Stake.com?

Create your account and start using StakeAPI with real data today.

Sign Up on Stake.com →

💬 Join the StakeAPI Community on Discord

Get help, share your projects, discuss strategies, and stay up to date with the latest StakeAPI news.

Join Our Discord Server →