Skip to main content

Algorand SDK in Python

Project description


Build Status PyPI version Documentation Status

A python library for interacting with the Algorand network.


Run $ pip3 install py-algorand-sdk to install the package.

Alternatively, choose a distribution file, and run $ pip3 install [file name].

SDK Development

Run tests with make docker-test

Quick start

Here's a simple example you can run without a node.

from algosdk import account, encoding

# generate an account
private_key, address = account.generate_account()
print("Private key:", private_key)
print("Address:", address)

# check if the address is valid
if encoding.is_valid_address(address):
    print("The address is valid!")
    print("The address is invalid.")

Node setup

Follow the instructions in Algorand's developer resources to install a node on your computer.

Running examples/

Before running, start kmd on a private network or testnet node:

$ ./goal kmd start -d [data directory]

Next, create a wallet and an account:

$ ./goal wallet new [wallet name] -d [data directory]
$ ./goal account new -d [data directory] -w [wallet name]

Visit the Algorand dispenser and enter the account address to fund your account.

Next, in, either update the tokens and addresses, or provide a path to the data directory.

You're now ready to run!


Documentation for the Python SDK is available at


py-algorand-sdk is licensed under a MIT license. See the LICENSE file for details.

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

py-algorand-sdk-1.5.0.tar.gz (82.5 kB view hashes)

Uploaded source

Built Distribution

py_algorand_sdk-1.5.0-py3-none-any.whl (99.2 kB view hashes)

Uploaded py3

Supported by

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