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:

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:

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

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