Skip to main content

The Python Stellar SDK library provides APIs to build transactions and connect to Horizon and Soroban-RPC server.

Project description

GitHub Workflow Status Read the Docs PyPI - Downloads Code Climate maintainability Codecov PyPI Python - Version PyPI - Implementation Stellar Protocol

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.

Documentation

py-stellar-base’s documentation can be found at https://stellar-sdk.readthedocs.io.

Installing

pip install --upgrade stellar-sdk

If you need to use asynchronous, please use the following command to install the required dependencies.

pip install --upgrade stellar-sdk[aiohttp]

We follow Semantic Versioning 2.0.0, and I strongly recommend that you specify its major version number in the dependency file to avoid the unknown effects of breaking changes.

A Simple Example

You can find more examples here.

# Alice pay 10.25 XLM to Bob
from stellar_sdk import Asset, Server, Keypair, TransactionBuilder, Network

alice_keypair = Keypair.from_secret("SBFZCHU5645DOKRWYBXVOXY2ELGJKFRX6VGGPRYUWHQ7PMXXJNDZFMKD")
bob_address = "GA7YNBW5CBTJZ3ZZOWX3ZNBKD6OE7A7IHUQVWMY62W2ZBG2SGZVOOPVH"

server = Server("https://horizon-testnet.stellar.org")
alice_account = server.load_account(alice_keypair.public_key)
base_fee = 100
transaction = (
    TransactionBuilder(
        source_account=alice_account,
        network_passphrase=Network.TESTNET_NETWORK_PASSPHRASE,
        base_fee=base_fee,
    )
    .add_text_memo("Hello, Stellar!")
    .append_payment_op(bob_address, Asset.native(), "10.25")
    .set_timeout(30)
    .build()
)
transaction.sign(alice_keypair)
response = server.submit_transaction(transaction)
print(response)

stellar-model

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

Project details


Release history Release notifications | RSS feed

This version

9.4.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stellar_sdk-9.4.0.tar.gz (284.2 kB view details)

Uploaded Source

Built Distribution

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

stellar_sdk-9.4.0-py3-none-any.whl (690.0 kB view details)

Uploaded Python 3

File details

Details for the file stellar_sdk-9.4.0.tar.gz.

File metadata

  • Download URL: stellar_sdk-9.4.0.tar.gz
  • Upload date:
  • Size: 284.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for stellar_sdk-9.4.0.tar.gz
Algorithm Hash digest
SHA256 0014233f3f8e96f723042a37e0d7ff398a0a162b1671cd853c157cade662ff39
MD5 ec1d517f76d273911e23cbae2ae2fe1c
BLAKE2b-256 51d750aaab65dce629e1917b43949aad45e5cd7b181b16ccbf5082758e96f7be

See more details on using hashes here.

File details

Details for the file stellar_sdk-9.4.0-py3-none-any.whl.

File metadata

  • Download URL: stellar_sdk-9.4.0-py3-none-any.whl
  • Upload date:
  • Size: 690.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for stellar_sdk-9.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5fed2b91a6082de678d88d4027744f30e6af586d7a91ece0f65fd8bcbad75b5
MD5 8eb84b92f7ceb9e46d8b3c240a4d1123
BLAKE2b-256 00ae5dad6608046a72d48444a3374013f0503d6a8e6d3e00b94f1fdc1ef79515

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