Stellar Python SDK

py-stellar-base is a Python library for communicating with a Stellar Horizon server and Soroban-RPC server. It is used for building Stellar apps on Python. It supports Python 3.8+ as well as PyPy 3.8+.

It provides:

• a networking layer API for Horizon endpoints.

• a networking layer API for Soroban-RPC server methods.

• facilities for building and signing transactions, for communicating with a Stellar Horizon and Soroban-RPC instance, and for submitting transactions or querying network history.

Quickstart

At the absolute basics, you’ll want to read up on Stellar’s Documentation Guides, as it contains a lot of information on the concepts used below (Transactions, Payments, Operations, KeyPairs, etc.).

• Installation
  • Via pip
  • Via Source Code
• Generate Keypair
• Create Account
  • Using The SDF Testnet
  • Using The Stellar Live Network
• Querying Horizon
  • Building requests
  • Streaming requests
• Assets
• Building Transactions
  • TransactionBuilder
  • Sequence Numbers
  • Adding Memos
  • Transaction and TransactionEnvelope
• Creating a payment transaction
  • Payment
  • Path Payment
• Asynchronous
• Multi-signature account
• XDR

API Documentation

Here you’ll find detailed documentation on specific functions, classes, and methods.

• API Documentation
  • Account
  • Address
  • Asset
  • Call Builder
  • Call Builder Async
  • Client
  • Exceptions
  • Keypair
  • LiquidityPoolAsset
  • LiquidityPoolId
  • Memo
  • MuxedAccount
  • Network
  • Operation
  • Price
  • Server
  • ServerAsync
  • Signer
  • SignerKey
  • StrKey
  • TimeBounds
  • DecoratedSignature
  • Transaction
  • TransactionEnvelope
  • FeeBumpTransaction
  • FeeBumpTransactionEnvelope
  • TransactionBuilder
  • SorobanDataBuilder
  • SorobanServer
  • SorobanServer
  • Soroban RPC Definitions
  • scval
  • Auth
  • Helpers
  • Stellar Ecosystem Proposals
  • stellar_sdk.xdr

stellar-model

stellar-model allows you to parse the JSON returned by Stellar Horizon into the Python models, click here for more information.

Links

• Document: https://stellar-sdk.readthedocs.io

• Code: https://github.com/StellarCN/py-stellar-base

• Examples: https://github.com/StellarCN/py-stellar-base/tree/main/examples

• Issue tracker: https://github.com/StellarCN/py-stellar-base/issues

• License: Apache License 2.0

• Releases: https://pypi.org/project/stellar-sdk/

Thanks

This document is based on Stellar JavaScript SDK documentation. Thank you to all the people who have already contributed to Stellar ecosystem!

Index