stellar-sdk


Namestellar-sdk JSON
Version 13.0.0 PyPI version JSON
download
home_pageNone
SummaryThe Python Stellar SDK library provides APIs to build transactions and connect to Horizon and Stellar RPC server.
upload_time2025-08-14 23:52:59
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.9
licenseNone
keywords stellar-sdk stellar stellar.org lumens xlm blockchain distributed exchange cryptocurrency dex horizon soroban sdex trading soroban soroban-rpc stellar-rpc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Stellar Python SDK

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/StellarCN/py-stellar-base/continuous-integration-workflow.yml?branch=main)](https://github.com/StellarCN/py-stellar-base/actions)
[![Read the Docs](https://img.shields.io/readthedocs/stellar-sdk.svg)](https://stellar-sdk.readthedocs.io/en/latest/)
[![PyPI - Downloads](https://static.pepy.tech/personalized-badge/stellar-sdk?period=total&units=abbreviation&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pypi.python.org/pypi/stellar-sdk)
[![Codecov](https://img.shields.io/codecov/c/github/StellarCN/py-stellar-base/main)](https://codecov.io/gh/StellarCN/py-stellar-base)
[![PyPI](https://img.shields.io/pypi/v/stellar-sdk.svg)](https://pypi.python.org/pypi/stellar-sdk)
[![Stellar Protocol](https://img.shields.io/badge/Stellar%20Protocol-23-blue)](https://developers.stellar.org/docs/learn/fundamentals/stellar-consensus-protocol)

py-stellar-base is a Python library for communicating with
a [Stellar Horizon server](https://github.com/stellar/go/tree/master/services/horizon) and [Stellar RPC server](https://developers.stellar.org/docs/data/apis/rpc). It is used for building Stellar apps on Python. It supports **Python 3.9+** as
well as PyPy 3.9+.

It provides:

- a networking layer API for Horizon endpoints.
- a networking layer API for Stellar RPC server methods.
- facilities for building and signing transactions, for communicating with a Stellar Horizon and Stellar 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

```text
pip install --upgrade stellar-sdk
```

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

```text
pip install --upgrade stellar-sdk[aiohttp]
```

If you need to [Shamir backup](https://trezor.io/learn/advanced/standards-proposals/what-is-shamir-backup) support, please use the following command to install the required dependencies.

```
pip install --upgrade stellar-sdk[shamir]
```

We follow [Semantic Versioning 2.0.0](https://semver.org/), 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](./examples).

```python
# 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-contract-bindings

stellar-contract-bindings allows you to generate Python bindings for Stellar Soroban smart contracts, it makes calling
Stellar Soroban contracts easier. click [here](https://github.com/lightsail-network/stellar-contract-bindings) for more information.

## stellar-model

stellar-model allows you to parse the JSON returned by Stellar Horizon
into the Python models, click [here](https://github.com/StellarCN/stellar-model) for more information.

## Contributing

Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.

## 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](https://github.com/StellarCN/py-stellar-base/blob/master/LICENSE)
- Releases: https://pypi.org/project/stellar-sdk/

Thank you to all the people who have already contributed to py-stellar-base!


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "stellar-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": "overcat <4catcode@gmail.com>",
    "keywords": "stellar-sdk, stellar, stellar.org, lumens, xlm, blockchain, distributed exchange, cryptocurrency, dex, horizon, soroban, sdex, trading, soroban, soroban-rpc, stellar-rpc",
    "author": null,
    "author_email": "overcat <4catcode@gmail.com>, Eno <appweb.cn@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/cd/c8/99026ab1dde5ba5170b76f028f867d25b6607bca8516e301aecbdd222582/stellar_sdk-13.0.0.tar.gz",
    "platform": null,
    "description": "# Stellar Python SDK\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/StellarCN/py-stellar-base/continuous-integration-workflow.yml?branch=main)](https://github.com/StellarCN/py-stellar-base/actions)\n[![Read the Docs](https://img.shields.io/readthedocs/stellar-sdk.svg)](https://stellar-sdk.readthedocs.io/en/latest/)\n[![PyPI - Downloads](https://static.pepy.tech/personalized-badge/stellar-sdk?period=total&units=abbreviation&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pypi.python.org/pypi/stellar-sdk)\n[![Codecov](https://img.shields.io/codecov/c/github/StellarCN/py-stellar-base/main)](https://codecov.io/gh/StellarCN/py-stellar-base)\n[![PyPI](https://img.shields.io/pypi/v/stellar-sdk.svg)](https://pypi.python.org/pypi/stellar-sdk)\n[![Stellar Protocol](https://img.shields.io/badge/Stellar%20Protocol-23-blue)](https://developers.stellar.org/docs/learn/fundamentals/stellar-consensus-protocol)\n\npy-stellar-base is a Python library for communicating with\na [Stellar Horizon server](https://github.com/stellar/go/tree/master/services/horizon) and [Stellar RPC server](https://developers.stellar.org/docs/data/apis/rpc). It is used for building Stellar apps on Python. It supports **Python 3.9+** as\nwell as PyPy 3.9+.\n\nIt provides:\n\n- a networking layer API for Horizon endpoints.\n- a networking layer API for Stellar RPC server methods.\n- facilities for building and signing transactions, for communicating with a Stellar Horizon and Stellar RPC instance, and for submitting transactions or querying network history.\n\n## Documentation\n\npy-stellar-base's documentation can be found at https://stellar-sdk.readthedocs.io.\n\n## Installing\n\n```text\npip install --upgrade stellar-sdk\n```\n\nIf you need to use asynchronous, please use the following command to install the required dependencies.\n\n```text\npip install --upgrade stellar-sdk[aiohttp]\n```\n\nIf you need to [Shamir backup](https://trezor.io/learn/advanced/standards-proposals/what-is-shamir-backup) support, please use the following command to install the required dependencies.\n\n```\npip install --upgrade stellar-sdk[shamir]\n```\n\nWe follow [Semantic Versioning 2.0.0](https://semver.org/), and I strongly\nrecommend that you specify its major version number in the dependency\nfile to avoid the unknown effects of breaking changes.\n\n## A Simple Example\n\nYou can find more examples [here](./examples).\n\n```python\n# Alice pay 10.25 XLM to Bob\nfrom stellar_sdk import Asset, Server, Keypair, TransactionBuilder, Network\n\nalice_keypair = Keypair.from_secret(\"SBFZCHU5645DOKRWYBXVOXY2ELGJKFRX6VGGPRYUWHQ7PMXXJNDZFMKD\")\nbob_address = \"GA7YNBW5CBTJZ3ZZOWX3ZNBKD6OE7A7IHUQVWMY62W2ZBG2SGZVOOPVH\"\n\nserver = Server(\"https://horizon-testnet.stellar.org\")\nalice_account = server.load_account(alice_keypair.public_key)\nbase_fee = 100\ntransaction = (\n    TransactionBuilder(\n        source_account=alice_account,\n        network_passphrase=Network.TESTNET_NETWORK_PASSPHRASE,\n        base_fee=base_fee,\n    )\n    .add_text_memo(\"Hello, Stellar!\")\n    .append_payment_op(bob_address, Asset.native(), \"10.25\")\n    .set_timeout(30)\n    .build()\n)\ntransaction.sign(alice_keypair)\nresponse = server.submit_transaction(transaction)\nprint(response)\n```\n\n## stellar-contract-bindings\n\nstellar-contract-bindings allows you to generate Python bindings for Stellar Soroban smart contracts, it makes calling\nStellar Soroban contracts easier. click [here](https://github.com/lightsail-network/stellar-contract-bindings) for more information.\n\n## stellar-model\n\nstellar-model allows you to parse the JSON returned by Stellar Horizon\ninto the Python models, click [here](https://github.com/StellarCN/stellar-model) for more information.\n\n## Contributing\n\nContributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.\n\n## Links\n\n- Document: https://stellar-sdk.readthedocs.io\n- Code: https://github.com/StellarCN/py-stellar-base\n- Examples: https://github.com/StellarCN/py-stellar-base/tree/main/examples\n- Issue tracker: https://github.com/StellarCN/py-stellar-base/issues\n- License: [Apache License 2.0](https://github.com/StellarCN/py-stellar-base/blob/master/LICENSE)\n- Releases: https://pypi.org/project/stellar-sdk/\n\nThank you to all the people who have already contributed to py-stellar-base!\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The Python Stellar SDK library provides APIs to build transactions and connect to Horizon and Stellar RPC server.",
    "version": "13.0.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/StellarCN/py-stellar-base/issues",
        "Changelog": "https://github.com/StellarCN/py-stellar-base/blob/main/CHANGELOG.md",
        "Documentation": "https://stellar-sdk.readthedocs.io/",
        "Homepage": "https://github.com/StellarCN/py-stellar-base",
        "Issues": "https://github.com/StellarCN/py-stellar-base/issues",
        "Repository": "https://github.com/StellarCN/py-stellar-base"
    },
    "split_keywords": [
        "stellar-sdk",
        " stellar",
        " stellar.org",
        " lumens",
        " xlm",
        " blockchain",
        " distributed exchange",
        " cryptocurrency",
        " dex",
        " horizon",
        " soroban",
        " sdex",
        " trading",
        " soroban",
        " soroban-rpc",
        " stellar-rpc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1b3d44990ce3c96bf65471b790dcc0b191c6aa7012000bf5bcd31634bbe0cad7",
                "md5": "ed58aedcb500e1a37d777b498dbbc118",
                "sha256": "2fe3f4fee07518d53aad38cb093f5f4159b6aefa35998031e9c601bfa93e4339"
            },
            "downloads": -1,
            "filename": "stellar_sdk-13.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ed58aedcb500e1a37d777b498dbbc118",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 765622,
            "upload_time": "2025-08-14T23:52:57",
            "upload_time_iso_8601": "2025-08-14T23:52:57.085891Z",
            "url": "https://files.pythonhosted.org/packages/1b/3d/44990ce3c96bf65471b790dcc0b191c6aa7012000bf5bcd31634bbe0cad7/stellar_sdk-13.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cdc899026ab1dde5ba5170b76f028f867d25b6607bca8516e301aecbdd222582",
                "md5": "aea0d3131cc34d1676d7006148031bad",
                "sha256": "45545ee0e696cda88047f1cb5ff3ff7cf02c36a7544ea6eb91e83b4b4cc20742"
            },
            "downloads": -1,
            "filename": "stellar_sdk-13.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "aea0d3131cc34d1676d7006148031bad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 317067,
            "upload_time": "2025-08-14T23:52:59",
            "upload_time_iso_8601": "2025-08-14T23:52:59.343969Z",
            "url": "https://files.pythonhosted.org/packages/cd/c8/99026ab1dde5ba5170b76f028f867d25b6607bca8516e301aecbdd222582/stellar_sdk-13.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-14 23:52:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "StellarCN",
    "github_project": "py-stellar-base",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "stellar-sdk"
}
        
Elapsed time: 1.30526s