api library

Classes

AccountAuthorizedDepositorBadgeType
AccountAuthorizedDepositorBadgeTypeTypeTransformer
Transformation class that can encode an instance of AccountAuthorizedDepositorBadgeType to String, and decode dynamic data back to AccountAuthorizedDepositorBadgeType.
AccountAuthorizedDepositorsCollection
AccountAuthorizedDepositorsNonFungibleBadge
AccountAuthorizedDepositorsResourceBadge
AccountAuthorizedDepositorsResponseItem
AccountDefaultDepositRule
Default deposit rule set to an account.
AccountDefaultDepositRuleTypeTransformer
Transformation class that can encode an instance of AccountDefaultDepositRule to String, and decode dynamic data back to AccountDefaultDepositRule.
AccountDepositPreValidationDecidingFactors
AccountDepositPreValidationDecidingFactorsResourceSpecificDetailsItem
AccountDepositPreValidationNonFungibleBadge
AccountDepositPreValidationRequest
AccountDepositPreValidationResourceBadge
AccountDepositPreValidationResourceSpecificBehaviourItem
AccountDepositPreValidationResponse
AccountLockerAddress
AccountLockerNotFoundError
AccountLockerVaultCollection
AccountLockerVaultCollectionItem
AccountLockerVaultCollectionItemFungible
AccountLockerVaultCollectionItemNonFungible
AccountLockerVaultCollectionItemType
AccountLockerVaultCollectionItemTypeTypeTransformer
Transformation class that can encode an instance of AccountLockerVaultCollectionItemType to String, and decode dynamic data back to AccountLockerVaultCollectionItemType.
AccountResourcePreferenceRule
AccountResourcePreferenceRuleTypeTransformer
Transformation class that can encode an instance of AccountResourcePreferenceRule to String, and decode dynamic data back to AccountResourcePreferenceRule.
AccountResourcePreferencesCollection
AccountResourcePreferencesResponseItem
ApiClient
ApiKeyAuth
AtLedgerStateMixin
Authentication
BlueprintMethodRoyalty
BlueprintRoyaltyConfig
CommittedTransactionInfo
ComponentEntityRoleAssignmentEntry
ComponentEntityRoleAssignmentEntryAssignment
ComponentEntityRoleAssignments
ComponentMethodRoyalty
ComponentRoyaltyConfig
CursorLimitMixin
DeserializationMessage
Primarily intended for use in an isolate.
EntityMetadataCollection
EntityMetadataItem
EntityMetadataItemValue
EntityNotFoundError
EntitySchemaCollection
EntitySchemaCollectionItem
ErrorResponse
EventsItem
FromLedgerStateMixin
FungibleResourcesCollection
FungibleResourcesCollectionItem
FungibleResourcesCollectionItemGloballyAggregated
FungibleResourcesCollectionItemVaultAggregated
FungibleResourcesCollectionItemVaultAggregatedVault
FungibleResourcesCollectionItemVaultAggregatedVaultItem
GatewayError
GatewayInfoResponseKnownTarget
GatewayInfoResponseReleaseInfo
GatewayStatusResponse
HttpBasicAuth
HttpBearerAuth
InternalServerError
InvalidEntityError
InvalidRequestError
InvalidTransactionError
LedgerState
LedgerStateMixin
LedgerStateSelector
ManifestClass
High-level manifest class type: * General: A general manifest that involves any amount of arbitrary components and packages where nothing more concrete can be said about the manifest and its nature. * Transfer: A manifest of a 1-to-1 transfer to a one-to-many transfer of resources. * PoolContribution: A manifest that contributed some amount of resources to a liquidity pool that can be a one-resource pool, two-resource pool, or a multi-resource pool. * PoolRedemption: A manifest that redeemed resources from a liquidity pool. Similar to contributions, this can be any of the three pool blueprints available in the pool package. * ValidatorStake: A manifest where XRD is staked to one or more validators. * ValidatorUnstake: A manifest where XRD is unstaked from one or more validators. * ValidatorClaim: A manifest where XRD is claimed from one or more validators. * AccountDepositSettingsUpdate: A manifest that updated the deposit settings of the account.
ManifestClassTypeTransformer
Transformation class that can encode an instance of ManifestClass to String, and decode dynamic data back to ManifestClass.
MetadataBoolArrayValue
MetadataBoolValue
MetadataDecimalArrayValue
MetadataDecimalValue
MetadataGlobalAddressArrayValue
MetadataGlobalAddressValue
MetadataI32ArrayValue
MetadataI32Value
MetadataI64ArrayValue
MetadataI64Value
MetadataInstantArrayValue
MetadataInstantValue
MetadataNonFungibleGlobalIdArrayValue
MetadataNonFungibleGlobalIdArrayValueAllOfValues
MetadataNonFungibleGlobalIdValue
MetadataNonFungibleLocalIdArrayValue
MetadataNonFungibleLocalIdValue
MetadataOriginArrayValue
MetadataOriginValue
MetadataPublicKeyArrayValue
MetadataPublicKeyHashArrayValue
MetadataPublicKeyHashValue
MetadataPublicKeyValue
MetadataStringArrayValue
MetadataStringValue
MetadataTypedValue
MetadataU32ArrayValue
MetadataU32Value
MetadataU64ArrayValue
MetadataU64Value
MetadataU8ArrayValue
MetadataU8Value
MetadataUrlArrayValue
MetadataUrlValue
MetadataValueType
MetadataValueTypeTypeTransformer
Transformation class that can encode an instance of MetadataValueType to String, and decode dynamic data back to MetadataValueType.
NetworkConfigurationResponse
NetworkConfigurationResponseWellKnownAddresses
NonFungibleIdsCollection
NonFungibleIdType
NonFungibleIdTypeTypeTransformer
Transformation class that can encode an instance of NonFungibleIdType to String, and decode dynamic data back to NonFungibleIdType.
NonFungibleResourcesCollection
NonFungibleResourcesCollectionItem
NonFungibleResourcesCollectionItemGloballyAggregated
NonFungibleResourcesCollectionItemVaultAggregated
NonFungibleResourcesCollectionItemVaultAggregatedVault
NonFungibleResourcesCollectionItemVaultAggregatedVaultItem
NotSyncedUpError
OAuth
ObjectModuleId
ObjectModuleIdTypeTransformer
Transformation class that can encode an instance of ObjectModuleId to String, and decode dynamic data back to ObjectModuleId.
OptionalNonFungibleIdsCollection
PackageBlueprintCollection
PackageBlueprintCollectionItem
PackageCodeCollection
PackageCodeCollectionItem
PackageVmType
PackageVmTypeTypeTransformer
Transformation class that can encode an instance of PackageVmType to String, and decode dynamic data back to PackageVmType.
ProgrammaticScryptoSborValue
ProgrammaticScryptoSborValueArray
ProgrammaticScryptoSborValueBool
ProgrammaticScryptoSborValueBytes
ProgrammaticScryptoSborValueDecimal
ProgrammaticScryptoSborValueEnum
ProgrammaticScryptoSborValueI128
ProgrammaticScryptoSborValueI16
ProgrammaticScryptoSborValueI32
ProgrammaticScryptoSborValueI64
ProgrammaticScryptoSborValueI8
ProgrammaticScryptoSborValueKind
These are the Scrypto SBOR ValueKinds, but with Bytes added as an alias for Vec, to display such values as hex-encoded strings.
ProgrammaticScryptoSborValueKindTypeTransformer
Transformation class that can encode an instance of ProgrammaticScryptoSborValueKind to String, and decode dynamic data back to ProgrammaticScryptoSborValueKind.
ProgrammaticScryptoSborValueMap
ProgrammaticScryptoSborValueMapEntry
ProgrammaticScryptoSborValueNonFungibleLocalId
ProgrammaticScryptoSborValueOwn
ProgrammaticScryptoSborValuePreciseDecimal
ProgrammaticScryptoSborValueReference
ProgrammaticScryptoSborValueString
ProgrammaticScryptoSborValueTuple
ProgrammaticScryptoSborValueU128
ProgrammaticScryptoSborValueU16
ProgrammaticScryptoSborValueU32
ProgrammaticScryptoSborValueU64
ProgrammaticScryptoSborValueU8
PublicKey
PublicKeyEcdsaSecp256k1
PublicKeyEddsaEd25519
PublicKeyHash
PublicKeyHashEcdsaSecp256k1
PublicKeyHashEddsaEd25519
PublicKeyHashType
PublicKeyHashTypeTypeTransformer
Transformation class that can encode an instance of PublicKeyHashType to String, and decode dynamic data back to PublicKeyHashType.
PublicKeyType
PublicKeyTypeTypeTransformer
Transformation class that can encode an instance of PublicKeyType to String, and decode dynamic data back to PublicKeyType.
QueryParam
ResourceAggregationLevel
ResourceAggregationLevelTypeTransformer
Transformation class that can encode an instance of ResourceAggregationLevel to String, and decode dynamic data back to ResourceAggregationLevel.
ResultSetCursorMixin
RoleAssignmentResolution
RoleAssignmentResolutionTypeTransformer
Transformation class that can encode an instance of RoleAssignmentResolution to String, and decode dynamic data back to RoleAssignmentResolution.
RoleKey
RoyaltyAmount
RoyaltyAmountUnitEnum
RoyaltyAmountUnitEnumTypeTransformer
Transformation class that can encode an instance of RoyaltyAmountUnitEnum to String, and decode dynamic data back to RoyaltyAmountUnitEnum.
ScryptoSborValue
StateAccountAuthorizedDepositorsPageRequest
StateAccountAuthorizedDepositorsPageResponse
StateAccountLockerPageVaultsRequest
StateAccountLockerPageVaultsResponse
StateAccountLockersTouchedAtRequest
StateAccountLockersTouchedAtResponse
StateAccountLockersTouchedAtResponseItem
StateAccountResourcePreferencesPageRequest
StateAccountResourcePreferencesPageResponse
StateApi
StateEntityDetailsOptIns
StateEntityDetailsRequest
StateEntityDetailsResponse
StateEntityDetailsResponseComponentDetails
StateEntityDetailsResponseFungibleResourceDetails
StateEntityDetailsResponseFungibleVaultDetails
StateEntityDetailsResponseItem
StateEntityDetailsResponseItemAncestorIdentities
StateEntityDetailsResponseItemDetails
StateEntityDetailsResponseItemDetailsType
StateEntityDetailsResponseItemDetailsTypeTypeTransformer
Transformation class that can encode an instance of StateEntityDetailsResponseItemDetailsType to String, and decode dynamic data back to StateEntityDetailsResponseItemDetailsType.
StateEntityDetailsResponseNonFungibleResourceDetails
StateEntityDetailsResponseNonFungibleVaultDetails
StateEntityDetailsResponsePackageDetails
StateEntityFungibleResourceVaultsPageRequest
StateEntityFungibleResourceVaultsPageResponse
StateEntityFungiblesPageRequest
StateEntityFungiblesPageRequestOptIns
StateEntityFungiblesPageResponse
StateEntityMetadataPageRequest
StateEntityMetadataPageResponse
StateEntityNonFungibleIdsPageRequest
StateEntityNonFungibleIdsPageResponse
StateEntityNonFungibleResourceVaultsPageOptIns
StateEntityNonFungibleResourceVaultsPageRequest
StateEntityNonFungibleResourceVaultsPageResponse
StateEntityNonFungiblesPageRequest
StateEntityNonFungiblesPageRequestOptIns
StateEntityNonFungiblesPageResponse
StateEntitySchemaPageRequest
StateEntitySchemaPageResponse
StateKeyValueStoreDataRequest
StateKeyValueStoreDataRequestKeyItem
StateKeyValueStoreDataResponse
StateKeyValueStoreDataResponseItem
StateKeyValueStoreKeysCollection
StateKeyValueStoreKeysRequest
StateKeyValueStoreKeysResponse
StateKeyValueStoreKeysResponseItem
StateNonFungibleDataRequest
StateNonFungibleDataResponse
StateNonFungibleDetailsResponseItem
StateNonFungibleIdsRequest
StateNonFungibleIdsResponse
StateNonFungibleLocationRequest
StateNonFungibleLocationResponse
StateNonFungibleLocationResponseItem
StatePackageBlueprintPageRequest
StatePackageBlueprintPageResponse
StatePackageCodePageRequest
StatePackageCodePageResponse
StateValidatorsListRequest
StateValidatorsListResponse
StatisticsApi
StatusApi
StreamApi
StreamTransactionsRequest
StreamTransactionsRequestAllOfManifestClassFilter
StreamTransactionsRequestEventFilterItem
StreamTransactionsRequestEventFilterItemEventEnum
StreamTransactionsRequestEventFilterItemEventEnumTypeTransformer
Transformation class that can encode an instance of StreamTransactionsRequestEventFilterItemEventEnum to String, and decode dynamic data back to StreamTransactionsRequestEventFilterItemEventEnum.
StreamTransactionsRequestKindFilterEnum
Limit returned transactions by their kind. Defaults to user.
StreamTransactionsRequestKindFilterEnumTypeTransformer
Transformation class that can encode an instance of StreamTransactionsRequestKindFilterEnum to String, and decode dynamic data back to StreamTransactionsRequestKindFilterEnum.
StreamTransactionsRequestOrderEnum
Configures the order of returned result set. Defaults to desc.
StreamTransactionsRequestOrderEnumTypeTransformer
Transformation class that can encode an instance of StreamTransactionsRequestOrderEnum to String, and decode dynamic data back to StreamTransactionsRequestOrderEnum.
StreamTransactionsResponse
TransactionAccountDepositPreValidationAuthorizedDepositorBadge
TransactionApi
TransactionBalanceChanges
TransactionCommittedDetailsRequest
TransactionCommittedDetailsResponse
TransactionConstructionResponse
TransactionDetailsOptIns
TransactionFungibleBalanceChanges
TransactionFungibleFeeBalanceChanges
TransactionFungibleFeeBalanceChangeType
Indicates fee-related balance changes, for example: - payment of the fee including tip and royalty, - distribution of royalties, - distribution of the fee and tip to the consensus-manager, for distributing to the relevant validator/s at end of epoch. See https://www.radixdlt.com/blog/how-fees-work-in-babylon for further information on how fee payment works at Babylon.
TransactionFungibleFeeBalanceChangeTypeTypeTransformer
Transformation class that can encode an instance of TransactionFungibleFeeBalanceChangeType to String, and decode dynamic data back to TransactionFungibleFeeBalanceChangeType.
TransactionIntentStatus
A more specific intent status. See the description field for further information. Note that CommitPendingOutcomeUnknown can either result in CommittedSuccess or CommittedFailure.
TransactionIntentStatusTypeTransformer
Transformation class that can encode an instance of TransactionIntentStatus to String, and decode dynamic data back to TransactionIntentStatus.
TransactionNonFungibleBalanceChanges
TransactionNotFoundError
TransactionPayloadGatewayHandlingStatus
A status concerning the Gateway's handling status of this pending transaction.
TransactionPayloadGatewayHandlingStatusTypeTransformer
Transformation class that can encode an instance of TransactionPayloadGatewayHandlingStatus to String, and decode dynamic data back to TransactionPayloadGatewayHandlingStatus.
TransactionPayloadStatus
A more specific payload status. See the description field for further information.
TransactionPayloadStatusTypeTransformer
Transformation class that can encode an instance of TransactionPayloadStatus to String, and decode dynamic data back to TransactionPayloadStatus.
TransactionPreviewRequest
TransactionPreviewRequestFlags
TransactionPreviewResponse
TransactionPreviewResponseLogsInner
TransactionReceipt
TransactionStatus
A top-level intent status, left in for backwards compatibility. It doesn't give much information. Rejected means PermanentRejection.
TransactionStatusRequest
TransactionStatusResponse
TransactionStatusResponseKnownPayloadItem
TransactionStatusTypeTransformer
Transformation class that can encode an instance of TransactionStatus to String, and decode dynamic data back to TransactionStatus.
TransactionSubmitRequest
TransactionSubmitResponse
ValidationErrorsAtPath
ValidatorCollection
ValidatorCollectionItem
ValidatorCollectionItemActiveInEpoch
ValidatorCollectionItemEffectiveFeeFactor
ValidatorCollectionItemEffectiveFeeFactorCurrent
ValidatorCollectionItemEffectiveFeeFactorPending
ValidatorsUptimeRequest
ValidatorsUptimeResponse
ValidatorUptimeCollection
ValidatorUptimeCollectionItem
ValidatorVaultItem

Properties

defaultApiClient ApiClient
An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
getter/setter pair

Functions

decodeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
deserializeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
mapCastOfType<K, V>(dynamic map, String key) Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) String
Format the given parameter object into a String.
serializeAsync(Object? value) Future<String>
Primarily intended for use in an isolate.

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException