API Documentation¶

Account¶

class stellar_sdk.account.Account(account_id, sequence)[source]¶

The Account object represents a single account on the Stellar network and its sequence number.

Account tracks the sequence number as it is used by TransactionBuilder

See Accounts For more information about the formats used for asset codes and how issuers work on Stellar,

Parameters

account_id (str) – Account ID of the account (ex. GB3KJPLFUYN5VL6R3GU3EGCGVCKFDSD7BEDX42HWG5BWFKB3KQGJJRMA)
sequence (int) – sequence current sequence number of the account

Raises

Ed25519PublicKeyInvalidError: if account_id is not a valid ed25519 public key.

increment_sequence_number()[source]¶

Increments sequence number in this object by one.

Return type: None

load_ed25519_public_key_signers()[source]¶

Load ed25519 public key signers, may change in 3.0.

Return type: List[Ed25519PublicKeySigner]

Asset¶

class stellar_sdk.asset.Asset(code, issuer=None)[source]¶

The Asset object, which represents an asset and its corresponding issuer on the Stellar network.

For more information about the formats used for asset codes and how issuers work on Stellar’s network, see Stellar’s guide on assets.

Parameters

code (str) – The asset code, in the formats specified in Stellar’s guide on assets.
issuer (Optional[str]) – The account ID of the issuer. Note if the currency is the native currency (XLM (Lumens)), no issuer is necessary.

Raises

AssetCodeInvalidError: if code is invalid.

AssetIssuerInvalidError: if issuer is not a valid ed25519 public key.

classmethod from_xdr_object(xdr_object)[source]¶

Create a Asset from an XDR Asset object.

Parameters: xdr_object (Asset) – The XDR Asset object.
Return type: Asset
Returns: A new Asset object from the given XDR Asset object.

guess_asset_type()[source]¶

Return the type of the asset, Can be one of following types: native, credit_alphanum4 or credit_alphanum12

Return type: str
Returns: The type of the asset.

is_native()[source]¶

Return true if the Asset is the native asset.

Return type: bool
Returns: True if the Asset is native, False otherwise.

classmethod native()[source]¶

Returns an asset object for the native asset.

Return type: Asset
Returns: An asset object for the native asset.

to_dict()[source]¶

Generate a dict for this object’s attributes.

Return type: dict
Returns: A dict representing an Asset

to_xdr_object()[source]¶

Returns the xdr object for this asset.

Return type: Asset
Returns: XDR Asset object

property type¶

Return the type of the asset, Can be one of following types: native, credit_alphanum4 or credit_alphanum12

Return type: str
Returns: The type of the asset.

Call Builder¶

BaseCallBuilder¶

class stellar_sdk.call_builder.BaseCallBuilder(horizon_url, client)[source]¶

Creates a new BaseCallBuilder pointed to server defined by horizon_url.

This is an abstract class. Do not create this object directly, use stellar_sdk.server.Server class.

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()[source]¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)[source]¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)[source]¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)[source]¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()[source]¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

AccountsCallBuilder¶

class stellar_sdk.call_builder.AccountsCallBuilder(horizon_url, client)[source]¶

Creates a new AccountsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.accounts().

Parameters

horizon_url – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

account_id(account_id)[source]¶

Returns information and links relating to a single account. The balances section in the returned JSON will also list all the trust lines this account has set up.

See Account Details

Parameters: account_id (str) – account id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: AccountsCallBuilder
Returns: current AccountCallBuilder instance

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_asset(asset)[source]¶

Filtering accounts who have a trustline to an asset. The result is a list of accounts.

See Account Details

Parameters: asset (Asset) – an issued asset
Return type: AccountsCallBuilder
Returns: current AccountCallBuilder instance

for_signer(signer)[source]¶

Filtering accounts who have a given signer. The result is a list of accounts.

See Account Details

Parameters: signer (str) – signer’s account id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: AccountsCallBuilder
Returns: current AccountCallBuilder instance

for_sponsor(sponsor)[source]¶

Filtering accounts where the given account is sponsoring the account or any of its sub-entries.

See Account Details

Parameters: sponsor (str) – the sponsor id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: AccountsCallBuilder
Returns: current AccountCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

AssetsCallBuilder¶

class stellar_sdk.call_builder.AssetsCallBuilder(horizon_url, client)[source]¶

Creates a new AssetsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.assets().

See All Assets

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_code(asset_code)[source]¶

This endpoint filters all assets by the asset code.

Parameters: asset_code (str) – asset code, for example: USD
Return type: AssetsCallBuilder
Returns: current AssetCallBuilder instance

for_issuer(asset_issuer)[source]¶

This endpoint filters all assets by the asset issuer.

Parameters: asset_issuer (str) – asset issuer, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: AssetsCallBuilder
Returns: current AssetCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

ClaimableBalancesCallBuilder¶

class stellar_sdk.call_builder.ClaimableBalancesCallBuilder(horizon_url, client)[source]¶

Creates a new ClaimableBalancesCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.claimable_balance().

Parameters

horizon_url – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

claimable_balance(claimable_balance_id)[source]¶

Returns information and links relating to a single claimable balance.

See Claimable Balances

Parameters: claimable_balance_id (str) – claimable balance id
Return type: ClaimableBalancesCallBuilder
Returns: current AccountCallBuilder instance

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_asset(asset)[source]¶

Returns all claimable balances which provide a balance for the given asset.

See Account Details

Parameters: asset (Asset) – an asset
Return type: ClaimableBalancesCallBuilder
Returns: current ClaimableBalancesCallBuilder instance

for_claimant(claimant)[source]¶

Returns all claimable balances which can be claimed by the given account ID.

See Account Details

Parameters: claimant (str) – the account id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: ClaimableBalancesCallBuilder
Returns: current ClaimableBalancesCallBuilder instance

for_sponsor(sponsor)[source]¶

Returns all claimable balances which are sponsored by the given account ID.

See Claimable Balances

Parameters: sponsor (str) – the sponsor id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: ClaimableBalancesCallBuilder
Returns: current ClaimableBalancesCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

DataCallBuilder¶

class stellar_sdk.call_builder.DataCallBuilder(horizon_url, client, account_id, data_name)[source]¶

Creates a new DataCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.data().

See Data for Account

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.
account_id (str) – account id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
data_name (str) – Key name

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

EffectsCallBuilder¶

class stellar_sdk.call_builder.EffectsCallBuilder(horizon_url, client)[source]¶

Creates a new EffectsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.effects().

See All Effects

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_account(account_id)[source]¶

This endpoint represents all effects that changed a given account. It will return relevant effects from the creation of the account to the current ledger.

See Effects for Account

Parameters: account_id (str) – account id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: EffectsCallBuilder
Returns: this EffectCallBuilder instance

for_ledger(sequence)[source]¶

Effects are the specific ways that the ledger was changed by any operation. This endpoint represents all effects that occurred in the given ledger.

See Effects for Ledger

Parameters: sequence (Union[int, str]) – ledger sequence
Return type: EffectsCallBuilder
Returns: this EffectCallBuilder instance

for_operation(operation_id)[source]¶

This endpoint represents all effects that occurred as a result of a given operation.

See Effects for Operation

Parameters: operation_id (Union[int, str]) – operation ID
Return type: EffectsCallBuilder
Returns: this EffectCallBuilder instance

for_transaction(transaction_hash)[source]¶

This endpoint represents all effects that occurred as a result of a given transaction.

See Effects for Transaction

Parameters: transaction_hash (str) – transaction hash
Return type: EffectsCallBuilder
Returns: this EffectCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

FeeStatsCallBuilder¶

class stellar_sdk.call_builder.FeeStatsCallBuilder(horizon_url, client)[source]¶

Creates a new FeeStatsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.fee_stats().

See Fee Stats

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

LedgersCallBuilder¶

class stellar_sdk.call_builder.LedgersCallBuilder(horizon_url, client)[source]¶

Creates a new LedgersCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.ledgers().

See All Ledgers

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

ledger(sequence)[source]¶

Provides information on a single ledger.

See Ledger Details

Parameters: sequence (Union[int, str]) – Ledger sequence
Return type: LedgersCallBuilder
Returns: current LedgerCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

OffersCallBuilder¶

class stellar_sdk.call_builder.OffersCallBuilder(horizon_url, client)[source]¶

Creates a new OffersCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.offers().

See Offer Details See Offers

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_buying(buying)[source]¶

Returns all offers buying an asset.

People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the current offers, allowing filtering by seller, selling_asset or buying_asset.

See Offers

Parameters: buying (Asset) – The asset being bought.
Returns: this OffersCallBuilder instance

for_seller(seller)[source]¶

Returns all offers where the given account is the seller.

People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the current offers, allowing filtering by seller, selling_asset or buying_asset.

See Offers

Parameters: seller (str) – Account ID of the offer creator
Returns: this OffersCallBuilder instance

for_selling(selling)[source]¶

Returns all offers selling an asset.

People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the current offers, allowing filtering by seller, selling_asset or buying_asset.

See Offers

Parameters: selling (Asset) – The asset being sold.
Returns: this OffersCallBuilder instance

for_sponsor(sponsor)[source]¶

Filtering offers where the given account is sponsoring the offer entry.

See Offer Details

Parameters: sponsor (str) – the sponsor id, for example: GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD
Return type: OffersCallBuilder
Returns: current OffersCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

offer(offer_id)[source]¶

Returns information and links relating to a single offer.

See Offer Details

Parameters: offer_id (Union[str, int]) – Offer ID.
Returns: this OffersCallBuilder instance

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

OperationsCallBuilder¶

class stellar_sdk.call_builder.OperationsCallBuilder(horizon_url, client)[source]¶

Creates a new OperationsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.operations().

See All Operations

Parameters

horizon_url – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_account(account_id)[source]¶

This endpoint represents all operations that were included in valid transactions that affected a particular account.

See Operations for Account

Parameters: account_id (str) – Account ID
Return type: OperationsCallBuilder
Returns: this OperationCallBuilder instance

for_ledger(sequence)[source]¶

This endpoint returns all operations that occurred in a given ledger.

See Operations for Ledger

Parameters: sequence (Union[int, str]) – Sequence ID
Return type: OperationsCallBuilder
Returns: this OperationCallBuilder instance

for_transaction(transaction_hash)[source]¶

This endpoint represents all operations that are part of a given transaction.

See Operations for Transaction

Parameters: transaction_hash (str) –
Return type: OperationsCallBuilder
Returns: this OperationCallBuilder instance

include_failed(include_failed)[source]¶

Adds a parameter defining whether to include failed transactions. By default only operations of successful transactions are returned.

Parameters: include_failed (bool) – Set to True to include operations of failed transactions.
Return type: OperationsCallBuilder
Returns: current OperationsCallBuilder instance

join(join)[source]¶

join represents join param in queries, currently only supports transactions

Parameters: join (str) – join represents join param in queries, currently only supports transactions
Return type: OperationsCallBuilder
Returns: current OperationsCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

operation(operation_id)[source]¶

The operation details endpoint provides information on a single operation. The operation ID provided in the id argument specifies which operation to load.

See Operation Details

Parameters: operation_id (Union[int, str]) – Operation ID
Return type: OperationsCallBuilder
Returns: this OperationCallBuilder instance

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

OrderbookCallBuilder¶

class stellar_sdk.call_builder.OrderbookCallBuilder(horizon_url, client, selling, buying)[source]¶

Creates a new OrderbookCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.orderbook().

See Orderbook Details

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.
selling (Asset) – Asset being sold
buying (Asset) – Asset being bought

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

PaymentsCallBuilder¶

class stellar_sdk.call_builder.PaymentsCallBuilder(horizon_url, client)[source]¶

Creates a new PaymentsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.payments().

See All Payments

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_account(account_id)[source]¶

This endpoint responds with a collection of Payment operations where the given account was either the sender or receiver.

See Payments for Account

Parameters: account_id (str) – Account ID
Return type: PaymentsCallBuilder
Returns: current PaymentsCallBuilder instance

for_ledger(sequence)[source]¶

This endpoint represents all payment operations that are part of a valid transactions in a given ledger.

See Payments for Ledger

Parameters: sequence (Union[int, str]) – Ledger sequence
Return type: PaymentsCallBuilder
Returns: current PaymentsCallBuilder instance

for_transaction(transaction_hash)[source]¶

This endpoint represents all payment operations that are part of a given transaction.

See Payments for Transaction

Parameters: transaction_hash (str) – Transaction hash
Return type: PaymentsCallBuilder
Returns: current PaymentsCallBuilder instance

include_failed(include_failed)[source]¶

Adds a parameter defining whether to include failed transactions. By default only payments of successful transactions are returned.

Parameters: include_failed (bool) – Set to True to include payments of failed transactions.
Return type: PaymentsCallBuilder
Returns: current PaymentsCallBuilder instance

join(join)[source]¶

join represents join param in queries, currently only supports transactions

Parameters: join (str) – join represents join param in queries, currently only supports transactions
Return type: PaymentsCallBuilder
Returns: current OperationsCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

RootCallBuilder¶

class stellar_sdk.call_builder.RootCallBuilder(horizon_url, client)[source]¶

Creates a new RootCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.root().

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

StrictReceivePathsCallBuilder¶

class stellar_sdk.call_builder.StrictReceivePathsCallBuilder(horizon_url, client, source, destination_asset, destination_amount)[source]¶

Creates a new StrictReceivePathsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.strict_receive_paths().

The Stellar Network allows payments to be made across assets through path payments. A path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A path search is specified using:

The source address or source assets.
The asset and amount that the destination account should receive.

As part of the search, horizon will load a list of assets available to the source address and will find any payment paths from those source assets to the desired destination asset. The search’s amount parameter will be used to determine if there a given path can satisfy a payment of the desired amount.

If a list of assets is passed as the source, horizon will find any payment paths from those source assets to the desired destination asset.

See Find Payment Paths

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.
source (Union[str, List[Asset]]) – The sender’s account ID or a list of Assets. Any returned path must use a source that the sender can hold.
destination_asset (Asset) – The destination asset.
destination_amount (str) – The amount, denominated in the destination asset, that any returned path should be able to satisfy.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

StrictSendPathsCallBuilder¶

class stellar_sdk.call_builder.StrictSendPathsCallBuilder(horizon_url, client, source_asset, source_amount, destination)[source]¶

Creates a new StrictSendPathsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.strict_send_paths().

The Stellar Network allows payments to be made across assets through path payments. A strict send path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A strict send path search is specified using:

The source asset
The source amount
The destination assets or destination account.

As part of the search, horizon will load a list of assets available to the source address and will find any payment paths from those source assets to the desired destination asset. The search’s source_amount parameter will be used to determine if there a given path can satisfy a payment of the desired amount.

See Find Payment Paths

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.
source_asset (Asset) – The asset to be sent.
source_amount (str) – The amount, denominated in the source asset, that any returned path should be able to satisfy.
destination (Union[str, List[Asset]]) – The destination account or the destination assets.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

TradeAggregationsCallBuilder¶

class stellar_sdk.call_builder.TradeAggregationsCallBuilder(horizon_url, client, base, counter, resolution, start_time=None, end_time=None, offset=None)[source]¶

Creates a new TradeAggregationsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.trade_aggregations().

Trade Aggregations facilitate efficient gathering of historical trade data.

See Trade Aggregations

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.
base (Asset) – base asset
counter (Asset) – counter asset
resolution (int) – segment duration as millis since epoch. Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
start_time (Optional[int]) – lower time boundary represented as millis since epoch
end_time (Optional[int]) – upper time boundary represented as millis since epoch
offset (Optional[int]) – segments can be offset using this parameter. Expressed in milliseconds. Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

TradesCallBuilder¶

class stellar_sdk.call_builder.TradesCallBuilder(horizon_url, client)[source]¶

Creates a new TradesCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.trades().

See Trades

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_account(account_id)[source]¶

Filter trades for a specific account

See Trades for Account

Parameters: account_id (str) – account id
Return type: TradesCallBuilder
Returns: current TradesCallBuilder instance

for_asset_pair(base, counter)[source]¶

Filter trades for a specific asset pair (orderbook)

Parameters

base (Asset) – base asset
counter (Asset) – counter asset

Return type

TradesCallBuilder

Returns

current TradesCallBuilder instance

for_offer(offer_id)[source]¶

Filter trades for a specific offer

See Trades for Offer

Parameters: offer_id (Union[int, str]) – offer id
Return type: TradesCallBuilder
Returns: current TradesCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

TransactionsCallBuilder¶

class stellar_sdk.call_builder.TransactionsCallBuilder(horizon_url, client)[source]¶

Creates a new TransactionsCallBuilder pointed to server defined by horizon_url. Do not create this object directly, use stellar_sdk.server.Server.transactions().

See All Transactions

Parameters

horizon_url (str) – Horizon server URL.
client (Union[BaseAsyncClient, BaseSyncClient]) – The client instance used to send request.

call()¶

Triggers a HTTP request using this builder’s current configuration.

Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: If it is called synchronous, the response will be returned. If it is called asynchronously, it will return Coroutine.
Raises: ConnectionError: if you have not successfully connected to the server.

NotFoundError: if status_code == 404

BadRequestError: if 400 <= status_code < 500 and status_code != 404

BadResponseError: if 500 <= status_code < 600

UnknownRequestError: if an unknown error occurs, please submit an issue

cursor(cursor)¶

Sets cursor parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: cursor (Union) – A cursor is a value that points to a specific location in a collection of resources.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

for_account(account_id)[source]¶

This endpoint represents all transactions that affected a given account.

See Transactions for Account

Parameters: account_id (str) – account id
Return type: TransactionsCallBuilder
Returns: current TransactionsCallBuilder instance

for_ledger(sequence)[source]¶

This endpoint represents all transactions in a given ledger.

See Transactions for Ledger

Parameters: sequence (Union[str, int]) – ledger sequence
Return type: TransactionsCallBuilder
Returns: current TransactionsCallBuilder instance

include_failed(include_failed)[source]¶

Adds a parameter defining whether to include failed transactions. By default only transactions of successful transactions are returned.

Parameters: include_failed (bool) – Set to True to include failed transactions.
Return type: TransactionsCallBuilder
Returns: current TransactionsCallBuilder instance

limit(limit)¶

Sets limit parameter for the current call. Returns the CallBuilder object on which this method has been called.

See Paging

Parameters: limit (int) – Number of records the server should return.
Return type: BaseCallBuilder
Returns

order(desc=True)¶

Sets order parameter for the current call. Returns the CallBuilder object on which this method has been called.

Parameters: desc (bool) – Sort direction, True to get desc sort direction, the default setting is True.
Return type: BaseCallBuilder
Returns: current CallBuilder instance

stream()¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Return type: Union[AsyncGenerator[Dict[str, Any], None], Generator[Dict[str, Any], None, None]]
Returns: If it is called synchronous, it will return Generator, If it is called asynchronously, it will return AsyncGenerator.
Raise: StreamClientError - Failed to fetch stream resource.

transaction(transaction_hash)[source]¶

The transaction details endpoint provides information on a single transaction. The transaction hash provided in the hash argument specifies which transaction to load.

See Transaction Details

Parameters: transaction_hash (str) – transaction hash
Return type: TransactionsCallBuilder
Returns: current TransactionsCallBuilder instance

Client¶

BaseAsyncClient¶

class stellar_sdk.client.base_async_client.BaseAsyncClient[source]¶

This is an abstract class, and if you want to implement your own asynchronous client, you must implement this class.

abstract async get(url, params=None)[source]¶

Perform HTTP GET request.

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Response

Returns

the response from server

Raise

ConnectionError

abstract async post(url, data)[source]¶

Perform HTTP POST request.

Parameters

url (str) – the request url
data (Dict[str, str]) – the data send to server

Return type

Response

Returns

the response from server

Raise

ConnectionError

abstract async stream(url, params=None)[source]¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

AsyncGenerator[Dict[str, Any], None]

Returns

a dict AsyncGenerator for server response

Raise

ConnectionError

BaseSyncClient¶

class stellar_sdk.client.base_sync_client.BaseSyncClient[source]¶

This is an abstract class, and if you want to implement your own synchronous client, you must implement this class.

abstract get(url, params=None)[source]¶

Perform HTTP GET request.

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Response

Returns

the response from server

Raise

ConnectionError

abstract post(url, data)[source]¶

Perform HTTP POST request.

Parameters

url (str) – the request url
data (Dict[str, str]) – the data send to server

Return type

Response

Returns

the response from server

Raise

ConnectionError

abstract stream(url, params=None)[source]¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Generator[Dict[str, Any], None, None]

Returns

a dict Generator for server response

Raise

ConnectionError

AiohttpClient¶

class stellar_sdk.client.aiohttp_client.AiohttpClient(pool_size=None, request_timeout=11, post_timeout=33.0, backoff_factor=0.5, user_agent=None, **kwargs)[source]¶

The AiohttpClient object is a asynchronous http client, which represents the interface for making requests to a server instance.

Parameters

pool_size (Optional[int]) – persistent connection to Horizon and connection pool
request_timeout (float) – the timeout for all GET requests
post_timeout (float) – the timeout for all POST requests
backoff_factor (Optional[float]) – a backoff factor to apply between attempts after the second try
user_agent (Optional[str]) – the server can use it to identify you

async close()[source]¶

Close underlying connector.

Release all acquired resources.

Return type: None

async get(url, params=None)[source]¶

Perform HTTP GET request.

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Response

Returns

the response from server

Raise

ConnectionError

async post(url, data=None)[source]¶

Perform HTTP POST request.

Parameters

url (str) – the request url
data (Optional[Dict[str, str]]) – the data send to server

Return type

Response

Returns

the response from server

Raise

ConnectionError

stream(url, params=None)[source]¶

Perform Stream request.

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

AsyncGenerator[Dict[str, Any], None]

Returns

the stream response from server

Raise

StreamClientError - Failed to fetch stream resource.

RequestsClient¶

class stellar_sdk.client.requests_client.RequestsClient(pool_size=10, num_retries=3, request_timeout=11, post_timeout=33.0, backoff_factor=0.5, session=None, stream_session=None)[source]¶

The RequestsClient object is a synchronous http client, which represents the interface for making requests to a server instance.

Parameters

pool_size (int) – persistent connection to Horizon and connection pool
num_retries (int) – configurable request retry functionality
request_timeout (int) – the timeout for all GET requests
post_timeout (float) – the timeout for all POST requests
backoff_factor (float) – a backoff factor to apply between attempts after the second try
session (Optional[Session]) – the request session
stream_session (Optional[Session]) – the stream request session

close()[source]¶

Close underlying connector.

Release all acquired resources.

Return type: None

get(url, params=None)[source]¶

Perform HTTP GET request.

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Response

Returns

the response from server

Raise

ConnectionError

post(url, data=None)[source]¶

Perform HTTP POST request.

Parameters

url (str) – the request url
data (Optional[Dict[str, str]]) – the data send to server

Return type

Response

Returns

the response from server

Raise

ConnectionError

stream(url, params=None)[source]¶

Creates an EventSource that listens for incoming messages from the server.

See Horizon Response Format

See MDN EventSource

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Generator[Dict[str, Any], None, None]

Returns

a Generator for server response

Raise

ConnectionError

SimpleRequestsClient¶

class stellar_sdk.client.simple_requests_client.SimpleRequestsClient[source]¶

The SimpleRequestsClient object is a synchronous http client, which represents the interface for making requests to a server instance.

This client is to guide you in writing a client that suits your needs. I don’t recommend that you actually use it.

get(url, params=None)[source]¶

Perform HTTP GET request.

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Response

Returns

the response from server

Raise

ConnectionError

post(url, data)[source]¶

Perform HTTP POST request.

Parameters

url (str) – the request url
data (Dict[str, str]) – the data send to server

Return type

Response

Returns

the response from server

Raise

ConnectionError

stream(url, params=None)[source]¶

Not Implemented

Parameters

url (str) – the request url
params (Optional[Dict[str, str]]) – the request params

Return type

Generator[Dict[str, Any], None, None]

Returns

None

Response¶

class stellar_sdk.client.response.Response(status_code, text, headers, url)[source]¶

The Response object, which contains a server’s response to an HTTP request.

Parameters

status_code (int) – response status code
text (str) – response content
headers (dict) – response headers
url (str) – request url

json()[source]¶

convert the content to dict

Return type: dict
Returns: the content from server

Exceptions¶

SdkError¶

class stellar_sdk.exceptions.SdkError[source]¶: Base exception for all stellar sdk related errors

ValueError¶

class stellar_sdk.exceptions.ValueError[source]¶: exception for all values related errors

TypeError¶

class stellar_sdk.exceptions.TypeError[source]¶: exception for all type related errors

BadSignatureError¶

class stellar_sdk.exceptions.BadSignatureError[source]¶: Raised when the signature was forged or otherwise corrupt.

Ed25519PublicKeyInvalidError¶

class stellar_sdk.exceptions.Ed25519PublicKeyInvalidError[source]¶: Ed25519 public key is incorrect.

Ed25519SecretSeedInvalidError¶

class stellar_sdk.exceptions.Ed25519SecretSeedInvalidError[source]¶: Ed25519 secret seed is incorrect.

MissingEd25519SecretSeedError¶

class stellar_sdk.exceptions.MissingEd25519SecretSeedError[source]¶: Missing Ed25519 secret seed in the keypair

MemoInvalidException¶

class stellar_sdk.exceptions.MemoInvalidException[source]¶: Memo is incorrect.

AssetCodeInvalidError¶

class stellar_sdk.exceptions.AssetCodeInvalidError[source]¶: Asset Code is incorrect.

AssetIssuerInvalidError¶

class stellar_sdk.exceptions.AssetIssuerInvalidError[source]¶: Asset issuer is incorrect.

NoApproximationError¶

class stellar_sdk.exceptions.NoApproximationError[source]¶: Approximation cannot be found

SignatureExistError¶

class stellar_sdk.exceptions.SignatureExistError[source]¶: A keypair can only sign a transaction once.

BaseRequestError¶

class stellar_sdk.exceptions.BaseRequestError[source]¶: Base class for requests errors.

ConnectionError¶

class stellar_sdk.exceptions.ConnectionError[source]¶: Base class for client connection errors.

BaseHorizonError¶

class stellar_sdk.exceptions.BaseHorizonError(response)[source]¶

Base class for horizon request errors.

Parameters: response (Response) – client response

NotFoundError¶

class stellar_sdk.exceptions.NotFoundError(response)[source]¶: This exception is thrown when the requested resource does not exist. status_code == 400

BadRequestError¶

class stellar_sdk.exceptions.BadRequestError(response)[source]¶: The request from the client has an error. 400 <= status_code < 500 and status_code != 404

BadResponseError¶

class stellar_sdk.exceptions.BadResponseError(response)[source]¶: The response from the server has an error. 500 <= status_code < 600

Keypair¶

class stellar_sdk.keypair.Keypair(verify_key, signing_key=None)[source]¶

The Keypair object, which represents a signing and verifying key for use with the Stellar network.

Instead of instantiating the class directly, we recommend using one of several class methods:

Keypair.random()
Keypair.from_secret()
Keypair.from_public_key()

Parameters

verify_key (VerifyKey) – The verifying (public) Ed25519 key in the keypair.
signing_key (Optional[SigningKey]) – The signing (private) Ed25519 key in the keypair.

can_sign()[source]¶

Returns True if this Keypair object contains secret key and can sign.

Return type: bool
Returns: True if this Keypair object contains secret key and can sign

classmethod from_mnemonic_phrase(mnemonic_phrase, language=<Language.ENGLISH: 'english'>, passphrase='', index=0)[source]¶

Generate a Keypair object via a mnemonic phrase.

Parameters

mnemonic_phrase (str) – A unique string used to deterministically generate keypairs.
language (Union[Language, str]) – The language of the mnemonic phrase, defaults to english.
passphrase (str) – An optional passphrase used as part of the salt during PBKDF2 rounds when generating the seed from the mnemonic.

index (int) –

The index of the keypair generated by the mnemonic. This allows for multiple Keypairs to be derived from the same mnemonic, such as:

>>> from stellar_sdk.keypair import Keypair
>>> mnemonic = 'update hello cry airport drive chunk elite boat shaft sea describe number'  # Don't use this mnemonic in practice.
>>> kp1 = Keypair.from_mnemonic_phrase(mnemonic, index=0)
>>> kp2 = Keypair.from_mnemonic_phrase(mnemonic, index=1)
>>> kp3 = Keypair.from_mnemonic_phrase(mnemonic, index=2)

Returns

A new Keypair instance derived from the mnemonic.

classmethod from_public_key(public_key)[source]¶

Generate a Keypair object from a public key.

Parameters: public_key (str) – strkey ed25519 public key, for example: GATPGGOIE6VWADVKD3ER3IFO2IH6DTOA5G535ITB3TT66FZFSIZEAU2B
Return type: Keypair
Returns: A new Keypair instance derived by the public key.
Raise: Ed25519PublicKeyInvalidError: if public_key is not a valid ed25519 public key.

classmethod from_raw_ed25519_public_key(raw_public_key)[source]¶

Generate a Keypair object from ed25519 public key raw bytes.

Parameters: raw_public_key (bytes) – ed25519 public key raw bytes
Return type: Keypair
Returns: A new Keypair instance derived by the ed25519 public key raw bytes

classmethod from_raw_ed25519_seed(raw_seed)[source]¶

Generate a Keypair object from ed25519 secret key seed raw bytes.

Parameters: raw_seed (bytes) – ed25519 secret key seed raw bytes
Return type: Keypair
Returns: A new Keypair instance derived by the ed25519 secret key seed raw bytes

classmethod from_secret(secret)[source]¶

Generate a Keypair object from a secret seed.

Parameters: secret (str) – strkey ed25519 seed, for example: SB2LHKBL24ITV2Y346BU46XPEL45BDAFOOJLZ6SESCJZ6V5JMP7D6G5X
Return type: Keypair
Returns: A new Keypair instance derived by the secret.
Raise: Ed25519SecretSeedInvalidError: if secret is not a valid ed25519 secret seed.

static generate_mnemonic_phrase(language=<Language.ENGLISH: 'english'>, strength=128)[source]¶

Generate a mnemonic phrase.

Parameters

language (Union[Language, str]) – The language of the mnemonic phrase, defaults to english.
strength (int) – The complexity of the mnemonic.

Returns

A mnemonic phrase.

property public_key¶

Returns public key associated with this Keypair instance

Return type: str
Returns: public key

classmethod random()[source]¶

Generate a Keypair object from a randomly generated seed.

Return type: Keypair
Returns: A new Keypair instance derived by the randomly seed.

raw_public_key()[source]¶

Returns raw public key.

Return type: bytes
Returns: raw public key

raw_secret_key()[source]¶

Returns raw secret key.

Return type: bytes
Returns: raw secret key

property secret¶

Returns secret key associated with this Keypair instance

Return type: str
Returns: secret key
Raise: MissingEd25519SecretSeedError The Keypair does not contain secret seed

sign(data)[source]¶

Sign the provided data with the keypair’s private key.

Parameters: data (bytes) – The data to sign.
Return type: bytes
Returns: signed bytes
Raise: MissingEd25519SecretSeedError: if Keypair does not contain secret seed.

sign_decorated(data)[source]¶

Sign the provided data with the keypair’s private key and returns DecoratedSignature.

Parameters: data – signed bytes
Return type: DecoratedSignature
Returns: sign decorated

signature_hint()[source]¶

Returns signature hint associated with this Keypair instance

Return type: bytes
Returns: signature hint

verify(data, signature)[source]¶

Verify the provided data and signature match this keypair’s public key.

Parameters

data (bytes) – The data that was signed.
signature (bytes) – The signature.

Raise

BadSignatureError: if the verification failed and the signature was incorrect.

Return type

None

xdr_public_key()[source]¶

Return type: PublicKey
Returns: xdr public key

Memo¶

class stellar_sdk.memo.Memo[source]¶

The Memo object, which represents the base class for memos for use with Stellar transactions.

The memo for a transaction contains optional extra information about the transaction taking place. It is the responsibility of the client to interpret this value.

See the following implementations that serve a more practical use with the library:

NoneMemo - No memo.
TextMemo - A string encoded using either ASCII or UTF-8, up to 28-bytes long.
IdMemo - A 64 bit unsigned integer.
HashMemo - A 32 byte hash.
RetHashMemo - A 32 byte hash intended to be interpreted as the hash of the transaction the sender is refunding.

See Stellar’s documentation on Transactions for more information on how memos are used within transactions, as well as information on the available types of memos.

static from_xdr_object(xdr_object)[source]¶

Returns an Memo object from XDR memo object.

Return type: Memo

abstract to_xdr_object()[source]¶

Creates an XDR Memo object that represents this Memo.

Return type: Memo

NoneMemo¶

class stellar_sdk.memo.NoneMemo[source]¶

The NoneMemo, which represents no memo for a transaction.

classmethod from_xdr_object(xdr_object)[source]¶

Returns an NoneMemo object from XDR memo object.

Return type: NoneMemo

to_xdr_object()[source]¶

Creates an XDR Memo object that represents this NoneMemo.

Return type: Memo

TextMemo¶

class stellar_sdk.memo.TextMemo(text)[source]¶

The TextMemo, which represents MEMO_TEXT in a transaction.

Parameters: text (str, bytes) – A string encoded using either ASCII or UTF-8, up to 28-bytes long.
Raises: MemoInvalidException: if text is not a valid text memo.

classmethod from_xdr_object(xdr_object)[source]¶

Returns an TextMemo object from XDR memo object.

Return type: TextMemo

to_xdr_object()[source]¶

Creates an XDR Memo object that represents this TextMemo.

Return type: Memo

IdMemo¶

class stellar_sdk.memo.IdMemo(memo_id)[source]¶

The IdMemo which represents MEMO_ID in a transaction.

Parameters: memo_id (int) – A 64 bit unsigned integer.
Raises: MemoInvalidException: if id is not a valid id memo.

classmethod from_xdr_object(xdr_object)[source]¶

Returns an IdMemo object from XDR memo object.

Return type: IdMemo

to_xdr_object()[source]¶

Creates an XDR Memo object that represents this IdMemo.

Return type: Memo

HashMemo¶

class stellar_sdk.memo.HashMemo(memo_hash)[source]¶

The HashMemo which represents MEMO_HASH in a transaction.

Parameters: memo_hash (Union[bytes, str]) – A 32 byte hash hex encoded string.
Raises: MemoInvalidException: if memo_hash is not a valid hash memo.

classmethod from_xdr_object(xdr_object)[source]¶

Returns an HashMemo object from XDR memo object.

Return type: HashMemo

to_xdr_object()[source]¶

Creates an XDR Memo object that represents this HashMemo.

Return type: Memo

ReturnHashMemo¶

class stellar_sdk.memo.ReturnHashMemo(memo_return)[source]¶

The ReturnHashMemo which represents MEMO_RETURN in a transaction.

MEMO_RETURN is typically used with refunds/returns over the network - it is a 32 byte hash intended to be interpreted as the hash of the transaction the sender is refunding.

Parameters: memo_return (Union[bytes, str]) – A 32 byte hash or hex encoded string intended to be interpreted as the hash of the transaction the sender is refunding.
Raises: MemoInvalidException: if memo_return is not a valid return hash memo.

classmethod from_xdr_object(xdr_object)[source]¶

Returns an ReturnHashMemo object from XDR memo object.

Return type: ReturnHashMemo

to_xdr_object()[source]¶

Creates an XDR Memo object that represents this ReturnHashMemo.

Return type: Memo

Network¶

class stellar_sdk.network.Network(network_passphrase)[source]¶

The Network object, which represents a Stellar network.

This class represents such a stellar network such as the Public network and the Test network.

Parameters: network_passphrase (str) – The passphrase for the network. (ex. ‘Public Global Stellar Network ; September 2015’)

PUBLIC_NETWORK_PASSPHRASE: str = 'Public Global Stellar Network ; September 2015'¶: Get the Public network passphrase.

TESTNET_NETWORK_PASSPHRASE: str = 'Test SDF Network ; September 2015'¶: Get the Test network passphrase.

network_id()[source]¶

Get the network ID of the network, which is an XDR hash of the passphrase.

Return type: bytes
Returns: The network ID of the network.

classmethod public_network()[source]¶

Get the Network object representing the PUBLIC Network.

Return type: Network
Returns: PUBLIC Network

classmethod testnet_network()[source]¶

Get the Network object representing the TESTNET Network.

Return type: Network
Returns: TESTNET Network

Operation¶

class stellar_sdk.operation.Operation(source=None)[source]¶

The Operation object, which represents an operation on Stellar’s network.

An operation is an individual command that mutates Stellar’s ledger. It is typically rolled up into a transaction (a transaction is a list of operations with additional metadata).

Operations are executed on behalf of the source account specified in the transaction, unless there is an override defined for the operation.

For more on operations, see Stellar’s documentation on operations as well as Stellar’s List of Operations, which includes information such as the security necessary for a given operation, as well as information about when validity checks occur on the network.

The Operation class is typically not used, but rather one of its subclasses is typically included in transactions.

Parameters: source (Optional[str]) – The source account for the payment. Defaults to the transaction’s source account.

static from_xdr_amount(value)[source]¶

Converts an str amount from an XDR amount object

Parameters: value (int) – The amount to convert to a string from an XDR int64 amount.
Return type: str

classmethod from_xdr_object(xdr_object)[source]¶

Create the appropriate Operation subclass from the XDR object.

Parameters: xdr_object (Operation) – The XDR object to create an Operation (or subclass) instance from.
Return type: Operation

static get_source_from_xdr_obj(xdr_object)[source]¶

Get the source account from account the operation xdr object.

Parameters: xdr_object (Operation) – the operation xdr object.
Return type: Optional[str]
Returns: The source account from account the operation xdr object.

static get_source_muxed_from_xdr_obj(xdr_object)[source]¶

Get the source account from account the operation xdr object.

Parameters: xdr_object (Operation) – the operation xdr object.
Return type: Optional[MuxedAccount]
Returns: The source account from account the operation xdr object.

static to_xdr_amount(value)[source]¶

Converts an amount to the appropriate value to send over the network as a part of an XDR object.

Each asset amount is encoded as a signed 64-bit integer in the XDR structures. An asset amount unit (that which is seen by end users) is scaled down by a factor of ten million (10,000,000) to arrive at the native 64-bit integer representation. For example, the integer amount value 25,123,456 equals 2.5123456 units of the asset. This scaling allows for seven decimal places of precision in human-friendly amount units.

This static method correctly multiplies the value by the scaling factor in order to come to the integer value used in XDR structures.

See Stellar’s documentation on Asset Precision for more information.

Parameters: value (Union[str, Decimal]) – The amount to convert to an integer for XDR serialization.
Return type: int

to_xdr_object()[source]¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

OperationType¶

AccountMerge¶

class stellar_sdk.operation.AccountMerge(destination, source=None)[source]¶

The AccountMerge object, which represents a AccountMerge operation on Stellar’s network.

Transfers the native balance (the amount of XLM an account holds) to another account and removes the source account from the ledger.

Threshold: High

Parameters

destination (str) – Destination to merge the source account into.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a AccountMerge object from an XDR Operation object.

Return type: AccountMerge

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

AllowTrust¶

class stellar_sdk.operation.AllowTrust(trustor, asset_code, authorize, source=None)[source]¶

The AllowTrust object, which represents a AllowTrust operation on Stellar’s network.

Updates the authorized flag of an existing trustline. This can only be called by the issuer of a trustline’s asset.

The issuer can only clear the authorized flag if the issuer has the AUTH_REVOCABLE_FLAG set. Otherwise, the issuer can only set the authorized flag.

Threshold: Low

Parameters

trustor (str) – The trusting account (the one being authorized).
asset_code (str) – The asset code being authorized.
authorize (Union[TrustLineEntryFlag, bool]) – True to authorize the line, False to deauthorize，if you need further control, you can also use stellar_sdk.operation.allow_trust.TrustLineEntryFlag.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a AllowTrust object from an XDR Operation object.

Return type: AllowTrust

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

class stellar_sdk.operation.allow_trust.TrustLineEntryFlag(value)[source]¶

Indicates which flags to set. For details about the flags, please refer to the CAP-0018.

UNAUTHORIZED_FLAG: The account can hold a balance but cannot receive payments, send payments, maintain offers or manage offers
AUTHORIZED_FLAG: The account can hold a balance, receive payments, send payments, maintain offers or manage offers
AUTHORIZED_TO_MAINTAIN_LIABILITIES_FLAG: The account can hold a balance and maintain offers but cannot receive payments, send payments or manage offers

BumpSequence¶

class stellar_sdk.operation.BumpSequence(bump_to, source=None)[source]¶

The BumpSequence object, which represents a BumpSequence operation on Stellar’s network.

Bump sequence allows to bump forward the sequence number of the source account of the operation, allowing to invalidate any transactions with a smaller sequence number. If the specified bumpTo sequence number is greater than the source account’s sequence number, the account’s sequence number is updated with that value, otherwise it’s not modified.

Threshold: Low

Parameters

bump_to (int) – Sequence number to bump to.
source (Optional[str]) – The optional source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a BumpSequence object from an XDR Operation object.

Return type: BumpSequence

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

ChangeTrust¶

class stellar_sdk.operation.ChangeTrust(asset, limit=None, source=None)[source]¶

The ChangeTrust object, which represents a ChangeTrust operation on Stellar’s network.

Creates, updates, or deletes a trustline. For more on trustlines, please refer to the assets documentation <https://www.stellar.org/developers/guides/concepts/assets.html>_.

Threshold: Medium

Parameters

asset (Asset) – The asset for the trust line.
limit (Union[str, Decimal, None]) – The limit for the asset, defaults to max int64(922337203685.4775807). If the limit is set to “0” it deletes the trustline.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a ChangeTrust object from an XDR Operation object.

Return type: ChangeTrust

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

CreateAccount¶

class stellar_sdk.operation.CreateAccount(destination, starting_balance, source=None)[source]¶

The CreateAccount object, which represents a Create Account operation on Stellar’s network.

This operation creates and funds a new account with the specified starting balance.

Threshold: Medium

Parameters

destination (str) – Destination account ID to create an account for.
starting_balance (Union[str, Decimal]) – Amount in XLM the account should be funded for. Must be greater than the reserve balance amount.
source (Optional[str]) – The source account for the payment. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a CreateAccount object from an XDR Operation object.

Return type: CreateAccount

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

CreatePassiveSellOffer¶

class stellar_sdk.operation.CreatePassiveSellOffer(selling, buying, amount, price, source=None)[source]¶

The CreatePassiveSellOffer object, which represents a CreatePassiveSellOffer operation on Stellar’s network.

A passive sell offer is an offer that does not act on and take a reverse offer of equal price. Instead, they only take offers of lesser price. For example, if an offer exists to buy 5 BTC for 30 XLM, and you make a passive sell offer to buy 30 XLM for 5 BTC, your passive sell offer does not take the first offer.

Note that regular offers made later than your passive sell offer can act on and take your passive sell offer, even if the regular offer is of the same price as your passive sell offer.

Passive sell offers allow market makers to have zero spread. If you want to trade EUR for USD at 1:1 price and USD for EUR also at 1:1, you can create two passive sell offers so the two offers don’t immediately act on each other.

Once the passive sell offer is created, you can manage it like any other offer using the manage offer operation - see ManageOffer for more details.

Parameters

selling (Asset) – What you’re selling.
buying (Asset) – What you’re buying.
amount (Union[str, Decimal]) – The total amount you’re selling. If 0, deletes the offer.
price (Union[Price, str, Decimal]) – Price of 1 unit of selling in terms of buying.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a CreatePassiveSellOffer object from an XDR Operation object.

Return type: CreatePassiveSellOffer

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

Inflation¶

class stellar_sdk.operation.Inflation(source=None)[source]¶

The Inflation object, which represents a Inflation operation on Stellar’s network.

This operation runs inflation.

Threshold: Low

Parameters: source (str) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a Inflation object from an XDR Operation object.

Return type: Inflation

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

ManageBuyOffer¶

class stellar_sdk.operation.ManageBuyOffer(selling, buying, amount, price, offer_id=0, source=None)[source]¶

The ManageBuyOffer object, which represents a ManageBuyOffer operation on Stellar’s network.

Creates, updates, or deletes an buy offer.

If you want to create a new offer set Offer ID to 0.

If you want to update an existing offer set Offer ID to existing offer ID.

If you want to delete an existing offer set Offer ID to existing offer ID and set Amount to 0.

Threshold: Medium

Parameters

selling (Asset) – What you’re selling.
buying (Asset) – What you’re buying.
amount (Union[str, Decimal]) – Amount being bought. if set to 0, delete the offer.
price (Union[Price, str, Decimal]) – Price of thing being bought in terms of what you are selling.
offer_id (int) – If 0, will create a new offer (default). Otherwise, edits an existing offer.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a ManageBuyOffer object from an XDR Operation object.

Return type: ManageBuyOffer

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

ManageData¶

class stellar_sdk.operation.ManageData(data_name, data_value, source=None)[source]¶

The ManageData object, which represents a ManageData operation on Stellar’s network.

Allows you to set, modify or delete a Data Entry (name/value pair) that is attached to a particular account. An account can have an arbitrary amount of DataEntries attached to it. Each DataEntry increases the minimum balance needed to be held by the account.

DataEntries can be used for application specific things. They are not used by the core Stellar protocol.

Threshold: Medium

Parameters

data_name (str) – The name of the data entry.
data_value (Union[str, bytes, None]) – The value of the data entry.
source (Optional[str]) – The optional source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a ManageData object from an XDR Operation object.

Return type: ManageData

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

ManageSellOffer¶

class stellar_sdk.operation.ManageSellOffer(selling, buying, amount, price, offer_id=0, source=None)[source]¶

The ManageSellOffer object, which represents a ManageSellOffer operation on Stellar’s network.

Creates, updates, or deletes an sell offer.

If you want to create a new offer set Offer ID to 0.

If you want to update an existing offer set Offer ID to existing offer ID.

If you want to delete an existing offer set Offer ID to existing offer ID and set Amount to 0.

Threshold: Medium

Parameters

selling (Asset) – What you’re selling.
buying (Asset) – What you’re buying.
amount (Union[str, Decimal]) – The total amount you’re selling. If 0, deletes the offer.
price (Union[Price, str, Decimal]) – Price of 1 unit of selling in terms of buying.
offer_id (int) – If 0, will create a new offer (default). Otherwise, edits an existing offer.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a ManageSellOffer object from an XDR Operation object.

Return type: ManageSellOffer

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

PathPayment¶

PathPaymentStrictReceive¶

class stellar_sdk.operation.PathPaymentStrictReceive(destination, send_asset, send_max, dest_asset, dest_amount, path, source=None)[source]¶

The PathPaymentStrictReceive object, which represents a PathPaymentStrictReceive operation on Stellar’s network.

Sends an amount in a specific asset to a destination account through a path of offers. This allows the asset sent (e.g. 450 XLM) to be different from the asset received (e.g. 6 BTC).

Threshold: Medium

Parameters

destination (str) – The destination account to send to.
send_asset (Asset) – The asset to pay with.
send_max (Union[str, Decimal]) – The maximum amount of send_asset to send.
dest_asset (Asset) – The asset the destination will receive.
dest_amount (Union[str, Decimal]) – The amount the destination receives.
path (List[Asset]) – A list of Asset objects to use as the path.
source (Optional[str]) – The source account for the payment. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a PathPaymentStrictReceive object from an XDR Operation object.

Return type: PathPaymentStrictReceive

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

PathPaymentStrictSend¶

class stellar_sdk.operation.PathPaymentStrictSend(destination, send_asset, send_amount, dest_asset, dest_min, path, source=None)[source]¶

The PathPaymentStrictSend object, which represents a PathPaymentStrictSend operation on Stellar’s network.

Sends an amount in a specific asset to a destination account through a path of offers. This allows the asset sent (e.g, 450 XLM) to be different from the asset received (e.g, 6 BTC).

Threshold: Medium

Parameters

destination (str) – The destination account to send to.
send_asset (Asset) – The asset to pay with.
send_amount (Union[str, Decimal]) – Amount of send_asset to send.
dest_asset (Asset) – The asset the destination will receive.
dest_min (Union[str, Decimal]) – The minimum amount of dest_asset to be received.
path (List[Asset]) – A list of Asset objects to use as the path.
source (Optional[str]) – The source account for the payment. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a PathPaymentStrictSend object from an XDR Operation object.

Return type: PathPaymentStrictSend

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

Payment¶

class stellar_sdk.operation.Payment(destination, asset, amount, source=None)[source]¶

The Payment object, which represents a Payment operation on Stellar’s network.

Sends an amount in a specific asset to a destination account.

Threshold: Medium

Parameters

destination (str) – The destination account ID.
asset (Asset) – The asset to send.
amount (Union[str, Decimal]) – The amount to send.
source (Optional[str]) – The source account for the payment. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a Payment object from an XDR Operation object.

Return type: Payment

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

SetOptions¶

class stellar_sdk.operation.SetOptions(inflation_dest=None, clear_flags=None, set_flags=None, master_weight=None, low_threshold=None, med_threshold=None, high_threshold=None, signer=None, home_domain=None, source=None)[source]¶

The SetOptions object, which represents a SetOptions operation on Stellar’s network.

This operation sets the options for an account.

For more information on the signing options, please refer to the multi-sig doc.

When updating signers or other thresholds, the threshold of this operation is high.

Threshold: Medium or High

Parameters

inflation_dest (Optional[str]) – Account of the inflation destination.
clear_flags (Union[int, AuthorizationFlag, None]) – Indicates which flags to clear. For details about the flags, please refer to the accounts doc. The bit mask integer subtracts from the existing flags of the account. This allows for setting specific bits without knowledge of existing flags, you can also use stellar_sdk.operation.set_options.AuthorizationFlag - AUTHORIZATION_REQUIRED = 1 - AUTHORIZATION_REVOCABLE = 2 - AUTHORIZATION_IMMUTABLE = 4 - AUTHORIZATION_CLAWBACK_ENABLED = 8
set_flags (Union[int, AuthorizationFlag, None]) –
Indicates which flags to set. For details about the flags, please refer to the accounts doc. The bit mask integer adds onto the existing flags of the account. This allows for setting specific bits without knowledge of existing flags, you can also use stellar_sdk.operation.set_options.AuthorizationFlag - AUTHORIZATION_REQUIRED = 1 - AUTHORIZATION_REVOCABLE = 2 - AUTHORIZATION_IMMUTABLE = 4 - AUTHORIZATION_CLAWBACK_ENABLED = 8
master_weight (Optional[int]) – A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled.
low_threshold (Optional[int]) – A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold.
med_threshold (Optional[int]) – A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold.
high_threshold (Optional[int]) – A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold.
home_domain (Optional[str]) – sets the home domain used for reverse federation lookup.
signer (Optional[Signer]) – Add, update, or remove a signer from the account.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a SetOptions object from an XDR Operation object.

Return type: SetOptions

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

class stellar_sdk.operation.set_options.AuthorizationFlag(value)[source]¶: Indicates which flags to set. For details about the flags, please refer to the accounts doc. The bit mask integer adds onto the existing flags of the account.

CreateClaimableBalance¶

class stellar_sdk.operation.CreateClaimableBalance(asset, amount, claimants, source=None)[source]¶

The CreateClaimableBalance object, which represents a CreateClaimableBalance operation on Stellar’s network.

Creates a ClaimableBalanceEntry. See Claimable Balance <https://developers.stellar.org/docs/glossary/claimable-balance/>_ for more information on parameters and usage.

See Create Claimable Balance <https://developers.stellar.org/docs/start/list-of-operations/#create-claimable-balance>_.

Threshold: Medium

Parameters

asset (Asset) – The asset for the claimable balance.
amount (Union[str, Decimal]) – the amount of the asset.
claimants (List[Claimant]) – A list of Claimants.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a CreateClaimableBalance object from an XDR Operation object.

Return type: CreateClaimableBalance

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

class stellar_sdk.operation.Claimant(destination, predicate=None)[source]¶

The Claimant object represents a claimable balance claimant.

Parameters

destination (str) – The destination account ID.
predicate (Optional[ClaimPredicate]) – The claim predicate. It is optional, it defaults to unconditional if none is specified.

class stellar_sdk.operation.ClaimPredicate(claim_predicate_type, and_predicates, or_predicates, not_predicate, abs_before, rel_before)[source]¶

The ClaimPredicate object, which represents a ClaimPredicate on Stellar’s network.

We do not recommend that you build it through the constructor, please use the helper function.

Parameters

claim_predicate_type (ClaimPredicateType) – Type of ClaimPredicate.
and_predicates (Optional[ClaimPredicateGroup]) – The ClaimPredicates.
or_predicates (Optional[ClaimPredicateGroup]) – The ClaimPredicates.
not_predicate (Optional[ClaimPredicate]) – The ClaimPredicate.
abs_before (Optional[int]) – Unix epoch.
rel_before (Optional[int]) – seconds since closeTime of the ledger in which the ClaimableBalanceEntry was created.

classmethod predicate_and(left, right)[source]¶

Returns an and claim predicate

Parameters

left (ClaimPredicate) – a ClaimPredicate.
right (ClaimPredicate) – a ClaimPredicate.

Return type

ClaimPredicate

Returns

an and claim predicate.

classmethod predicate_before_absolute_time(abs_before)[source]¶

Returns a before_absolute_time claim predicate.

This predicate will be fulfilled if the closing time of the ledger that includes the CreateClaimableBalance operation is less than this (absolute) Unix timestamp.

Parameters: abs_before (int) – Unix epoch.
Return type: ClaimPredicate
Returns: a before_absolute_time claim predicate.

classmethod predicate_before_relative_time(seconds)[source]¶

Returns a before_relative_time claim predicate.

This predicate will be fulfilled if the closing time of the ledger that includes the CreateClaimableBalance operation plus this relative time delta (in seconds) is less than the current time.

Parameters: seconds (int) – seconds since closeTime of the ledger in which the ClaimableBalanceEntry was created.
Return type: ClaimPredicate
Returns: a before_relative_time claim predicate.

classmethod predicate_not(predicate)[source]¶

Returns a not claim predicate.

Parameters: predicate (ClaimPredicate) – a ClaimPredicate.
Return type: ClaimPredicate
Returns: a not claim predicate.

classmethod predicate_or(left, right)[source]¶

Returns an or claim predicate

Parameters

left (ClaimPredicate) – a ClaimPredicate.
right (ClaimPredicate) – a ClaimPredicate.

Return type

ClaimPredicate

Returns

an or claim predicate.

classmethod predicate_unconditional()[source]¶

Returns an unconditional claim predicate.

Return type: ClaimPredicate
Returns: an unconditional claim predicate.

class stellar_sdk.operation.create_claimable_balance.ClaimPredicateType(value)[source]¶: Currently supported claim predicate types.

class stellar_sdk.operation.create_claimable_balance.ClaimPredicateGroup(left, right)[source]¶

Used to assemble the left and right values for and_predicates and or_predicates.

Parameters

left (ClaimPredicate) – The ClaimPredicate.
right (ClaimPredicate) – The ClaimPredicate.

ClaimClaimableBalance¶

class stellar_sdk.operation.ClaimClaimableBalance(balance_id, source=None)[source]¶

The ClaimClaimableBalance object, which represents a ClaimClaimableBalance operation on Stellar’s network.

Claims a ClaimableBalanceEntry and adds the amount of asset on the entry to the source account.

See Claim Claimable Balance Documentation <https://developers.stellar.org/docs/start/list-of-operations/#claim-claimable-balance>_.

Threshold: Low

Parameters

balance_id (str) – The claimable balance id to be claimed.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a ClaimClaimableBalance object from an XDR Operation object.

Return type: ClaimClaimableBalance

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

BeginSponsoringFutureReserves¶

class stellar_sdk.operation.BeginSponsoringFutureReserves(sponsored_id, source=None)[source]¶

The BeginSponsoringFutureReserves object, which represents a BeginSponsoringFutureReserves operation on Stellar’s network.

Establishes the is-sponsoring-future-reserves-for relationship between the source account and sponsoredID. See Sponsored Reserves <https://developers.stellar.org/docs/glossary/sponsored-reserves/>_ for more information.

See Begin Sponsoring Future Reserves <https://developers.stellar.org/docs/start/list-of-operations/#begin-sponsoring-future-reserves>_.

Threshold: Medium

Parameters

sponsored_id (str) – The sponsored account id.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a BeginSponsoringFutureReserves object from an XDR Operation object.

Return type: BeginSponsoringFutureReserves

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

EndSponsoringFutureReserves¶

class stellar_sdk.operation.EndSponsoringFutureReserves(source=None)[source]¶

The EndSponsoringFutureReserves object, which represents a EndSponsoringFutureReserves operation on Stellar’s network.

Terminates the current is-sponsoring-future-reserves-for relationship in which the source account is sponsored. See Sponsored Reserves <https://developers.stellar.org/docs/glossary/sponsored-reserves/>_ for more information.

See End Sponsoring Future Reserves <https://developers.stellar.org/docs/start/list-of-operations/#end-sponsoring-future-reserves>_.

Threshold: Medium

Parameters: source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a EndSponsoringFutureReserves object from an XDR Operation object.

Return type: EndSponsoringFutureReserves

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

RevokeSponsorship¶

class stellar_sdk.operation.RevokeSponsorship(revoke_sponsorship_type, account_id, trustline, offer, data, claimable_balance_id, signer, source=None)[source]¶

The RevokeSponsorship object, which represents a RevokeSponsorship operation on Stellar’s network.

The logic of this operation depends on the state of the source account.

If the source account is not sponsored or is sponsored by the owner of the specified entry or sub-entry, then attempt to revoke the sponsorship. If the source account is sponsored, the next step depends on whether the entry is sponsored or not. If it is sponsored, attempt to transfer the sponsorship to the sponsor of the source account. If the entry is not sponsored, then establish the sponsorship. See Sponsored Reserves <https://developers.stellar.org/docs/glossary/sponsored-reserves/>_ for more information.

See Revoke Sponsorship <https://developers.stellar.org/docs/start/list-of-operations/#revoke-sponsorship>_.

Threshold: Medium

Parameters

revoke_sponsorship_type (RevokeSponsorshipType) – The sponsored account id.
account_id (Optional[str]) – The sponsored account ID.
trustline (Optional[TrustLine]) – The sponsored trustline.
offer (Optional[Offer]) – The sponsored offer.
data (Optional[Data]) – The sponsored data.
claimable_balance_id (Optional[str]) – The sponsored claimable balance.
signer (Optional[Signer]) – The sponsored signer.
source (Optional[str]) – The source account (defaults to transaction source).

classmethod from_xdr_object(xdr_object)[source]¶

Creates a RevokeSponsorship object from an XDR Operation object.

Return type: RevokeSponsorship

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

class stellar_sdk.operation.revoke_sponsorship.RevokeSponsorshipType(value)[source]¶: Currently supported RevokeSponsorship types.

class stellar_sdk.operation.revoke_sponsorship.TrustLine(account_id, asset)[source]¶

class stellar_sdk.operation.revoke_sponsorship.Offer(seller_id, offer_id)[source]¶

class stellar_sdk.operation.revoke_sponsorship.Data(account_id, data_name)[source]¶

class stellar_sdk.operation.revoke_sponsorship.Signer(account_id, signer_key)[source]¶

Clawback¶

class stellar_sdk.operation.Clawback(asset, from_, amount, source=None)[source]¶

The Clawback object, which represents a Clawback operation on Stellar’s network.

Claws back an amount of an asset from an account.

Threshold: Medium

Parameters

asset (Asset) – The asset being clawed back.
from – The public key of the account to claw back from.
amount (Union[str, Decimal]) – The amount of the asset to claw back.
source (Optional[str]) – The source account for the operation. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a Clawback object from an XDR Operation object.

Return type: Clawback

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

ClawbackClaimableBalance¶

class stellar_sdk.operation.ClawbackClaimableBalance(balance_id, source=None)[source]¶

The ClawbackClaimableBalance object, which represents a ClawbackClaimableBalance operation on Stellar’s network.

Claws back a claimable balance

Threshold: Medium

Parameters

balance_id (str) – The claimable balance ID to be clawed back.
source (Optional[str]) – The source account for the operation. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a ClawbackClaimableBalance object from an XDR Operation object.

Return type: ClawbackClaimableBalance

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

SetTrustLineFlags¶

class stellar_sdk.operation.SetTrustLineFlags(trustor, asset, clear_flags=None, set_flags=None, source=None)[source]¶

The SetTrustLineFlags object, which represents a SetTrustLineFlags operation on Stellar’s network.

Updates the flags of an existing trust line. This is called by the issuer of the related asset.

Threshold: Low

Parameters

trustor (str) – The account whose trustline this is.
asset (Asset) – The asset on the trustline.
clear_flags (Optional[TrustLineFlags]) – The flags to clear.
set_flags (Optional[TrustLineFlags]) – The flags to set.
source (Optional[str]) – The source account for the operation. Defaults to the transaction’s source account.

classmethod from_xdr_object(xdr_object)[source]¶

Creates a SetTrustLineFlags object from an XDR Operation object.

Return type: SetTrustLineFlags

to_xdr_object()¶

Creates an XDR Operation object that represents this Operation.

Return type: Operation

class stellar_sdk.operation.set_trust_line_flags.TrustLineFlags(value)[source]¶

Indicates which flags to set. For details about the flags, please refer to the CAP-0035.

AUTHORIZED_FLAG: issuer has authorized account to perform transactions with its credit
AUTHORIZED_TO_MAINTAIN_LIABILITIES_FLAG: issuer has authorized account to maintain and reduce liabilities for its credit
TRUSTLINE_CLAWBACK_ENABLED_FLAG: issuer has specified that it may clawback its credit, and that claimable balances created with its credit may also be clawed back

Price¶

class stellar_sdk.price.Price(n, d)[source]¶

Create a new price. Price in Stellar is represented as a fraction.

Parameters

n (int) – numerator
d (int) – denominator

classmethod from_raw_price(price)[source]¶

Create a Price from the given str price.

Parameters: price (Union[str, Decimal]) – the str price. (ex. ‘0.125’)
Return type: Price
Returns: A new Price object from the given str price.
Raises: NoApproximationError: if the approximation could not not be found.

classmethod from_xdr_object(xdr_object)[source]¶

Create a Price from an XDR Asset object.

Parameters: xdr_object (Price) – The XDR Price object.
Return type: Price
Returns: A new Price object from the given XDR Price object.

to_xdr_object()[source]¶

Returns the xdr object for this price object.

Return type: Price
Returns: XDR Price object

Server¶

class stellar_sdk.server.Server(horizon_url='https://horizon-testnet.stellar.org/', client=None)[source]¶

Server handles the network connection to a Horizon instance and exposes an interface for requests to that instance.

Here we need to talk about the client parameter, if you do not specify the client, we will use the stellar_sdk.client.requests_client.RequestsClient instance by default, it is a synchronous HTTPClient, you can also specify an asynchronous HTTP Client, for example: stellar_sdk.client.aiohttp_client.AiohttpClient. If you use a synchronous client, then all requests are synchronous. If you use an asynchronous client, then all requests are asynchronous. The choice is in your hands.

Parameters

horizon_url (str) – Horizon Server URL (ex. https://horizon-testnet.stellar.org)
client (Union[BaseAsyncClient, BaseSyncClient, None]) – Http Client used to send the request

Raises

TypeError: if the client does not meet the standard.

accounts()[source]¶

Return type: AccountsCallBuilder
Returns: New stellar_sdk.call_builder.AccountsCallBuilder object configured by a current Horizon server configuration.

assets()[source]¶

Return type: AssetsCallBuilder
Returns: New stellar_sdk.call_builder.AssetsCallBuilder object configured by a current Horizon server configuration.

claimable_balances()[source]¶

Return type: ClaimableBalancesCallBuilder
Returns: New stellar_sdk.call_builder.ClaimableBalancesCallBuilder object configured by a current Horizon server configuration.

close()[source]¶

Close underlying connector.

Release all acquired resources.

Return type: Optional[Coroutine[Any, Any, None]]

data(account_id, data_name)[source]¶

Returns: New stellar_sdk.call_builder.DataCallBuilder object configured by a current Horizon server configuration.

effects()[source]¶

Return type: EffectsCallBuilder
Returns: New stellar_sdk.call_builder.EffectsCallBuilder object configured by a current Horizon server configuration.

fee_stats()[source]¶

Return type: FeeStatsCallBuilder
Returns: New stellar_sdk.call_builder.FeeStatsCallBuilder object configured by a current Horizon server configuration.

fetch_base_fee()[source]¶

Fetch the base fee. Since this hits the server, if the server call fails, you might get an error. You should be prepared to use a default value if that happens.

Return type: Union[int, Coroutine[Any, Any, int]]
Returns: the base fee
Raises: ConnectionError NotFoundError BadRequestError BadResponseError UnknownRequestError

ledgers()[source]¶

Return type: LedgersCallBuilder
Returns: New stellar_sdk.call_builder.LedgersCallBuilder object configured by a current Horizon server configuration.

load_account(account_id)[source]¶

Fetches an account’s most current base state (like sequence) in the ledger and then creates and returns an stellar_sdk.account.Account object.

If you want to get complete account information, please use stellar_sdk.server.Server.accounts().

Parameters: account_id (Union[Keypair, str]) – The account to load.
Return type: Union[Account, Coroutine[Any, Any, Account]]
Returns: an stellar_sdk.account.Account object.
Raises: ConnectionError NotFoundError BadRequestError BadResponseError UnknownRequestError

offers()[source]¶

Return type: OffersCallBuilder
Returns: New stellar_sdk.call_builder.OffersCallBuilder object configured by a current Horizon server configuration.

operations()[source]¶

Return type: OperationsCallBuilder
Returns: New stellar_sdk.call_builder.OperationsCallBuilder object configured by a current Horizon server configuration.

orderbook(selling, buying)[source]¶

Parameters

selling (Asset) – Asset being sold
buying (Asset) – Asset being bought

Return type

OrderbookCallBuilder

Returns

New stellar_sdk.call_builder.OrderbookCallBuilder object configured by a current Horizon server configuration.

payments()[source]¶

Return type: PaymentsCallBuilder
Returns: New stellar_sdk.call_builder.PaymentsCallBuilder object configured by a current Horizon server configuration.

root()[source]¶

Return type: RootCallBuilder
Returns: New stellar_sdk.call_builder.RootCallBuilder object configured by a current Horizon server configuration.

strict_receive_paths(source, destination_asset, destination_amount)[source]¶

Parameters

source (Union[str, List[Asset]]) – The sender’s account ID or a list of Assets. Any returned path must use a source that the sender can hold.
destination_asset (Asset) – The destination asset.
destination_amount (str) – The amount, denominated in the destination asset, that any returned path should be able to satisfy.

Returns

New stellar_sdk.call_builder.StrictReceivePathsCallBuilder object configured by a current Horizon server configuration.

strict_send_paths(source_asset, source_amount, destination)[source]¶

Parameters

source_asset (Asset) – The asset to be sent.
source_amount (str) – The amount, denominated in the source asset, that any returned path should be able to satisfy.
destination (Union[str, List[Asset]]) – The destination account or the destination assets.

Returns

New stellar_sdk.call_builder.StrictReceivePathsCallBuilder object configured by a current Horizon server configuration.

submit_transaction(transaction_envelope, skip_memo_required_check=False)[source]¶

Submits a transaction to the network.

Parameters: transaction_envelope (Union[TransactionEnvelope, FeeBumpTransactionEnvelope, str]) – stellar_sdk.transaction_envelope.TransactionEnvelope object or base64 encoded xdr
Return type: Union[Dict[str, Any], Coroutine[Any, Any, Dict[str, Any]]]
Returns: the response from horizon
Raises: ConnectionError NotFoundError BadRequestError BadResponseError UnknownRequestError AccountRequiresMemoError

trade_aggregations(base, counter, resolution, start_time=None, end_time=None, offset=None)[source]¶

Parameters

base (Asset) – base asset
counter (Asset) – counter asset
resolution (int) – segment duration as millis since epoch. Supported values are 1 minute (60000), 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).
start_time (Optional[int]) – lower time boundary represented as millis since epoch
end_time (Optional[int]) – upper time boundary represented as millis since epoch
offset (Optional[int]) – segments can be offset using this parameter. Expressed in milliseconds. Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours.

Return type

TradeAggregationsCallBuilder

Returns

New stellar_sdk.call_builder.TradeAggregationsCallBuilder object configured by a current Horizon server configuration.

trades()[source]¶

Return type: TradesCallBuilder
Returns: New stellar_sdk.call_builder.TradesCallBuilder object configured by a current Horizon server configuration.

transactions()[source]¶

Return type: TransactionsCallBuilder
Returns: New stellar_sdk.call_builder.TransactionsCallBuilder object configured by a current Horizon server configuration.

Signer¶

class stellar_sdk.signer.Signer(signer_key, weight)[source]¶

The Signer object, which represents an account signer on Stellar’s network.

Parameters

signer_key (SignerKey) – The signer object
weight – The weight of the key

classmethod ed25519_public_key(account_id, weight)[source]¶

Create ED25519 PUBLIC KEY Signer from account id.

Parameters

account_id (str) – account id
weight (int) – The weight of the signer (0 to delete or 1-255)

Return type

Signer

Returns

ED25519 PUBLIC KEY Signer

Raises

Ed25519PublicKeyInvalidError: if account_id is not a valid ed25519 public key.

classmethod from_xdr_object(xdr_object)[source]¶

Create a Signer from an XDR Signer object.

Parameters: xdr_object (Signer) – The XDR Signer object.
Return type: Signer
Returns: A new Signer object from the given XDR Signer object.

classmethod pre_auth_tx(pre_auth_tx_hash, weight)[source]¶

Create Pre AUTH TX Signer from the sha256 hash of a transaction, click here for more information.

Parameters

pre_auth_tx_hash (bytes) – The sha256 hash of a transaction.
weight (int) – The weight of the signer (0 to delete or 1-255)

Return type

Signer

Returns

Pre AUTH TX Signer

classmethod sha256_hash(sha256_hash, weight)[source]¶

Create SHA256 HASH Signer from a sha256 hash of a preimage, click here for more information.

Parameters

sha256_hash (bytes) – a sha256 hash of a preimage
weight (int) – The weight of the signer (0 to delete or 1-255)

Return type

Signer

Returns

SHA256 HASH Signer

to_xdr_object()[source]¶

Returns the xdr object for this Signer object.

Return type: Signer
Returns: XDR Signer object

SignerKey¶

class stellar_sdk.signer_key.SignerKey(signer_key)[source]¶

The SignerKey object, which represents an account signer key on Stellar’s network.

Parameters: signer_key (SignerKey) – The XDR signer object

classmethod ed25519_public_key(account_id)[source]¶

Create ED25519 PUBLIC KEY Signer from account id.

Parameters: account_id (str) – account id
Return type: SignerKey
Returns: ED25519 PUBLIC KEY Signer
Raises: Ed25519PublicKeyInvalidError: if account_id is not a valid ed25519 public key.

classmethod from_xdr_object(xdr_object)[source]¶

Create a SignerKey from an XDR SignerKey object.

Parameters: xdr_object (SignerKey) – The XDR SignerKey object.
Return type: SignerKey
Returns: A new SignerKey object from the given XDR SignerKey object.

classmethod pre_auth_tx(pre_auth_tx_hash)[source]¶

Create Pre AUTH TX Signer from the sha256 hash of a transaction, click here for more information.

Parameters: pre_auth_tx_hash (bytes) – The sha256 hash of a transaction.
Return type: SignerKey
Returns: Pre AUTH TX Signer

classmethod sha256_hash(sha256_hash)[source]¶

Create SHA256 HASH Signer from a sha256 hash of a preimage, click here for more information.

Parameters: sha256_hash (bytes) – a sha256 hash of a preimage
Return type: SignerKey
Returns: SHA256 HASH Signer

to_xdr_object()[source]¶

Returns the xdr object for this SignerKey object.

Return type: SignerKey
Returns: XDR Signer object

TimeBounds¶

class stellar_sdk.time_bounds.TimeBounds(min_time, max_time)[source]¶

TimeBounds represents the time interval that a transaction is valid.

The UNIX timestamp (in seconds), determined by ledger time, of a lower and upper bound of when this transaction will be valid. If a transaction is submitted too early or too late, it will fail to make it into the transaction set. max_time equal 0 means that it’s not set.

See Stellar’s documentation on Transactions for more information on how TimeBounds are used within transactions.

Parameters

min_time (int) – the UNIX timestamp (in seconds)
max_time (int) – the UNIX timestamp (in seconds)

Raises

ValueError: if max_time less than min_time.

classmethod from_xdr_object(xdr_object)[source]¶

Create a TimeBounds from an XDR TimeBounds object.

Parameters: xdr_object (TimeBounds) – The XDR TimeBounds object.
Return type: TimeBounds
Returns: A new TimeBounds object from the given XDR TimeBounds object.

to_xdr_object()[source]¶

Returns the xdr object for this TimeBounds object.

Return type: TimeBounds
Returns: XDR TimeBounds object

Transaction¶

class stellar_sdk.transaction.Transaction(source, sequence, fee, operations, memo=None, time_bounds=None, v1=True)[source]¶

The Transaction object, which represents a transaction(Transaction or TransactionV0) on Stellar’s network.

A transaction contains a list of operations, which are all executed in order as one ACID transaction, along with an associated source account, fee, account sequence number, list of signatures, both an optional memo and an optional TimeBounds. Typically a Transaction is placed in a TransactionEnvelope which is then signed before being sent over the network.

For more information on Transactions in Stellar, see Stellar’s guide on transactions.

Parameters

source (Union[Keypair, str]) – the source account for the transaction.
sequence (int) – The sequence number for the transaction.
fee (int) – The fee amount for the transaction, which should equal FEE (currently 100 stroops) multiplied by the number of operations in the transaction. See Stellar’s latest documentation on fees for more information.
operations (List[Operation]) – A list of operations objects (typically its subclasses as defined in stellar_sdk.operation.Operation.
time_bounds (Optional[TimeBounds]) – The timebounds for the validity of this transaction.
memo (Optional[Memo]) – The memo being sent with the transaction, being represented as one of the subclasses of the Memo object.
v1 (bool) – When this value is set to True, V1 transactions will be generated, otherwise V0 transactions will be generated. See CAP-0015 for more information.

classmethod from_xdr(xdr, v1=False)[source]¶

Create a new Transaction from an XDR string.

Parameters

xdr (str) – The XDR string that represents a transaction.
v1 (bool) –
Temporary feature flag to allow alpha testing of Stellar Protocol 13 transactions. We will remove this once all transactions are supposed to be v1. See CAP-0015 for more information.

Return type

Transaction

Returns

A new Transaction object from the given XDR Transaction base64 string object.

classmethod from_xdr_object(xdr_object, v1=False)[source]¶

Create a new Transaction from an XDR object.

Parameters

xdr_object (Union[Transaction, TransactionV0]) – The XDR object that represents a transaction.
v1 (bool) –
Temporary feature flag to allow alpha testing of Stellar Protocol 13 transactions. We will remove this once all transactions are supposed to be v1. See CAP-0015 for more information.

Return type

Transaction

Returns

A new Transaction object from the given XDR Transaction object.

to_xdr_object()[source]¶

Get an XDR object representation of this Transaction.

Return type: Union[Transaction, TransactionV0]
Returns: XDR Transaction object

TransactionEnvelope¶

class stellar_sdk.transaction_envelope.TransactionEnvelope(transaction, network_passphrase, signatures=None)[source]¶

The TransactionEnvelope object, which represents a transaction envelope ready to sign and submit to send over the network.

When a transaction is ready to be prepared for sending over the network, it must be put into a TransactionEnvelope, which includes additional metadata such as the signers for a given transaction. Ultimately, this class handles signing and conversion to and from XDR for usage on Stellar’s network.

Parameters

transaction (Transaction) – The transaction that is encapsulated in this envelope.
signatures (list) – which contains a list of signatures that have already been created.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

classmethod from_xdr(xdr, network_passphrase)¶

Create a new BaseTransactionEnvelope from an XDR string.

Parameters

xdr (str) – The XDR string that represents a transaction envelope.
network_passphrase (str) – which network this transaction envelope is associated with.

Return type

~T

Returns

A new BaseTransactionEnvelope object from the given XDR TransactionEnvelope base64 string object.

classmethod from_xdr_object(xdr_object, network_passphrase)[source]¶

Create a new TransactionEnvelope from an XDR object.

Parameters

xdr_object (TransactionEnvelope) – The XDR object that represents a transaction envelope.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

Return type

TransactionEnvelope

Returns

A new TransactionEnvelope object from the given XDR TransactionEnvelope object.

hash()¶

Get the XDR Hash of the signature base.

This hash is ultimately what is signed before transactions are sent over the network. See signature_base() for more details about this process.

Return type: bytes
Returns: The XDR Hash of this transaction envelope’s signature base.

hash_hex()¶

Return a hex encoded hash for this transaction envelope.

Return type: str
Returns: A hex encoded hash for this transaction envelope.

sign(signer)¶

Sign this transaction envelope with a given keypair.

Note that the signature must not already be in this instance’s list of signatures.

Parameters: signer (Union[Keypair, str]) – The keypair or secret to use for signing this transaction envelope.
Raise: SignatureExistError: if this signature already exists.
Return type: None

sign_hashx(preimage)¶

Sign this transaction envelope with a Hash(x) signature.

See Stellar’s documentation on Multi-Sig for more details on Hash(x) signatures.

Parameters: preimage (Union[bytes, str]) – Preimage of hash used as signer, byte hash or hex encoded string
Return type: None

signature_base()[source]¶

Get the signature base of this transaction envelope.

Return the “signature base” of this transaction, which is the value that, when hashed, should be signed to create a signature that validators on the Stellar Network will accept.

It is composed of a 4 prefix bytes followed by the xdr-encoded form of this transaction.

Return type: bytes
Returns: The signature base of this transaction envelope.

to_transaction_envelope_v1()[source]¶

Create a new TransactionEnvelope, if the internal tx is not v1, we will convert it to v1.

Return type: TransactionEnvelope

to_xdr()¶

Get the base64 encoded XDR string representing this BaseTransactionEnvelope.

Return type: str
Returns: XDR TransactionEnvelope base64 string object

to_xdr_object()[source]¶

Get an XDR object representation of this TransactionEnvelope.

Return type: TransactionEnvelope
Returns: XDR TransactionEnvelope object

FeeBumpTransaction¶

class stellar_sdk.fee_bump_transaction.FeeBumpTransaction(fee_source, base_fee, inner_transaction_envelope)[source]¶

The FeeBumpTransaction object, which represents a fee bump transaction on Stellar’s network.

See CAP-0015 for more information.

Parameters

fee_source (Union[Keypair, str]) – The account paying for the transaction.
base_fee (int) – The max fee willing to pay per operation in inner transaction (in stroops).
inner_transaction_envelope (TransactionEnvelope) – The TransactionEnvelope to be bumped by the fee bump transaction.

classmethod from_xdr(xdr, network_passphrase)[source]¶

Create a new FeeBumpTransaction from an XDR string.

Parameters

xdr (str) – The XDR string that represents a transaction.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

Return type

FeeBumpTransaction

Returns

A new FeeBumpTransaction object from the given XDR FeeBumpTransaction base64 string object.

classmethod from_xdr_object(xdr_object, network_passphrase)[source]¶

Create a new FeeBumpTransaction from an XDR object.

Parameters

xdr_object (FeeBumpTransaction) – The XDR object that represents a fee bump transaction.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

Return type

FeeBumpTransaction

Returns

A new FeeBumpTransaction object from the given XDR Transaction object.

to_xdr_object()[source]¶

Get an XDR object representation of this FeeBumpTransaction.

Return type: FeeBumpTransaction
Returns: XDR Transaction object

FeeBumpTransactionEnvelope¶

class stellar_sdk.fee_bump_transaction_envelope.FeeBumpTransactionEnvelope(transaction, network_passphrase, signatures=None)[source]¶

The FeeBumpTransactionEnvelope object, which represents a transaction envelope ready to sign and submit to send over the network.

When a transaction is ready to be prepared for sending over the network, it must be put into a FeeBumpTransactionEnvelope, which includes additional metadata such as the signers for a given transaction. Ultimately, this class handles signing and conversion to and from XDR for usage on Stellar’s network.

Parameters

transaction (FeeBumpTransaction) – The fee bump transaction that is encapsulated in this envelope.
signatures (list) – which contains a list of signatures that have already been created.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

classmethod from_xdr(xdr, network_passphrase)¶

Create a new BaseTransactionEnvelope from an XDR string.

Parameters

xdr (str) – The XDR string that represents a transaction envelope.
network_passphrase (str) – which network this transaction envelope is associated with.

Return type

~T

Returns

A new BaseTransactionEnvelope object from the given XDR TransactionEnvelope base64 string object.

classmethod from_xdr_object(xdr_object, network_passphrase)[source]¶

Create a new FeeBumpTransactionEnvelope from an XDR object.

Parameters

xdr_object (TransactionEnvelope) – The XDR object that represents a fee bump transaction envelope.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

Return type

FeeBumpTransactionEnvelope

Returns

A new FeeBumpTransactionEnvelope object from the given XDR TransactionEnvelope object.

hash()¶

Get the XDR Hash of the signature base.

This hash is ultimately what is signed before transactions are sent over the network. See signature_base() for more details about this process.

Return type: bytes
Returns: The XDR Hash of this transaction envelope’s signature base.

hash_hex()¶

Return a hex encoded hash for this transaction envelope.

Return type: str
Returns: A hex encoded hash for this transaction envelope.

sign(signer)¶

Sign this transaction envelope with a given keypair.

Note that the signature must not already be in this instance’s list of signatures.

Parameters: signer (Union[Keypair, str]) – The keypair or secret to use for signing this transaction envelope.
Raise: SignatureExistError: if this signature already exists.
Return type: None

sign_hashx(preimage)¶

Sign this transaction envelope with a Hash(x) signature.

See Stellar’s documentation on Multi-Sig for more details on Hash(x) signatures.

Parameters: preimage (Union[bytes, str]) – Preimage of hash used as signer, byte hash or hex encoded string
Return type: None

signature_base()[source]¶

Get the signature base of this transaction envelope.

Return the “signature base” of this transaction, which is the value that, when hashed, should be signed to create a signature that validators on the Stellar Network will accept.

It is composed of a 4 prefix bytes followed by the xdr-encoded form of this transaction.

Return type: bytes
Returns: The signature base of this transaction envelope.

to_xdr()¶

Get the base64 encoded XDR string representing this BaseTransactionEnvelope.

Return type: str
Returns: XDR TransactionEnvelope base64 string object

to_xdr_object()[source]¶

Get an XDR object representation of this TransactionEnvelope.

Return type: TransactionEnvelope
Returns: XDR TransactionEnvelope object

TransactionBuilder¶

class stellar_sdk.transaction_builder.TransactionBuilder(source_account, network_passphrase='Test SDF Network ; September 2015', base_fee=100, v1=True)[source]¶

Transaction builder helps constructs a new TransactionEnvelope using the given Account as the transaction’s “source account”. The transaction will use the current sequence number of the given account as its sequence number and increment the given account’s sequence number by one. The given source account must include a private key for signing the transaction or an error will be thrown.

Be careful about unsubmitted transactions! When you build a transaction, stellar-sdk automatically increments the source account’s sequence number. If you end up not submitting this transaction and submitting another one instead, it’ll fail due to the sequence number being wrong. So if you decide not to use a built transaction, make sure to update the source account’s sequence number with stellar_sdk.Server.load_account() before creating another transaction.

Parameters

source_account (Account) – The source account for this transaction.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from. Defaults to Test SDF Network ; September 2015.
base_fee (int) – Base fee in stroops. The network base fee is obtained by default from the latest ledger. Transaction fee is equal to base fee times number of operations in this transaction.
v1 (bool) –
When this value is set to True, V1 transactions will be generated, otherwise V0 transactions will be generated. See CAP-0015 for more information.

add_hash_memo(memo_hash)[source]¶

Set the memo for the transaction to a new HashMemo.

Parameters: memo_hash (Union[bytes, str]) – A 32 byte hash or hex encoded string to use as the memo.
Return type: TransactionBuilder
Returns: This builder instance.
Raises: MemoInvalidException: if memo_hash is not a valid hash memo.

add_id_memo(memo_id)[source]¶

Set the memo for the transaction to a new IdMemo.

Parameters: memo_id (int) – A 64 bit unsigned integer to set as the memo.
Return type: TransactionBuilder
Returns: This builder instance.
Raises: MemoInvalidException: if memo_id is not a valid id memo.

add_memo(memo)[source]¶

Set the memo for the transaction build by this Builder.

Parameters: memo (Memo) – A memo to add to this transaction.
Return type: TransactionBuilder
Returns: This builder instance.

add_return_hash_memo(memo_return)[source]¶

Set the memo for the transaction to a new RetHashMemo.

Parameters: memo_return (Union[bytes, str]) – A 32 byte hash or hex encoded string intended to be interpreted as the hash of the transaction the sender is refunding.
Return type: TransactionBuilder
Returns: This builder instance.
Raises: MemoInvalidException: if memo_return is not a valid return hash memo.

add_text_memo(memo_text)[source]¶

Set the memo for the transaction to a new TextMemo.

Parameters: memo_text (Union[str, bytes]) – The text for the memo to add.
Return type: TransactionBuilder
Returns: This builder instance.
Raises: MemoInvalidException: if memo_text is not a valid text memo.

add_time_bounds(min_time, max_time)[source]¶

Add a time bound to this transaction.

Add a UNIX timestamp, determined by ledger time, of a lower and upper bound of when this transaction will be valid. If a transaction is submitted too early or too late, it will fail to make it into the transaction set. maxTime equal 0 means that it’s not set.

Parameters

min_time (int) – the UNIX timestamp (in seconds)
max_time (int) – the UNIX timestamp (in seconds)

Return type

TransactionBuilder

Returns

This builder instance.

append_account_merge_op(destination, source=None)[source]¶

Append a AccountMerge operation to the list of operations.

Parameters

destination (str) – The ID of the offer. 0 for new offer. Set to existing offer ID to update or delete.
source (Optional[str]) – The source address that is being merged into the destination account.

Return type

TransactionBuilder

Returns

This builder instance.

append_allow_trust_op(trustor, asset_code, authorize, source=None)[source]¶

Append an AllowTrust operation to the list of operations.

Parameters

trustor (str) – The account of the recipient of the trustline.
asset_code (str) – The asset of the trustline the source account is authorizing. For example, if an anchor wants to allow another account to hold its USD credit, the type is USD:anchor.
authorize (Union[TrustLineEntryFlag, bool]) – True to authorize the line, False to deauthorize，if you need further control, you can also use stellar_sdk.operation.allow_trust.TrustLineEntryFlag.
source (Optional[str]) – The source address that is establishing the trust in the allow trust operation.

Return type

TransactionBuilder

Returns

This builder instance.

append_begin_sponsoring_future_reserves_op(sponsored_id, source=None)[source]¶

Append a BeginSponsoringFutureReserves operation to the list of operations.

Parameters

sponsored_id (str) – The sponsored account id.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_bump_sequence_op(bump_to, source=None)[source]¶

Append a BumpSequence operation to the list of operations.

Parameters

bump_to (int) – Sequence number to bump to.
source (Optional[str]) – The source address that is running the inflation operation.

Return type

TransactionBuilder

Returns

This builder instance.

append_change_trust_op(asset_code, asset_issuer, limit=None, source=None)[source]¶

Append a ChangeTrust operation to the list of operations.

Parameters

asset_issuer (str) – The issuer address for the asset.
asset_code (str) – The asset code for the asset.
limit (Union[str, Decimal, None]) – The limit of the new trustline.
source (Optional[str]) – The source address to add the trustline to.

Return type

TransactionBuilder

Returns

This builder instance.

append_claim_claimable_balance_op(balance_id, source=None)[source]¶

Append a ClaimClaimableBalance operation to the list of operations.

Parameters

balance_id (str) – The claimable balance id to be claimed.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

append_clawback_claimable_balance_op(balance_id, source=None)[source]¶

Append an ClawbackClaimableBalance operation to the list of operations.

Parameters

balance_id (str) – The claimable balance ID to be clawed back.
source (Optional[str]) – The source account for the operation. Defaults to the transaction’s source account.

Returns

This builder instance.

append_clawback_op(asset, from_, amount, source=None)[source]¶

Append an Clawback operation to the list of operations.

Parameters

asset (Asset) – The asset being clawed back.
from – The public key of the account to claw back from.
amount (Union[str, Decimal]) – The amount of the asset to claw back.
source (Optional[str]) – The source account for the operation. Defaults to the transaction’s source account.

append_create_account_op(destination, starting_balance, source=None)[source]¶

Append a CreateAccount operation to the list of operations.

Parameters

destination (str) – Account address that is created and funded.
starting_balance (Union[str, Decimal]) – Amount of XLM to send to the newly created account. This XLM comes from the source account.
source (Optional[str]) – The source address to deduct funds from to fund the new account.

Return type

TransactionBuilder

Returns

This builder instance.

append_create_claimable_balance_op(asset, amount, claimants, source=None)[source]¶

Append a CreateClaimableBalance operation to the list of operations.

Parameters

asset (Asset) – The asset for the claimable balance.
amount (Union[str, Decimal]) – the amount of the asset.
claimants (List[Claimant]) – A list of Claimants.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

append_create_passive_sell_offer_op(selling_code, selling_issuer, buying_code, buying_issuer, amount, price, source=None)[source]¶

Append a CreatePassiveSellOffer operation to the list of operations.

Parameters

selling_code (str) – The asset code for the asset the offer creator is selling.
selling_issuer (Optional[str]) – The issuing address for the asset the offer creator is selling.
buying_code (str) – The asset code for the asset the offer creator is buying.
buying_issuer (Optional[str]) – The issuing address for the asset the offer creator is buying.
amount (Union[str, Decimal]) – Amount of the asset being sold. Set to 0 if you want to delete an existing offer.
price (Union[str, Price, Decimal]) – Price of 1 unit of selling in terms of buying.
source (Optional[str]) – The source address that is creating a passive offer on Stellar’s distributed exchange.

Return type

TransactionBuilder

Returns

This builder instance.

append_ed25519_public_key_signer(account_id, weight, source=None)[source]¶

Add a ed25519 public key signer to an account.

Add a ed25519 public key signer to an account via a SetOptions <stellar_sdk.operation.SetOptions operation. This is a helper function for append_set_options_op().

Parameters

account_id (str) – The account id of the new ed25519_public_key signer.
weight (int) – The weight of the new signer.
source (Optional[str]) – The source account that is adding a signer to its list of signers.

Return type

TransactionBuilder

Returns

This builder instance.

append_end_sponsoring_future_reserves_op(source=None)[source]¶

Append a EndSponsoringFutureReserves operation to the list of operations.

Parameters: source (Optional[str]) – The source account (defaults to transaction source).
Return type: TransactionBuilder
Returns: This builder instance.

append_hashx_signer(sha256_hash, weight, source=None)[source]¶

Add a sha256 hash(HashX) signer to an account.

Add a HashX signer to an account via a SetOptions <stellar_sdk.operation.SetOptions operation. This is a helper function for append_set_options_op().

Parameters

sha256_hash (Union[bytes, str]) – The address of the new sha256 hash(hashX) signer, a 32 byte hash or hex encoded string.
weight (int) – The weight of the new signer.
source (Optional[str]) – The source account that is adding a signer to its list of signers.

Return type

TransactionBuilder

Returns

This builder instance.

append_inflation_op(source=None)[source]¶

Append a Inflation operation to the list of operations.

Parameters: source (Optional[str]) – The source address that is running the inflation operation.
Return type: TransactionBuilder
Returns: This builder instance.

append_manage_buy_offer_op(selling_code, selling_issuer, buying_code, buying_issuer, amount, price, offer_id=0, source=None)[source]¶

Append a ManageBuyOffer operation to the list of operations.

Parameters

selling_code (str) – The asset code for the asset the offer creator is selling.
selling_issuer (Optional[str]) – The issuing address for the asset the offer creator is selling.
buying_code (str) – The asset code for the asset the offer creator is buying.
buying_issuer (Optional[str]) – The issuing address for the asset the offer creator is buying.
amount (Union[str, Decimal]) – Amount being bought. if set to. Set to 0 if you want to delete an existing offer.
price (Union[str, Decimal, Price]) – Price of thing being bought in terms of what you are selling.
offer_id (int) – The ID of the offer. 0 for new offer. Set to existing offer ID to update or delete.
source (Optional[str]) – The source address that is managing a buying offer on Stellar’s distributed exchange.

Return type

TransactionBuilder

Returns

This builder instance.

append_manage_data_op(data_name, data_value, source=None)[source]¶

Append a ManageData operation to the list of operations.

Parameters

data_name (str) – String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified.
data_value (Union[str, bytes, None]) – If not present then the existing Name will be deleted. If present then this value will be set in the DataEntry. Up to 64 bytes long.
source (Optional[str]) – The source account on which data is being managed. operation.

Return type

TransactionBuilder

Returns

This builder instance.

append_manage_sell_offer_op(selling_code, selling_issuer, buying_code, buying_issuer, amount, price, offer_id=0, source=None)[source]¶

Append a ManageSellOffer operation to the list of operations.

Parameters

selling_code (str) – The asset code for the asset the offer creator is selling.
selling_issuer (Optional[str]) – The issuing address for the asset the offer creator is selling.
buying_code (str) – The asset code for the asset the offer creator is buying.
buying_issuer (Optional[str]) – The issuing address for the asset the offer creator is buying.
amount (Union[str, Decimal]) – Amount of the asset being sold. Set to 0 if you want to delete an existing offer.
price (Union[str, Price, Decimal]) – Price of 1 unit of selling in terms of buying.
offer_id (int) – The ID of the offer. 0 for new offer. Set to existing offer ID to update or delete.
source (Optional[str]) – The source address that is managing an offer on Stellar’s distributed exchange.

Return type

TransactionBuilder

Returns

This builder instance.

append_operation(operation)[source]¶

Add an operation to the builder instance

Parameters: operation (Operation) – an operation
Return type: TransactionBuilder
Returns: This builder instance.

append_path_payment_strict_receive_op(destination, send_code, send_issuer, send_max, dest_code, dest_issuer, dest_amount, path, source=None)[source]¶

Append a PathPaymentStrictReceive operation to the list of operations.

Parameters

destination (str) – The destination address (Account ID) for the payment.
send_code (str) – The asset code for the source asset deducted from the source account.
send_issuer (Optional[str]) – The address of the issuer of the source asset.
send_max (Union[str, Decimal]) – The maximum amount of send asset to deduct (excluding fees).
dest_code (str) – The asset code for the final destination asset sent to the recipient.
dest_issuer (Optional[str]) – Account address that receives the payment.
dest_amount (Union[str, Decimal]) – The amount of destination asset the destination account receives.
path (List[Asset]) – A list of Asset objects to use as the path.
source (Optional[str]) – The source address of the path payment.

Return type

TransactionBuilder

Returns

This builder instance.

append_path_payment_strict_send_op(destination, send_code, send_issuer, send_amount, dest_code, dest_issuer, dest_min, path, source=None)[source]¶

Append a PathPaymentStrictSend operation to the list of operations.

Parameters

destination (str) – The destination address (Account ID) for the payment.
send_code (str) – The asset code for the source asset deducted from the source account.
send_issuer (Optional[str]) – The address of the issuer of the source asset.
send_amount (Union[str, Decimal]) – Amount of send_asset to send.
dest_code (str) – The asset code for the final destination asset sent to the recipient.
dest_issuer (Optional[str]) – Account address that receives the payment.
dest_min (Union[str, Decimal]) – The minimum amount of dest_asset to be received.
path (List[Asset]) – A list of Asset objects to use as the path.
source (Optional[str]) – The source address of the path payment.

Return type

TransactionBuilder

Returns

This builder instance.

append_payment_op(destination, amount, asset_code='XLM', asset_issuer=None, source=None)[source]¶

Append a Payment operation to the list of operations.

Parameters

destination (str) – Account address that receives the payment.
amount (Union[str, Decimal]) – The amount of the currency to send in the payment.
asset_code (str) – The asset code for the asset to send.
asset_issuer (Optional[str]) – The address of the issuer of the asset.
source (Optional[str]) – The source address of the payment.

Return type

TransactionBuilder

Returns

This builder instance.

append_pre_auth_tx_signer(pre_auth_tx_hash, weight, source=None)[source]¶

Add a PreAuthTx signer to an account.

Add a PreAuthTx signer to an account via a SetOptions <stellar_sdk.operation.SetOptions operation. This is a helper function for append_set_options_op().

Parameters

pre_auth_tx_hash (Union[str, bytes]) – The address of the new preAuthTx signer - obtained by calling hash on the TransactionEnvelope, a 32 byte hash or hex encoded string.
weight (int) – The weight of the new signer.
source – The source account that is adding a signer to its list of signers.

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_account_sponsorship_op(account_id, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for an account to the list of operations.

Parameters

account_id (str) – The sponsored account ID.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_claimable_balance_sponsorship_op(claimable_balance_id, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for a claimable to the list of operations.

Parameters

claimable_balance_id (str) – The sponsored claimable balance ID.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_data_sponsorship_op(account_id, data_name, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for a data entry to the list of operations.

Parameters

account_id (str) – The account ID which owns the data entry.
data_name (str) – The name of the data entry
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_ed25519_public_key_signer_sponsorship_op(account_id, signer_key, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for a ed25519_public_key signer to the list of operations.

Parameters

account_id (str) – The account ID where the signer sponsorship is being removed from.
signer_key (str) – The account id of the ed25519_public_key signer.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_hashx_signer_sponsorship_op(account_id, signer_key, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for a hashx signer to the list of operations.

Parameters

account_id (str) – The account ID where the signer sponsorship is being removed from.
signer_key (Union[bytes, str]) – The account id of the hashx signer.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_offer_sponsorship_op(seller_id, offer_id, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for an offer to the list of operations.

Parameters

seller_id (str) – The account ID which created the offer.
offer_id (int) – The offer ID.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_pre_auth_tx_signer_sponsorship_op(account_id, signer_key, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for a pre_auth_tx signer to the list of operations.

Parameters

account_id (str) – The account ID where the signer sponsorship is being removed from.
signer_key (Union[bytes, str]) – The account id of the pre_auth_tx signer.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_revoke_trustline_sponsorship_op(account_id, asset, source=None)[source]¶

Append a EndSponsoringFutureReserves operation for a trustline to the list of operations.

Parameters

account_id (str) – The account ID which owns the trustline.
asset (Asset) – The asset in the trustline.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_set_options_op(inflation_dest=None, clear_flags=None, set_flags=None, master_weight=None, low_threshold=None, med_threshold=None, high_threshold=None, home_domain=None, signer=None, source=None)[source]¶

Append a SetOptions operation to the list of operations.

Parameters

inflation_dest (Optional[str]) – Account of the inflation destination.
clear_flags (Union[int, AuthorizationFlag, None]) –
Indicates which flags to clear. For details about the flags, please refer to the accounts doc. The bit mask integer subtracts from the existing flags of the account. This allows for setting specific bits without knowledge of existing flags, you can also use stellar_sdk.operation.set_options.AuthorizationFlag - AUTHORIZATION_REQUIRED = 1 - AUTHORIZATION_REVOCABLE = 2 - AUTHORIZATION_IMMUTABLE = 4 - AUTHORIZATION_CLAWBACK_ENABLED = 8
set_flags (Union[int, AuthorizationFlag, None]) – Indicates which flags to set. For details about the flags, please refer to the accounts doc. The bit mask integer adds onto the existing flags of the account. This allows for setting specific bits without knowledge of existing flags, you can also use stellar_sdk.operation.set_options.AuthorizationFlag - AUTHORIZATION_REQUIRED = 1 - AUTHORIZATION_REVOCABLE = 2 - AUTHORIZATION_IMMUTABLE = 4 - AUTHORIZATION_CLAWBACK_ENABLED = 8
master_weight (Optional[int]) – A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled.
low_threshold (Optional[int]) –
A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold.
med_threshold (Optional[int]) –
A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold.
high_threshold (Optional[int]) –
A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold.
home_domain (Optional[str]) –
sets the home domain used for reverse federation lookup.
signer (Optional[Signer]) – Add, update, or remove a signer from the account.
source (Optional[str]) – The source account (defaults to transaction source).

Return type

TransactionBuilder

Returns

This builder instance.

append_set_trust_line_flags_op(trustor, asset, clear_flags=None, set_flags=None, source=None)[source]¶

Append an SetTrustLineFlags operation to the list of operations.

Parameters

trustor (str) – The account whose trustline this is.
asset (Asset) – The asset on the trustline.
clear_flags (Optional[TrustLineFlags]) – The flags to clear.
set_flags (Optional[TrustLineFlags]) – The flags to set.
source (Optional[str]) – The source account for the operation. Defaults to the transaction’s source account.

Returns

This builder instance.

build()[source]¶

This will build the transaction envelope. It will also increment the source account’s sequence number by 1.

Return type: TransactionEnvelope
Returns: The transaction envelope.

static build_fee_bump_transaction(fee_source, base_fee, inner_transaction_envelope, network_passphrase='Test SDF Network ; September 2015')[source]¶

Create a FeeBumpTransactionEnvelope object.

See CAP-0015 for more information.

Parameters

fee_source (Union[Keypair, str]) – The account paying for the transaction.
base_fee (int) – The max fee willing to pay per operation in inner transaction (in stroops).
inner_transaction_envelope (TransactionEnvelope) – The TransactionEnvelope to be bumped by the fee bump transaction.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

Return type

FeeBumpTransactionEnvelope

Returns

a TransactionBuilder via the XDR object.

static from_xdr(xdr, network_passphrase)[source]¶

Create a TransactionBuilder or FeeBumpTransactionEnvelope via an XDR object.

In addition, if xdr is not of TransactionEnvelope, it sets the fields of this builder (the transaction envelope, transaction, operations, source, etc.) to all of the fields in the provided XDR transaction envelope, but the signature will not be added to it.

Parameters

xdr (str) – The XDR object representing the transaction envelope to which this builder is setting its state to.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from.

Return type

Union[TransactionBuilder, FeeBumpTransactionEnvelope]

Returns

a TransactionBuilder or FeeBumpTransactionEnvelope via the XDR object.

set_timeout(timeout)[source]¶

Set timeout for the transaction, actually set a TimeBounds.

Parameters: timeout (int) – timeout in second.
Return type: TransactionBuilder
Returns: This builder instance.
Raises: ValueError: if time_bound is already set.

Helpers¶

stellar_sdk.helpers.parse_transaction_envelope_from_xdr(xdr, network_passphrase)[source]¶

When you are not sure whether your XDR belongs to: TransactionEnvelope or FeeBumpTransactionEnvelope, you can use this helper function.

Parameters

xdr (str) – Transaction envelope XDR
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from. (ex. ‘Public Global Stellar Network ; September 2015’)

Raises

ValueError - XDR is neither TransactionEnvelope nor FeeBumpTransactionEnvelope

Return type

Union[TransactionEnvelope, FeeBumpTransactionEnvelope]

XDR Utils¶

stellar_sdk.xdr.utils.from_xdr_amount(value)[source]¶

Converts an str amount from an XDR amount object

Parameters: value (int) – The amount to convert to a string from an XDR int64 amount.
Return type: str

stellar_sdk.xdr.utils.to_xdr_amount(value)[source]¶

Converts an amount to the appropriate value to send over the network as a part of an XDR object.

Each asset amount is encoded as a signed 64-bit integer in the XDR structures. An asset amount unit (that which is seen by end users) is scaled down by a factor of ten million (10,000,000) to arrive at the native 64-bit integer representation. For example, the integer amount value 25,123,456 equals 2.5123456 units of the asset. This scaling allows for seven decimal places of precision in human-friendly amount units.

This static method correctly multiplies the value by the scaling factor in order to come to the integer value used in XDR structures.

See Stellar’s documentation on Asset Precision for more information.

Parameters: value (Union[str, Decimal]) – The amount to convert to an integer for XDR serialization.
Return type: int

Stellar Ecosystem Proposals¶

SEP 0001: stellar.toml¶

stellar_sdk.sep.stellar_toml.fetch_stellar_toml(domain, client=None, use_http=False)[source]¶

Retrieve the stellar.toml file from a given domain.

Retrieve the stellar.toml file for information about interacting with Stellar’s federation protocol for a given Stellar Anchor (specified by a domain).

Parameters

domain (str) – The domain the .toml file is hosted at.
use_http (bool) – Specifies whether the request should go over plain HTTP vs HTTPS. Note it is recommend that you always use HTTPS.
client (Union[BaseAsyncClient, BaseSyncClient, None]) – Http Client used to send the request.

Return type

Union[Coroutine[Any, Any, Dict[str, Any]], Dict[str, Any]]

Returns

The stellar.toml file as a an object via toml.loads().

Raises

StellarTomlNotFoundError: if the Stellar toml file could not not be found.

SEP 0002: Federation protocol¶

stellar_sdk.sep.federation.resolve_stellar_address(stellar_address, client=None, federation_url=None, use_http=False)[source]¶

Get the federation record if the user was found for a given Stellar address.

Parameters

stellar_address (str) – address Stellar address (ex. bob*stellar.org).
client (Union[BaseAsyncClient, BaseSyncClient, None]) – Http Client used to send the request.
federation_url (Optional[str]) – The federation server URL (ex. https://stellar.org/federation), if you don’t set this value, we will try to get it from stellar_address.
use_http (bool) – Specifies whether the request should go over plain HTTP vs HTTPS. Note it is recommend that you always use HTTPS.

Return type

Union[Coroutine[Any, Any, FederationRecord], FederationRecord]

Returns

Federation record.

stellar_sdk.sep.federation.resolve_account_id(account_id, domain=None, federation_url=None, client=None, use_http=False)[source]¶

Given an account ID, get their federation record if the user was found

Parameters

account_id (str) – Account ID (ex. GBYNR2QJXLBCBTRN44MRORCMI4YO7FZPFBCNOKTOBCAAFC7KC3LNPRYS)
domain (Optional[str]) – Get federation_url from the domain, you don’t need to set this value if federation_url is set.
federation_url (Optional[str]) – The federation server URL (ex. https://stellar.org/federation).
client (Union[BaseAsyncClient, BaseSyncClient, None]) – Http Client used to send the request.
use_http (bool) – Specifies whether the request should go over plain HTTP vs HTTPS. Note it is recommend that you always use HTTPS.

Return type

Union[Coroutine[Any, Any, FederationRecord], FederationRecord]

Returns

Federation record.

class stellar_sdk.sep.federation.FederationRecord(account_id, stellar_address, memo_type, memo)[source]¶

SEP 0005: Key Derivation Methods for Stellar Accounts¶

class stellar_sdk.sep.mnemonic.StellarMnemonic(language=<Language.ENGLISH: 'english'>)[source]¶: Please use Keypair.generate_mnemonic_phrase() and Keypair.from_mnemonic_phrase()

class stellar_sdk.sep.mnemonic.Language(value)[source]¶

The type of language supported by the mnemonic.

CHINESE_SIMPLIFIED = 'chinese_simplified'¶

CHINESE_TRADITIONAL = 'chinese_traditional'¶

ENGLISH = 'english'¶

FRENCH = 'french'¶

ITALIAN = 'italian'¶

JAPANESE = 'japanese'¶

KOREAN = 'korean'¶

SPANISH = 'spanish'¶

SEP 0007: URI Scheme to facilitate delegated signing¶

class stellar_sdk.sep.stellar_uri.PayStellarUri(destination, amount=None, asset=None, memo=None, callback=None, message=None, network_passphrase=None, origin_domain=None, signature=None)[source]¶

A request for a payment to be signed.

See SEP-0007

Parameters

destination (str) – A valid account ID or payment address.
amount (Optional[str]) – Amount that destination will receive.
asset (Optional[Asset]) – Asset destination will receive.
memo (Optional[Memo]) – A memo to attach to the transaction.
callback (Optional[str]) – The uri to post the transaction to after signing.
message (Optional[str]) – An message for displaying to the user.
network_passphrase (Optional[str]) – The passphrase of the target network.
origin_domain (Optional[str]) – A fully qualified domain name that specifies the originating domain of the URI request.
signature (Optional[str]) – A base64 encode signature of the hash of the URI request.

classmethod from_uri(uri)[source]¶

Parse Stellar Pay URI and generate PayStellarUri object.

Parameters: uri (str) – Stellar Pay URI.
Return type: PayStellarUri
Returns: PayStellarUri object from uri.

sign(signer)¶

Sign the URI.

Parameters: signer (Union[Keypair, str]) – The account used to sign this transaction, it should be the secret key of URI_REQUEST_SIGNING_KEY.
Return type: None

to_uri()[source]¶

Generate the request URI.

Return type: str
Returns: Stellar Pay URI.

class stellar_sdk.sep.stellar_uri.TransactionStellarUri(transaction_envelope, replace=None, callback=None, pubkey=None, message=None, network_passphrase=None, origin_domain=None, signature=None)[source]¶

A request for a transaction to be signed.

See SEP-0007

Parameters

transaction_envelope (Union[TransactionEnvelope, FeeBumpTransactionEnvelope]) – Transaction waiting to be signed.
replace (Optional[List[Replacement]]) – A value that identifies the fields to be replaced in the xdr using the Txrep (SEP-0011) representation.
callback (Optional[str]) – The uri to post the transaction to after signing.
pubkey (Optional[str]) – Specify which public key you want the URI handler to sign for.
message (Optional[str]) – An message for displaying to the user.
network_passphrase (Optional[str]) – The passphrase of the target network.
origin_domain (Optional[str]) – A fully qualified domain name that specifies the originating domain of the URI request.
signature (Optional[str]) – A base64 encode signature of the hash of the URI request.

classmethod from_uri(uri, network_passphrase)[source]¶

Parse Stellar Transaction URI and generate TransactionStellarUri object.

Parameters

uri (str) – Stellar Transaction URI.
network_passphrase (Optional[str]) – The network to connect to for verifying and retrieving xdr, If it is set to None, the network_passphrase in the uri will not be verified.

Return type

TransactionStellarUri

Returns

TransactionStellarUri object from uri.

sign(signer)¶

Sign the URI.

Parameters: signer (Union[Keypair, str]) – The account used to sign this transaction, it should be the secret key of URI_REQUEST_SIGNING_KEY.
Return type: None

to_uri()[source]¶

Generate the request URI.

Return type: str
Returns: Stellar Transaction URI.

class stellar_sdk.sep.stellar_uri.Replacement(txrep_tx_field_name, reference_identifier, hint)[source]¶

SEP 0010: Stellar Web Authentication¶

stellar_sdk.sep.stellar_web_authentication.build_challenge_transaction(server_secret, client_account_id, home_domain, web_auth_domain, network_passphrase, timeout=900, client_domain=None, client_signing_key=None)[source]¶

Returns a valid SEP0010 challenge transaction which you can use for Stellar Web Authentication.

Parameters

server_secret (str) – secret key for server’s stellar.toml SIGNING_KEY.
client_account_id (str) – The stellar account that the wallet wishes to authenticate with the server.
home_domain (str) – The fully qualified domain name of the service requiring authentication, for example: example.com.
web_auth_domain (str) – The fully qualified domain name of the service issuing the challenge.
network_passphrase (str) – The network to connect to for verifying and retrieving additional attributes from. (ex. ‘Public Global Stellar Network ; September 2015’)
timeout (int) – Challenge duration in seconds (default to 15 minutes).
client_domain (Optional[str]) – The domain of the client application requesting authentication
client_signing_key (Optional