Skip to content

Latest commit

 

History

History
643 lines (481 loc) · 14.1 KB

api.rst

File metadata and controls

643 lines (481 loc) · 14.1 KB

API Documentation

stellar_sdk

Account

stellar_sdk.account.Account

Asset

stellar_sdk.asset.Asset

Call Builder

BaseCallBuilder

stellar_sdk.call_builder.BaseCallBuilder

AccountsCallBuilder

stellar_sdk.call_builder.AccountsCallBuilder

AssetsCallBuilder

stellar_sdk.call_builder.AssetsCallBuilder

ClaimableBalancesCallBuilder

stellar_sdk.call_builder.ClaimableBalancesCallBuilder

DataCallBuilder

stellar_sdk.call_builder.DataCallBuilder

EffectsCallBuilder

stellar_sdk.call_builder.EffectsCallBuilder

FeeStatsCallBuilder

stellar_sdk.call_builder.FeeStatsCallBuilder

LedgersCallBuilder

stellar_sdk.call_builder.LedgersCallBuilder

OffersCallBuilder

stellar_sdk.call_builder.OffersCallBuilder

OperationsCallBuilder

stellar_sdk.call_builder.OperationsCallBuilder

OrderbookCallBuilder

stellar_sdk.call_builder.OrderbookCallBuilder

PaymentsCallBuilder

stellar_sdk.call_builder.PaymentsCallBuilder

RootCallBuilder

stellar_sdk.call_builder.RootCallBuilder

StrictReceivePathsCallBuilder

stellar_sdk.call_builder.StrictReceivePathsCallBuilder

StrictSendPathsCallBuilder

stellar_sdk.call_builder.StrictSendPathsCallBuilder

TradeAggregationsCallBuilder

stellar_sdk.call_builder.TradeAggregationsCallBuilder

TradesCallBuilder

stellar_sdk.call_builder.TradesCallBuilder

TransactionsCallBuilder

stellar_sdk.call_builder.TransactionsCallBuilder

Client

BaseAsyncClient

stellar_sdk.client.base_async_client.BaseAsyncClient

BaseSyncClient

stellar_sdk.client.base_sync_client.BaseSyncClient

AiohttpClient

stellar_sdk.client.aiohttp_client.AiohttpClient

RequestsClient

stellar_sdk.client.requests_client.RequestsClient

SimpleRequestsClient

stellar_sdk.client.simple_requests_client.SimpleRequestsClient

Response

stellar_sdk.client.response.Response

Exceptions

SdkError

stellar_sdk.exceptions.SdkError

ValueError

stellar_sdk.exceptions.ValueError

TypeError

stellar_sdk.exceptions.TypeError

BadSignatureError

stellar_sdk.exceptions.BadSignatureError

Ed25519PublicKeyInvalidError

stellar_sdk.exceptions.Ed25519PublicKeyInvalidError

Ed25519SecretSeedInvalidError

stellar_sdk.exceptions.Ed25519SecretSeedInvalidError

MissingEd25519SecretSeedError

stellar_sdk.exceptions.MissingEd25519SecretSeedError

MemoInvalidException

stellar_sdk.exceptions.MemoInvalidException

AssetCodeInvalidError

stellar_sdk.exceptions.AssetCodeInvalidError

AssetIssuerInvalidError

stellar_sdk.exceptions.AssetIssuerInvalidError

NoApproximationError

stellar_sdk.exceptions.NoApproximationError

SignatureExistError

stellar_sdk.exceptions.SignatureExistError

BaseRequestError

stellar_sdk.exceptions.BaseRequestError

ConnectionError

stellar_sdk.exceptions.ConnectionError

BaseHorizonError

stellar_sdk.exceptions.BaseHorizonError

NotFoundError

stellar_sdk.exceptions.NotFoundError

BadRequestError

stellar_sdk.exceptions.BadRequestError

BadResponseError

stellar_sdk.exceptions.BadResponseError

FeatureNotEnabledError

stellar_sdk.exceptions.FeatureNotEnabledError

Keypair

stellar_sdk.keypair.Keypair

Memo

Memo

stellar_sdk.memo.Memo

NoneMemo

stellar_sdk.memo.NoneMemo

TextMemo

stellar_sdk.memo.TextMemo

IdMemo

stellar_sdk.memo.IdMemo

HashMemo

stellar_sdk.memo.HashMemo

ReturnHashMemo

stellar_sdk.memo.ReturnHashMemo

MuxedAccount

stellar_sdk.muxed_account.MuxedAccount

Network

stellar_sdk.network.Network

Operation

Operation

stellar_sdk.operation.Operation

OperationType

stellar_sdk.operation.operation_type.OperationType

AccountMerge

stellar_sdk.operation.AccountMerge

AllowTrust

stellar_sdk.operation.AllowTrust

stellar_sdk.operation.allow_trust.TrustLineEntryFlag

BumpSequence

stellar_sdk.operation.BumpSequence

ChangeTrust

stellar_sdk.operation.ChangeTrust

CreateAccount

stellar_sdk.operation.CreateAccount

CreatePassiveSellOffer

stellar_sdk.operation.CreatePassiveSellOffer

Inflation

stellar_sdk.operation.Inflation

ManageBuyOffer

stellar_sdk.operation.ManageBuyOffer

ManageData

stellar_sdk.operation.ManageData

ManageSellOffer

stellar_sdk.operation.ManageSellOffer

PathPaymentStrictReceive

stellar_sdk.operation.PathPaymentStrictReceive

PathPaymentStrictSend

stellar_sdk.operation.PathPaymentStrictSend

Payment

stellar_sdk.operation.Payment

SetOptions

stellar_sdk.operation.SetOptions

stellar_sdk.operation.set_options.AuthorizationFlag

CreateClaimableBalance

stellar_sdk.operation.CreateClaimableBalance

stellar_sdk.operation.Claimant

stellar_sdk.operation.ClaimPredicate

stellar_sdk.operation.create_claimable_balance.ClaimPredicateType

stellar_sdk.operation.create_claimable_balance.ClaimPredicateGroup

ClaimClaimableBalance

stellar_sdk.operation.ClaimClaimableBalance

BeginSponsoringFutureReserves

stellar_sdk.operation.BeginSponsoringFutureReserves

EndSponsoringFutureReserves

stellar_sdk.operation.EndSponsoringFutureReserves

RevokeSponsorship

stellar_sdk.operation.RevokeSponsorship

stellar_sdk.operation.revoke_sponsorship.RevokeSponsorshipType

stellar_sdk.operation.revoke_sponsorship.TrustLine

stellar_sdk.operation.revoke_sponsorship.Offer

stellar_sdk.operation.revoke_sponsorship.Data

stellar_sdk.operation.revoke_sponsorship.Signer

Clawback

stellar_sdk.operation.Clawback

ClawbackClaimableBalance

stellar_sdk.operation.ClawbackClaimableBalance

SetTrustLineFlags

stellar_sdk.operation.SetTrustLineFlags

stellar_sdk.operation.set_trust_line_flags.TrustLineFlags

Price

stellar_sdk.price.Price

Server

stellar_sdk.server.Server

Signer

stellar_sdk.signer.Signer

SignerKey

stellar_sdk.signer_key.SignerKey

TimeBounds

stellar_sdk.time_bounds.TimeBounds

Transaction

stellar_sdk.transaction.Transaction

TransactionEnvelope

stellar_sdk.transaction_envelope.TransactionEnvelope

FeeBumpTransaction

stellar_sdk.fee_bump_transaction.FeeBumpTransaction

FeeBumpTransactionEnvelope

stellar_sdk.fee_bump_transaction_envelope.FeeBumpTransactionEnvelope

TransactionBuilder

stellar_sdk.transaction_builder.TransactionBuilder

Helpers

stellar_sdk.helpers.parse_transaction_envelope_from_xdr

XDR Utils

stellar_sdk.xdr.utils.from_xdr_amount

stellar_sdk.xdr.utils.to_xdr_amount

Stellar Ecosystem Proposals

SEP 0001: stellar.toml

stellar_sdk.sep.stellar_toml.fetch_stellar_toml

SEP 0002: Federation protocol

stellar_sdk.sep.federation.resolve_stellar_address

stellar_sdk.sep.federation.resolve_account_id

stellar_sdk.sep.federation.FederationRecord

SEP 0005: Key Derivation Methods for Stellar Accounts

stellar_sdk.sep.mnemonic.StellarMnemonic

stellar_sdk.sep.mnemonic.Language

SEP 0007: URI Scheme to facilitate delegated signing

stellar_sdk.sep.stellar_uri.PayStellarUri

stellar_sdk.sep.stellar_uri.TransactionStellarUri

stellar_sdk.sep.stellar_uri.Replacement

SEP 0010: Stellar Web Authentication

stellar_sdk.sep.stellar_web_authentication.build_challenge_transaction

stellar_sdk.sep.stellar_web_authentication.read_challenge_transaction

stellar_sdk.sep.stellar_web_authentication.verify_challenge_transaction_threshold

stellar_sdk.sep.stellar_web_authentication.verify_challenge_transaction_signed_by_client_master_key

stellar_sdk.sep.stellar_web_authentication.verify_challenge_transaction_signers

stellar_sdk.sep.stellar_web_authentication.verify_challenge_transaction

stellar_sdk.sep.stellar_web_authentication.ChallengeTransaction

SEP 0011: Txrep: human-readable low-level representation of Stellar transactions

stellar_sdk.sep.txrep.to_txrep

stellar_sdk.sep.txrep.from_txrep

Exceptions

stellar_sdk.sep.exceptions.StellarTomlNotFoundError

stellar_sdk.sep.exceptions.InvalidFederationAddress

stellar_sdk.sep.exceptions.FederationServerNotFoundError

stellar_sdk.sep.exceptions.BadFederationResponseError

stellar_sdk.sep.exceptions.InvalidSep10ChallengeError

stellar_sdk.sep.exceptions.AccountRequiresMemoError