api

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 13, 2024 License: MIT Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AccountsAPI *AccountsAPIService

	BlocksAPI *BlocksAPIService

	BurnBlocksAPI *BurnBlocksAPIService

	FaucetsAPI *FaucetsAPIService

	FeesAPI *FeesAPIService

	InfoAPI *InfoAPIService

	MempoolAPI *MempoolAPIService

	MicroblocksAPI *MicroblocksAPIService

	NamesAPI *NamesAPIService

	NonFungibleTokensAPI *NonFungibleTokensAPIService

	ProofOfTransferAPI *ProofOfTransferAPIService

	RosettaAPI *RosettaAPIService

	SearchAPI *SearchAPIService

	SmartContractsAPI *SmartContractsAPIService

	StackingAPI *StackingAPIService

	StackingRewardsAPI *StackingRewardsAPIService

	TransactionsAPI *TransactionsAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Stacks Blockchain API API vSTACKS_API_VERSION In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *config.Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *config.Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type AccountsAPIService 

type AccountsAPIService service

AccountsAPIService AccountsAPI service

func (*AccountsAPIService) GetAccountAssets 

func (a *AccountsAPIService) GetAccountAssets(ctx context.Context, principal string) ApiGetAccountAssetsRequest

GetAccountAssets Get account assets

Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier
@return ApiGetAccountAssetsRequest

func (*AccountsAPIService) GetAccountAssetsExecute 

func (a *AccountsAPIService) GetAccountAssetsExecute(r ApiGetAccountAssetsRequest) (*models.AddressAssetsListResponse, *http.Response, error)

Execute executes the request 

@return models.AddressAssetsListResponse

func (*AccountsAPIService) GetAccountBalance 

func (a *AccountsAPIService) GetAccountBalance(ctx context.Context, principal string) ApiGetAccountBalanceRequest

GetAccountBalance Get account balances

Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier
@return ApiGetAccountBalanceRequest

func (*AccountsAPIService) GetAccountBalanceExecute 

func (a *AccountsAPIService) GetAccountBalanceExecute(r ApiGetAccountBalanceRequest) (*models.AddressBalanceResponse, *http.Response, error)

Execute executes the request 

@return AddressBalanceResponse

func (*AccountsAPIService) GetAccountInbound 

func (a *AccountsAPIService) GetAccountInbound(ctx context.Context, principal string) ApiGetAccountInboundRequest

GetAccountInbound Get inbound STX transfers

Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier
@return ApiGetAccountInboundRequest

func (*AccountsAPIService) GetAccountInboundExecute 

func (a *AccountsAPIService) GetAccountInboundExecute(r ApiGetAccountInboundRequest) (*models.AddressStxInboundListResponse, *http.Response, error)

Execute executes the request 

@return AddressStxInboundListResponse

func (*AccountsAPIService) GetAccountInfo 

func (a *AccountsAPIService) GetAccountInfo(ctx context.Context, principal string) ApiGetAccountInfoRequest

GetAccountInfo Get account info

Retrieves the account data for a given Account or a Contract Identifier

Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.

For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier
@return ApiGetAccountInfoRequest

func (*AccountsAPIService) GetAccountInfoExecute 

func (a *AccountsAPIService) GetAccountInfoExecute(r ApiGetAccountInfoRequest) (*models.AccountDataResponse, *http.Response, error)

Execute executes the request 

@return AccountDataResponse

func (*AccountsAPIService) GetAccountNonces 

func (a *AccountsAPIService) GetAccountNonces(ctx context.Context, principal string) ApiGetAccountNoncesRequest

GetAccountNonces Get the latest nonce used by an account

Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address
@return ApiGetAccountNoncesRequest

func (*AccountsAPIService) GetAccountNoncesExecute 

func (a *AccountsAPIService) GetAccountNoncesExecute(r ApiGetAccountNoncesRequest) (*models.AddressNonces, *http.Response, error)

Execute executes the request 

@return AddressNonces

func (*AccountsAPIService) GetAccountStxBalance 

func (a *AccountsAPIService) GetAccountStxBalance(ctx context.Context, principal string) ApiGetAccountStxBalanceRequest

GetAccountStxBalance Get account STX balance

Retrieves STX token balance for a given Address or Contract Identifier. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier.
@return ApiGetAccountStxBalanceRequest

func (*AccountsAPIService) GetAccountStxBalanceExecute 

func (a *AccountsAPIService) GetAccountStxBalanceExecute(r ApiGetAccountStxBalanceRequest) (*models.AddressStxBalanceResponse, *http.Response, error)

Execute executes the request 

@return AddressStxBalanceResponse

func (*AccountsAPIService) GetAccountTransactions 

func (a *AccountsAPIService) GetAccountTransactions(ctx context.Context, principal string) ApiGetAccountTransactionsRequest

GetAccountTransactions Get account transactions

Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).

If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier
@return ApiGetAccountTransactionsRequest

Deprecated

func (*AccountsAPIService) GetAccountTransactionsExecute 

func (a *AccountsAPIService) GetAccountTransactionsExecute(r ApiGetAccountTransactionsRequest) (*models.AddressTransactionsListResponse, *http.Response, error)

Execute executes the request 

@return AddressTransactionsListResponse

Deprecated

func (*AccountsAPIService) GetAccountTransactionsWithTransfers 

func (a *AccountsAPIService) GetAccountTransactionsWithTransfers(ctx context.Context, principal string) ApiGetAccountTransactionsWithTransfersRequest

GetAccountTransactionsWithTransfers Get account transactions including STX transfers for each transaction.

Retrieve all transactions for an account or contract identifier including STX transfers for each transaction. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a Contract identifier
@return ApiGetAccountTransactionsWithTransfersRequest

Deprecated

func (*AccountsAPIService) GetAccountTransactionsWithTransfersExecute 

func (a *AccountsAPIService) GetAccountTransactionsWithTransfersExecute(r ApiGetAccountTransactionsWithTransfersRequest) (*models.AddressTransactionsWithTransfersListResponse, *http.Response, error)

Execute executes the request 

@return AddressTransactionsWithTransfersListResponse

Deprecated

func (*AccountsAPIService) GetSingleTransactionWithTransfers 

func (a *AccountsAPIService) GetSingleTransactionWithTransfers(ctx context.Context, principal string, txId string) ApiGetSingleTransactionWithTransfersRequest

GetSingleTransactionWithTransfers Get account transaction information for specific transaction

Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param principal Stacks address or a contract identifier
@param txId Transaction id
@return ApiGetSingleTransactionWithTransfersRequest

Deprecated

func (*AccountsAPIService) GetSingleTransactionWithTransfersExecute 

func (a *AccountsAPIService) GetSingleTransactionWithTransfersExecute(r ApiGetSingleTransactionWithTransfersRequest) (*models.AddressTransactionWithTransfers, *http.Response, error)

Execute executes the request 

@return AddressTransactionWithTransfers

Deprecated

type ApiCallReadOnlyFunctionRequest 

type ApiCallReadOnlyFunctionRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiCallReadOnlyFunctionRequest) Execute 

func (r ApiCallReadOnlyFunctionRequest) Execute() (*models.ReadOnlyFunctionSuccessResponse, *http.Response, error)

func (ApiCallReadOnlyFunctionRequest) ReadOnlyFunctionArgs 

func (r ApiCallReadOnlyFunctionRequest) ReadOnlyFunctionArgs(readOnlyFunctionArgs models.ReadOnlyFunctionArgs) ApiCallReadOnlyFunctionRequest

map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.

func (ApiCallReadOnlyFunctionRequest) Tip 

func (r ApiCallReadOnlyFunctionRequest) Tip(tip string) ApiCallReadOnlyFunctionRequest

The Stacks chain tip to query from

type ApiFetchFeeRateRequest 

type ApiFetchFeeRateRequest struct {
	ApiService *FeesAPIService
	// contains filtered or unexported fields
}

func (ApiFetchFeeRateRequest) Execute 

func (r ApiFetchFeeRateRequest) Execute() (*models.FeeRate, *http.Response, error)

func (ApiFetchFeeRateRequest) FeeRateRequest 

func (r ApiFetchFeeRateRequest) FeeRateRequest(feeRateRequest models.FeeRateRequest) ApiFetchFeeRateRequest

type ApiFetchSubdomainsListForNameRequest 

type ApiFetchSubdomainsListForNameRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiFetchSubdomainsListForNameRequest) Execute 

func (r ApiFetchSubdomainsListForNameRequest) Execute() ([]string, *http.Response, error)

type ApiFetchZoneFileRequest 

type ApiFetchZoneFileRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiFetchZoneFileRequest) Execute 

func (r ApiFetchZoneFileRequest) Execute() (*models.BnsFetchFileZoneResponse, *http.Response, error)

type ApiGetAccountAssetsRequest 

type ApiGetAccountAssetsRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountAssetsRequest) Execute 

func (r ApiGetAccountAssetsRequest) Execute() (*models.AddressAssetsListResponse, *http.Response, error)

func (ApiGetAccountAssetsRequest) Limit 

func (r ApiGetAccountAssetsRequest) Limit(limit int32) ApiGetAccountAssetsRequest

max number of account assets to fetch

func (ApiGetAccountAssetsRequest) Offset 

func (r ApiGetAccountAssetsRequest) Offset(offset int32) ApiGetAccountAssetsRequest

index of first account assets to fetch

func (ApiGetAccountAssetsRequest) Unanchored 

func (r ApiGetAccountAssetsRequest) Unanchored(unanchored bool) ApiGetAccountAssetsRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

func (ApiGetAccountAssetsRequest) UntilBlock 

func (r ApiGetAccountAssetsRequest) UntilBlock(untilBlock string) ApiGetAccountAssetsRequest

returned data representing the state at that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.

type ApiGetAccountBalanceRequest 

type ApiGetAccountBalanceRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountBalanceRequest) Execute 

func (r ApiGetAccountBalanceRequest) Execute() (*models.AddressBalanceResponse, *http.Response, error)

func (ApiGetAccountBalanceRequest) Unanchored 

func (r ApiGetAccountBalanceRequest) Unanchored(unanchored bool) ApiGetAccountBalanceRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

func (ApiGetAccountBalanceRequest) UntilBlock 

func (r ApiGetAccountBalanceRequest) UntilBlock(untilBlock string) ApiGetAccountBalanceRequest

returned data representing the state up until that point in time, rather than the current block.

type ApiGetAccountInboundRequest 

type ApiGetAccountInboundRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountInboundRequest) Execute 

func (r ApiGetAccountInboundRequest) Execute() (*models.AddressStxInboundListResponse, *http.Response, error)

func (ApiGetAccountInboundRequest) Height 

func (r ApiGetAccountInboundRequest) Height(height float32) ApiGetAccountInboundRequest

Filter for transfers only at this given block height

func (ApiGetAccountInboundRequest) Limit 

func (r ApiGetAccountInboundRequest) Limit(limit int32) ApiGetAccountInboundRequest

number of items to return

func (ApiGetAccountInboundRequest) Offset 

func (r ApiGetAccountInboundRequest) Offset(offset int32) ApiGetAccountInboundRequest

number of items to skip

func (ApiGetAccountInboundRequest) Unanchored 

func (r ApiGetAccountInboundRequest) Unanchored(unanchored bool) ApiGetAccountInboundRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

func (ApiGetAccountInboundRequest) UntilBlock 

func (r ApiGetAccountInboundRequest) UntilBlock(untilBlock string) ApiGetAccountInboundRequest

returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.

type ApiGetAccountInfoRequest 

type ApiGetAccountInfoRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountInfoRequest) Execute 

func (r ApiGetAccountInfoRequest) Execute() (*models.AccountDataResponse, *http.Response, error)

func (ApiGetAccountInfoRequest) Proof 

func (r ApiGetAccountInfoRequest) Proof(proof int32) ApiGetAccountInfoRequest

Returns object without the proof field if set to 0

func (ApiGetAccountInfoRequest) Tip 

func (r ApiGetAccountInfoRequest) Tip(tip string) ApiGetAccountInfoRequest

The Stacks chain tip to query from

type ApiGetAccountNoncesRequest 

type ApiGetAccountNoncesRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountNoncesRequest) BlockHash 

func (r ApiGetAccountNoncesRequest) BlockHash(blockHash string) ApiGetAccountNoncesRequest

Optionally get the nonce at a given block hash. Note - Use either of the query parameters but not both at a time.

func (ApiGetAccountNoncesRequest) BlockHeight 

func (r ApiGetAccountNoncesRequest) BlockHeight(blockHeight float32) ApiGetAccountNoncesRequest

Optionally get the nonce at a given block height.

func (ApiGetAccountNoncesRequest) Execute 

func (r ApiGetAccountNoncesRequest) Execute() (*models.AddressNonces, *http.Response, error)

type ApiGetAccountStxBalanceRequest 

type ApiGetAccountStxBalanceRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountStxBalanceRequest) Execute 

func (r ApiGetAccountStxBalanceRequest) Execute() (*models.AddressStxBalanceResponse, *http.Response, error)

func (ApiGetAccountStxBalanceRequest) Unanchored 

func (r ApiGetAccountStxBalanceRequest) Unanchored(unanchored bool) ApiGetAccountStxBalanceRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks.

func (ApiGetAccountStxBalanceRequest) UntilBlock 

func (r ApiGetAccountStxBalanceRequest) UntilBlock(untilBlock string) ApiGetAccountStxBalanceRequest

returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.

type ApiGetAccountTransactionsRequest 

type ApiGetAccountTransactionsRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountTransactionsRequest) Execute 

func (r ApiGetAccountTransactionsRequest) Execute() (*models.AddressTransactionsListResponse, *http.Response, error)

func (ApiGetAccountTransactionsRequest) Height 

func (r ApiGetAccountTransactionsRequest) Height(height float32) ApiGetAccountTransactionsRequest

Filter for transactions only at this given block height

func (ApiGetAccountTransactionsRequest) Limit 

func (r ApiGetAccountTransactionsRequest) Limit(limit int32) ApiGetAccountTransactionsRequest

max number of account transactions to fetch

func (ApiGetAccountTransactionsRequest) Offset 

func (r ApiGetAccountTransactionsRequest) Offset(offset int32) ApiGetAccountTransactionsRequest

index of first account transaction to fetch

func (ApiGetAccountTransactionsRequest) Unanchored 

func (r ApiGetAccountTransactionsRequest) Unanchored(unanchored bool) ApiGetAccountTransactionsRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

func (ApiGetAccountTransactionsRequest) UntilBlock 

func (r ApiGetAccountTransactionsRequest) UntilBlock(untilBlock string) ApiGetAccountTransactionsRequest

returned data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.

type ApiGetAccountTransactionsWithTransfersRequest 

type ApiGetAccountTransactionsWithTransfersRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAccountTransactionsWithTransfersRequest) Execute 

func (r ApiGetAccountTransactionsWithTransfersRequest) Execute() (*models.AddressTransactionsWithTransfersListResponse, *http.Response, error)

func (ApiGetAccountTransactionsWithTransfersRequest) Height 

func (r ApiGetAccountTransactionsWithTransfersRequest) Height(height float32) ApiGetAccountTransactionsWithTransfersRequest

Filter for transactions only at this given block height

func (ApiGetAccountTransactionsWithTransfersRequest) Limit 

func (r ApiGetAccountTransactionsWithTransfersRequest) Limit(limit int32) ApiGetAccountTransactionsWithTransfersRequest

max number of account transactions to fetch

func (ApiGetAccountTransactionsWithTransfersRequest) Offset 

func (r ApiGetAccountTransactionsWithTransfersRequest) Offset(offset int32) ApiGetAccountTransactionsWithTransfersRequest

index of first account transaction to fetch

func (ApiGetAccountTransactionsWithTransfersRequest) Unanchored 

func (r ApiGetAccountTransactionsWithTransfersRequest) Unanchored(unanchored bool) ApiGetAccountTransactionsWithTransfersRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

func (ApiGetAccountTransactionsWithTransfersRequest) UntilBlock 

func (r ApiGetAccountTransactionsWithTransfersRequest) UntilBlock(untilBlock string) ApiGetAccountTransactionsWithTransfersRequest

returned data representing the state up until that point in time, rather than the current block.

type ApiGetAddressMempoolTransactionsRequest 

type ApiGetAddressMempoolTransactionsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAddressMempoolTransactionsRequest) Execute 

func (r ApiGetAddressMempoolTransactionsRequest) Execute() (*models.MempoolTransactionListResponse, *http.Response, error)

func (ApiGetAddressMempoolTransactionsRequest) Limit 

func (r ApiGetAddressMempoolTransactionsRequest) Limit(limit int32) ApiGetAddressMempoolTransactionsRequest

max number of transactions to fetch

func (ApiGetAddressMempoolTransactionsRequest) Offset 

func (r ApiGetAddressMempoolTransactionsRequest) Offset(offset int32) ApiGetAddressMempoolTransactionsRequest

index of first transaction to fetch

func (ApiGetAddressMempoolTransactionsRequest) Unanchored 

func (r ApiGetAddressMempoolTransactionsRequest) Unanchored(unanchored bool) ApiGetAddressMempoolTransactionsRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetAddressTransactionEventsRequest 

type ApiGetAddressTransactionEventsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAddressTransactionEventsRequest) Execute 

func (r ApiGetAddressTransactionEventsRequest) Execute() (*models.AddressTransactionEventListResponse, *http.Response, error)

func (ApiGetAddressTransactionEventsRequest) Limit 

func (r ApiGetAddressTransactionEventsRequest) Limit(limit int32) ApiGetAddressTransactionEventsRequest

Number of events to fetch

func (ApiGetAddressTransactionEventsRequest) Offset 

func (r ApiGetAddressTransactionEventsRequest) Offset(offset int32) ApiGetAddressTransactionEventsRequest

Index of first event to fetch

type ApiGetAddressTransactionsRequest 

type ApiGetAddressTransactionsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetAddressTransactionsRequest) Execute 

func (r ApiGetAddressTransactionsRequest) Execute() (*models.AddressTransactionsV2ListResponse, *http.Response, error)

func (ApiGetAddressTransactionsRequest) Limit 

func (r ApiGetAddressTransactionsRequest) Limit(limit int32) ApiGetAddressTransactionsRequest

Number of transactions to fetch

func (ApiGetAddressTransactionsRequest) Offset 

func (r ApiGetAddressTransactionsRequest) Offset(offset int32) ApiGetAddressTransactionsRequest

Index of first transaction to fetch

type ApiGetAllNamesRequest 

type ApiGetAllNamesRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetAllNamesRequest) Execute 

func (r ApiGetAllNamesRequest) Execute() ([]string, *http.Response, error)

func (ApiGetAllNamesRequest) Page 

func (r ApiGetAllNamesRequest) Page(page int32) ApiGetAllNamesRequest

names are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter.

type ApiGetAllNamespacesRequest 

type ApiGetAllNamespacesRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetAllNamespacesRequest) Execute 

func (r ApiGetAllNamespacesRequest) Execute() (*models.BnsGetAllNamespacesResponse, *http.Response, error)

type ApiGetAverageBlockTimesRequest 

type ApiGetAverageBlockTimesRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetAverageBlockTimesRequest) Execute 

func (r ApiGetAverageBlockTimesRequest) Execute() (*models.AverageBlockTimesResponse, *http.Response, error)

type ApiGetBlockByBurnBlockHashRequest 

type ApiGetBlockByBurnBlockHashRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlockByBurnBlockHashRequest) Execute 

func (r ApiGetBlockByBurnBlockHashRequest) Execute() (*models.Block, *http.Response, error)

type ApiGetBlockByBurnBlockHeightRequest 

type ApiGetBlockByBurnBlockHeightRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlockByBurnBlockHeightRequest) Execute 

func (r ApiGetBlockByBurnBlockHeightRequest) Execute() (*models.Block, *http.Response, error)

type ApiGetBlockByHashRequest 

type ApiGetBlockByHashRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlockByHashRequest) Execute 

func (r ApiGetBlockByHashRequest) Execute() (*models.Block, *http.Response, error)

type ApiGetBlockByHeightRequest 

type ApiGetBlockByHeightRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlockByHeightRequest) Execute 

func (r ApiGetBlockByHeightRequest) Execute() (*models.Block, *http.Response, error)

type ApiGetBlockListRequest 

type ApiGetBlockListRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlockListRequest) Execute 

func (r ApiGetBlockListRequest) Execute() (*models.BlockListResponse, *http.Response, error)

func (ApiGetBlockListRequest) Limit 

func (r ApiGetBlockListRequest) Limit(limit int32) ApiGetBlockListRequest

max number of blocks to fetch

func (ApiGetBlockListRequest) Offset 

func (r ApiGetBlockListRequest) Offset(offset int32) ApiGetBlockListRequest

index of first block to fetch

type ApiGetBlockRequest 

type ApiGetBlockRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlockRequest) Execute 

func (r ApiGetBlockRequest) Execute() (*models.NakamotoBlock, *http.Response, error)

type ApiGetBlocksByBurnBlockRequest 

type ApiGetBlocksByBurnBlockRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlocksByBurnBlockRequest) Execute 

func (r ApiGetBlocksByBurnBlockRequest) Execute() (*models.NakamotoBlockListResponse, *http.Response, error)

func (ApiGetBlocksByBurnBlockRequest) Limit 

func (r ApiGetBlocksByBurnBlockRequest) Limit(limit int32) ApiGetBlocksByBurnBlockRequest

max number of blocks to fetch

func (ApiGetBlocksByBurnBlockRequest) Offset 

func (r ApiGetBlocksByBurnBlockRequest) Offset(offset int32) ApiGetBlocksByBurnBlockRequest

index of first burn block to fetch

type ApiGetBlocksRequest 

type ApiGetBlocksRequest struct {
	ApiService *BlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBlocksRequest) Execute 

func (r ApiGetBlocksRequest) Execute() (*models.NakamotoBlockListResponse, *http.Response, error)

func (ApiGetBlocksRequest) Limit 

func (r ApiGetBlocksRequest) Limit(limit int32) ApiGetBlocksRequest

max number of blocks to fetch

func (ApiGetBlocksRequest) Offset 

func (r ApiGetBlocksRequest) Offset(offset int32) ApiGetBlocksRequest

index of first burn block to fetch

type ApiGetBurnBlockRequest 

type ApiGetBurnBlockRequest struct {
	ApiService *BurnBlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnBlockRequest) Execute 

func (r ApiGetBurnBlockRequest) Execute() (*models.BurnBlock, *http.Response, error)

type ApiGetBurnBlocksRequest 

type ApiGetBurnBlocksRequest struct {
	ApiService *BurnBlocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnBlocksRequest) Execute 

func (r ApiGetBurnBlocksRequest) Execute() (*models.BurnBlockListResponse, *http.Response, error)

func (ApiGetBurnBlocksRequest) Limit 

func (r ApiGetBurnBlocksRequest) Limit(limit int32) ApiGetBurnBlocksRequest

max number of burn blocks to fetch

func (ApiGetBurnBlocksRequest) Offset 

func (r ApiGetBurnBlocksRequest) Offset(offset int32) ApiGetBurnBlocksRequest

index of first burn block to fetch

type ApiGetBurnchainRewardListByAddressRequest 

type ApiGetBurnchainRewardListByAddressRequest struct {
	ApiService *StackingRewardsAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnchainRewardListByAddressRequest) Execute 

func (r ApiGetBurnchainRewardListByAddressRequest) Execute() (*models.BurnchainRewardListResponse, *http.Response, error)

func (ApiGetBurnchainRewardListByAddressRequest) Limit 

func (r ApiGetBurnchainRewardListByAddressRequest) Limit(limit int32) ApiGetBurnchainRewardListByAddressRequest

max number of rewards to fetch

func (ApiGetBurnchainRewardListByAddressRequest) Offset 

func (r ApiGetBurnchainRewardListByAddressRequest) Offset(offset int32) ApiGetBurnchainRewardListByAddressRequest

index of first rewards to fetch

type ApiGetBurnchainRewardListRequest 

type ApiGetBurnchainRewardListRequest struct {
	ApiService *StackingRewardsAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnchainRewardListRequest) Execute 

func (r ApiGetBurnchainRewardListRequest) Execute() (*models.BurnchainRewardListResponse, *http.Response, error)

func (ApiGetBurnchainRewardListRequest) Limit 

func (r ApiGetBurnchainRewardListRequest) Limit(limit int32) ApiGetBurnchainRewardListRequest

max number of rewards to fetch

func (ApiGetBurnchainRewardListRequest) Offset 

func (r ApiGetBurnchainRewardListRequest) Offset(offset int32) ApiGetBurnchainRewardListRequest

index of first rewards to fetch

type ApiGetBurnchainRewardSlotHoldersByAddressRequest 

type ApiGetBurnchainRewardSlotHoldersByAddressRequest struct {
	ApiService *StackingRewardsAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnchainRewardSlotHoldersByAddressRequest) Execute 

func (r ApiGetBurnchainRewardSlotHoldersByAddressRequest) Execute() (*models.BurnchainRewardSlotHolderListResponse, *http.Response, error)

func (ApiGetBurnchainRewardSlotHoldersByAddressRequest) Limit 

func (r ApiGetBurnchainRewardSlotHoldersByAddressRequest) Limit(limit int32) ApiGetBurnchainRewardSlotHoldersByAddressRequest

max number of items to fetch

func (ApiGetBurnchainRewardSlotHoldersByAddressRequest) Offset 

func (r ApiGetBurnchainRewardSlotHoldersByAddressRequest) Offset(offset int32) ApiGetBurnchainRewardSlotHoldersByAddressRequest

index of the first items to fetch

type ApiGetBurnchainRewardSlotHoldersRequest 

type ApiGetBurnchainRewardSlotHoldersRequest struct {
	ApiService *StackingRewardsAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnchainRewardSlotHoldersRequest) Execute 

func (r ApiGetBurnchainRewardSlotHoldersRequest) Execute() (*models.BurnchainRewardSlotHolderListResponse, *http.Response, error)

func (ApiGetBurnchainRewardSlotHoldersRequest) Limit 

func (r ApiGetBurnchainRewardSlotHoldersRequest) Limit(limit int32) ApiGetBurnchainRewardSlotHoldersRequest

max number of items to fetch

func (ApiGetBurnchainRewardSlotHoldersRequest) Offset 

func (r ApiGetBurnchainRewardSlotHoldersRequest) Offset(offset int32) ApiGetBurnchainRewardSlotHoldersRequest

index of the first items to fetch

type ApiGetBurnchainRewardsTotalByAddressRequest 

type ApiGetBurnchainRewardsTotalByAddressRequest struct {
	ApiService *StackingRewardsAPIService
	// contains filtered or unexported fields
}

func (ApiGetBurnchainRewardsTotalByAddressRequest) Execute 

func (r ApiGetBurnchainRewardsTotalByAddressRequest) Execute() (*models.BurnchainRewardsTotal, *http.Response, error)

type ApiGetContractByIdRequest 

type ApiGetContractByIdRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetContractByIdRequest) Execute 

func (r ApiGetContractByIdRequest) Execute() (*models.SmartContract, *http.Response, error)

func (ApiGetContractByIdRequest) Unanchored 

func (r ApiGetContractByIdRequest) Unanchored(unanchored bool) ApiGetContractByIdRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetContractDataMapEntryRequest 

type ApiGetContractDataMapEntryRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetContractDataMapEntryRequest) Execute 

func (r ApiGetContractDataMapEntryRequest) Execute() (*models.MapEntryResponse, *http.Response, error)

func (ApiGetContractDataMapEntryRequest) Key 

func (r ApiGetContractDataMapEntryRequest) Key(key string) ApiGetContractDataMapEntryRequest

Hex string serialization of the lookup key (which should be a Clarity value)

func (ApiGetContractDataMapEntryRequest) Proof 

func (r ApiGetContractDataMapEntryRequest) Proof(proof int32) ApiGetContractDataMapEntryRequest

Returns object without the proof field when set to 0

func (ApiGetContractDataMapEntryRequest) Tip 

func (r ApiGetContractDataMapEntryRequest) Tip(tip string) ApiGetContractDataMapEntryRequest

The Stacks chain tip to query from

type ApiGetContractEventsByIdRequest 

type ApiGetContractEventsByIdRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetContractEventsByIdRequest) Execute 

func (r ApiGetContractEventsByIdRequest) Execute() (*models.TransactionEvent, *http.Response, error)

func (ApiGetContractEventsByIdRequest) Limit 

func (r ApiGetContractEventsByIdRequest) Limit(limit int32) ApiGetContractEventsByIdRequest

max number of contract events to fetch

func (ApiGetContractEventsByIdRequest) Offset 

func (r ApiGetContractEventsByIdRequest) Offset(offset int32) ApiGetContractEventsByIdRequest

index of first contract event to fetch

func (ApiGetContractEventsByIdRequest) Unanchored 

func (r ApiGetContractEventsByIdRequest) Unanchored(unanchored bool) ApiGetContractEventsByIdRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetContractInterfaceRequest 

type ApiGetContractInterfaceRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetContractInterfaceRequest) Execute 

func (r ApiGetContractInterfaceRequest) Execute() (*models.ContractInterfaceResponse, *http.Response, error)

func (ApiGetContractInterfaceRequest) Tip 

func (r ApiGetContractInterfaceRequest) Tip(tip string) ApiGetContractInterfaceRequest

The Stacks chain tip to query from

type ApiGetContractSourceRequest 

type ApiGetContractSourceRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetContractSourceRequest) Execute 

func (r ApiGetContractSourceRequest) Execute() (*models.ContractSourceResponse, *http.Response, error)

func (ApiGetContractSourceRequest) Proof 

func (r ApiGetContractSourceRequest) Proof(proof int32) ApiGetContractSourceRequest

Returns object without the proof field if set to 0

func (ApiGetContractSourceRequest) Tip 

func (r ApiGetContractSourceRequest) Tip(tip string) ApiGetContractSourceRequest

The Stacks chain tip to query from

type ApiGetContractsByTraitRequest 

type ApiGetContractsByTraitRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetContractsByTraitRequest) Execute 

func (r ApiGetContractsByTraitRequest) Execute() (*models.ContractListResponse, *http.Response, error)

func (ApiGetContractsByTraitRequest) Limit 

func (r ApiGetContractsByTraitRequest) Limit(limit int32) ApiGetContractsByTraitRequest

max number of contracts fetch

func (ApiGetContractsByTraitRequest) Offset 

func (r ApiGetContractsByTraitRequest) Offset(offset int32) ApiGetContractsByTraitRequest

index of first contract event to fetch

func (ApiGetContractsByTraitRequest) TraitAbi 

func (r ApiGetContractsByTraitRequest) TraitAbi(traitAbi string) ApiGetContractsByTraitRequest

JSON abi of the trait.

type ApiGetCoreApiInfoRequest 

type ApiGetCoreApiInfoRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetCoreApiInfoRequest) Execute 

func (r ApiGetCoreApiInfoRequest) Execute() (*models.CoreNodeInfoResponse, *http.Response, error)

type ApiGetDroppedMempoolTransactionListRequest 

type ApiGetDroppedMempoolTransactionListRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetDroppedMempoolTransactionListRequest) Execute 

func (r ApiGetDroppedMempoolTransactionListRequest) Execute() (*models.MempoolTransactionListResponse, *http.Response, error)

func (ApiGetDroppedMempoolTransactionListRequest) Limit 

func (r ApiGetDroppedMempoolTransactionListRequest) Limit(limit int32) ApiGetDroppedMempoolTransactionListRequest

max number of mempool transactions to fetch

func (ApiGetDroppedMempoolTransactionListRequest) Offset 

func (r ApiGetDroppedMempoolTransactionListRequest) Offset(offset int32) ApiGetDroppedMempoolTransactionListRequest

index of first mempool transaction to fetch

type ApiGetFeeTransferRequest 

type ApiGetFeeTransferRequest struct {
	ApiService *FeesAPIService
	// contains filtered or unexported fields
}

func (ApiGetFeeTransferRequest) Execute 

func (r ApiGetFeeTransferRequest) Execute() (map[string]interface{}, *http.Response, error)

type ApiGetFilteredEventsRequest 

type ApiGetFilteredEventsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetFilteredEventsRequest) Address 

func (r ApiGetFilteredEventsRequest) Address(address string) ApiGetFilteredEventsRequest

Stacks address or a Contract identifier

func (ApiGetFilteredEventsRequest) Execute 

func (r ApiGetFilteredEventsRequest) Execute() (*models.TransactionEventsResponse, *http.Response, error)

func (ApiGetFilteredEventsRequest) Limit 

func (r ApiGetFilteredEventsRequest) Limit(limit int32) ApiGetFilteredEventsRequest

number of items to return

func (ApiGetFilteredEventsRequest) Offset 

func (r ApiGetFilteredEventsRequest) Offset(offset int32) ApiGetFilteredEventsRequest

number of items to skip

func (ApiGetFilteredEventsRequest) TxId 

func (r ApiGetFilteredEventsRequest) TxId(txId string) ApiGetFilteredEventsRequest

Hash of transaction

func (ApiGetFilteredEventsRequest) Type_ 

func (r ApiGetFilteredEventsRequest) Type_(type_ []string) ApiGetFilteredEventsRequest

Filter the events on event type

type ApiGetHistoricalZoneFileRequest 

type ApiGetHistoricalZoneFileRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetHistoricalZoneFileRequest) Execute 

func (r ApiGetHistoricalZoneFileRequest) Execute() (*models.BnsFetchHistoricalZoneFileResponse, *http.Response, error)

type ApiGetMempoolFeePrioritiesRequest 

type ApiGetMempoolFeePrioritiesRequest struct {
	ApiService *MempoolAPIService
	// contains filtered or unexported fields
}

func (ApiGetMempoolFeePrioritiesRequest) Execute 

func (r ApiGetMempoolFeePrioritiesRequest) Execute() (*models.MempoolFeePriorities, *http.Response, error)

type ApiGetMempoolTransactionListRequest 

type ApiGetMempoolTransactionListRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetMempoolTransactionListRequest) Address 

func (r ApiGetMempoolTransactionListRequest) Address(address string) ApiGetMempoolTransactionListRequest

Filter to only return transactions with this address as the sender or recipient (recipient only applicable for STX transfer tx types).

func (ApiGetMempoolTransactionListRequest) Execute 

func (r ApiGetMempoolTransactionListRequest) Execute() (*models.MempoolTransactionListResponse, *http.Response, error)

func (ApiGetMempoolTransactionListRequest) Limit 

func (r ApiGetMempoolTransactionListRequest) Limit(limit int32) ApiGetMempoolTransactionListRequest

max number of mempool transactions to fetch

func (ApiGetMempoolTransactionListRequest) Offset 

func (r ApiGetMempoolTransactionListRequest) Offset(offset int32) ApiGetMempoolTransactionListRequest

index of first mempool transaction to fetch

func (ApiGetMempoolTransactionListRequest) Order 

func (r ApiGetMempoolTransactionListRequest) Order(order string) ApiGetMempoolTransactionListRequest

Option to sort results in ascending or descending order.

func (ApiGetMempoolTransactionListRequest) OrderBy 

func (r ApiGetMempoolTransactionListRequest) OrderBy(orderBy string) ApiGetMempoolTransactionListRequest

Option to sort results by transaction age, size, or fee rate.

func (ApiGetMempoolTransactionListRequest) RecipientAddress 

func (r ApiGetMempoolTransactionListRequest) RecipientAddress(recipientAddress string) ApiGetMempoolTransactionListRequest

Filter to only return transactions with this recipient address (only applicable for STX transfer tx types).

func (ApiGetMempoolTransactionListRequest) SenderAddress 

func (r ApiGetMempoolTransactionListRequest) SenderAddress(senderAddress string) ApiGetMempoolTransactionListRequest

Filter to only return transactions with this sender address.

func (ApiGetMempoolTransactionListRequest) Unanchored 

func (r ApiGetMempoolTransactionListRequest) Unanchored(unanchored bool) ApiGetMempoolTransactionListRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetMempoolTransactionStatsRequest 

type ApiGetMempoolTransactionStatsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetMempoolTransactionStatsRequest) Execute 

func (r ApiGetMempoolTransactionStatsRequest) Execute() (*models.MempoolTransactionStatsResponse, *http.Response, error)

type ApiGetMicroblockByHashRequest 

type ApiGetMicroblockByHashRequest struct {
	ApiService *MicroblocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetMicroblockByHashRequest) Execute 

func (r ApiGetMicroblockByHashRequest) Execute() (*models.Microblock, *http.Response, error)

type ApiGetMicroblockListRequest 

type ApiGetMicroblockListRequest struct {
	ApiService *MicroblocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetMicroblockListRequest) Execute 

func (r ApiGetMicroblockListRequest) Execute() (*models.MicroblockListResponse, *http.Response, error)

func (ApiGetMicroblockListRequest) Limit 

func (r ApiGetMicroblockListRequest) Limit(limit int32) ApiGetMicroblockListRequest

Max number of microblocks to fetch

func (ApiGetMicroblockListRequest) Offset 

func (r ApiGetMicroblockListRequest) Offset(offset int32) ApiGetMicroblockListRequest

Index of the first microblock to fetch

type ApiGetNameInfoRequest 

type ApiGetNameInfoRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetNameInfoRequest) Execute 

func (r ApiGetNameInfoRequest) Execute() (*models.BnsGetNameInfoResponse, *http.Response, error)

type ApiGetNamePriceRequest 

type ApiGetNamePriceRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetNamePriceRequest) Execute 

func (r ApiGetNamePriceRequest) Execute() (*models.BnsGetNamePriceResponse, *http.Response, error)

type ApiGetNamesOwnedByAddressRequest 

type ApiGetNamesOwnedByAddressRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetNamesOwnedByAddressRequest) Execute 

func (r ApiGetNamesOwnedByAddressRequest) Execute() (*models.BnsNamesOwnByAddressResponse, *http.Response, error)

type ApiGetNamespaceNamesRequest 

type ApiGetNamespaceNamesRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetNamespaceNamesRequest) Execute 

func (r ApiGetNamespaceNamesRequest) Execute() ([]string, *http.Response, error)

func (ApiGetNamespaceNamesRequest) Page 

func (r ApiGetNamespaceNamesRequest) Page(page int32) ApiGetNamespaceNamesRequest

namespace values are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter.

type ApiGetNamespacePriceRequest 

type ApiGetNamespacePriceRequest struct {
	ApiService *NamesAPIService
	// contains filtered or unexported fields
}

func (ApiGetNamespacePriceRequest) Execute 

func (r ApiGetNamespacePriceRequest) Execute() (*models.BnsGetNamespacePriceResponse, *http.Response, error)

type ApiGetNetworkBlockTimeByNetworkRequest 

type ApiGetNetworkBlockTimeByNetworkRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetNetworkBlockTimeByNetworkRequest) Execute 

func (r ApiGetNetworkBlockTimeByNetworkRequest) Execute() (*models.TargetBlockTime, *http.Response, error)

type ApiGetNetworkBlockTimesRequest 

type ApiGetNetworkBlockTimesRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetNetworkBlockTimesRequest) Execute 

func (r ApiGetNetworkBlockTimesRequest) Execute() (*models.NetworkBlockTimesResponse, *http.Response, error)

type ApiGetNftHistoryRequest 

type ApiGetNftHistoryRequest struct {
	ApiService *NonFungibleTokensAPIService
	// contains filtered or unexported fields
}

func (ApiGetNftHistoryRequest) AssetIdentifier 

func (r ApiGetNftHistoryRequest) AssetIdentifier(assetIdentifier string) ApiGetNftHistoryRequest

token asset class identifier

func (ApiGetNftHistoryRequest) Execute 

func (r ApiGetNftHistoryRequest) Execute() (*models.NonFungibleTokenHistoryEventList, *http.Response, error)

func (ApiGetNftHistoryRequest) Limit 

func (r ApiGetNftHistoryRequest) Limit(limit int32) ApiGetNftHistoryRequest

max number of events to fetch

func (ApiGetNftHistoryRequest) Offset 

func (r ApiGetNftHistoryRequest) Offset(offset int32) ApiGetNftHistoryRequest

index of first event to fetch

func (ApiGetNftHistoryRequest) TxMetadata 

func (r ApiGetNftHistoryRequest) TxMetadata(txMetadata bool) ApiGetNftHistoryRequest

whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times.

func (ApiGetNftHistoryRequest) Unanchored 

func (r ApiGetNftHistoryRequest) Unanchored(unanchored bool) ApiGetNftHistoryRequest

whether or not to include events from unconfirmed transactions

func (ApiGetNftHistoryRequest) Value 

func (r ApiGetNftHistoryRequest) Value(value string) ApiGetNftHistoryRequest

hex representation of the token's unique value

type ApiGetNftHoldingsRequest 

type ApiGetNftHoldingsRequest struct {
	ApiService *NonFungibleTokensAPIService
	// contains filtered or unexported fields
}

func (ApiGetNftHoldingsRequest) AssetIdentifiers 

func (r ApiGetNftHoldingsRequest) AssetIdentifiers(assetIdentifiers []string) ApiGetNftHoldingsRequest

identifiers of the token asset classes to filter for

func (ApiGetNftHoldingsRequest) Execute 

func (r ApiGetNftHoldingsRequest) Execute() (*models.NonFungibleTokenHoldingsList, *http.Response, error)

func (ApiGetNftHoldingsRequest) Limit 

func (r ApiGetNftHoldingsRequest) Limit(limit int32) ApiGetNftHoldingsRequest

max number of tokens to fetch

func (ApiGetNftHoldingsRequest) Offset 

func (r ApiGetNftHoldingsRequest) Offset(offset int32) ApiGetNftHoldingsRequest

index of first tokens to fetch

func (ApiGetNftHoldingsRequest) Principal 

func (r ApiGetNftHoldingsRequest) Principal(principal string) ApiGetNftHoldingsRequest

token owner's STX address or Smart Contract ID

func (ApiGetNftHoldingsRequest) TxMetadata 

func (r ApiGetNftHoldingsRequest) TxMetadata(txMetadata bool) ApiGetNftHoldingsRequest

whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times.

func (ApiGetNftHoldingsRequest) Unanchored 

func (r ApiGetNftHoldingsRequest) Unanchored(unanchored bool) ApiGetNftHoldingsRequest

whether or not to include tokens from unconfirmed transactions

type ApiGetNftMintsRequest 

type ApiGetNftMintsRequest struct {
	ApiService *NonFungibleTokensAPIService
	// contains filtered or unexported fields
}

func (ApiGetNftMintsRequest) AssetIdentifier 

func (r ApiGetNftMintsRequest) AssetIdentifier(assetIdentifier string) ApiGetNftMintsRequest

token asset class identifier

func (ApiGetNftMintsRequest) Execute 

func (r ApiGetNftMintsRequest) Execute() (*models.NonFungibleTokenMintList, *http.Response, error)

func (ApiGetNftMintsRequest) Limit 

func (r ApiGetNftMintsRequest) Limit(limit int32) ApiGetNftMintsRequest

max number of events to fetch

func (ApiGetNftMintsRequest) Offset 

func (r ApiGetNftMintsRequest) Offset(offset int32) ApiGetNftMintsRequest

index of first event to fetch

func (ApiGetNftMintsRequest) TxMetadata 

func (r ApiGetNftMintsRequest) TxMetadata(txMetadata bool) ApiGetNftMintsRequest

whether or not to include the complete transaction metadata instead of just `tx_id`. Enabling this option can affect performance and response times.

func (ApiGetNftMintsRequest) Unanchored 

func (r ApiGetNftMintsRequest) Unanchored(unanchored bool) ApiGetNftMintsRequest

whether or not to include events from unconfirmed transactions

type ApiGetPoolDelegationsRequest 

type ApiGetPoolDelegationsRequest struct {
	ApiService *StackingAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoolDelegationsRequest) AfterBlock 

func (r ApiGetPoolDelegationsRequest) AfterBlock(afterBlock int32) ApiGetPoolDelegationsRequest

If specified, only delegation events after the given block will be included

func (ApiGetPoolDelegationsRequest) Execute 

func (r ApiGetPoolDelegationsRequest) Execute() (*models.PoolDelegationsResponse, *http.Response, error)

func (ApiGetPoolDelegationsRequest) Limit 

func (r ApiGetPoolDelegationsRequest) Limit(limit int32) ApiGetPoolDelegationsRequest

number of items to return

func (ApiGetPoolDelegationsRequest) Offset 

func (r ApiGetPoolDelegationsRequest) Offset(offset int32) ApiGetPoolDelegationsRequest

number of items to skip

func (ApiGetPoolDelegationsRequest) Unanchored 

func (r ApiGetPoolDelegationsRequest) Unanchored(unanchored bool) ApiGetPoolDelegationsRequest

whether or not to include Stackers from unconfirmed transactions

type ApiGetPoxCycleRequest 

type ApiGetPoxCycleRequest struct {
	ApiService *ProofOfTransferAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoxCycleRequest) Execute 

func (r ApiGetPoxCycleRequest) Execute() (*models.PoxCycle, *http.Response, error)

type ApiGetPoxCycleSignerRequest 

type ApiGetPoxCycleSignerRequest struct {
	ApiService *ProofOfTransferAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoxCycleSignerRequest) Execute 

func (r ApiGetPoxCycleSignerRequest) Execute() (*models.PoxSigner, *http.Response, error)

type ApiGetPoxCycleSignerStackersRequest 

type ApiGetPoxCycleSignerStackersRequest struct {
	ApiService *ProofOfTransferAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoxCycleSignerStackersRequest) Execute 

func (r ApiGetPoxCycleSignerStackersRequest) Execute() (*models.PoxCycleSignerStackersListResponse, *http.Response, error)

type ApiGetPoxCycleSignersRequest 

type ApiGetPoxCycleSignersRequest struct {
	ApiService *ProofOfTransferAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoxCycleSignersRequest) Execute 

func (r ApiGetPoxCycleSignersRequest) Execute() (*models.PoxCycleSignersListResponse, *http.Response, error)

type ApiGetPoxCyclesRequest 

type ApiGetPoxCyclesRequest struct {
	ApiService *ProofOfTransferAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoxCyclesRequest) Execute 

func (r ApiGetPoxCyclesRequest) Execute() (*models.PoxCycleListResponse, *http.Response, error)

func (ApiGetPoxCyclesRequest) Limit 

func (r ApiGetPoxCyclesRequest) Limit(limit int32) ApiGetPoxCyclesRequest

max number of cycles to fetch

func (ApiGetPoxCyclesRequest) Offset 

func (r ApiGetPoxCyclesRequest) Offset(offset int32) ApiGetPoxCyclesRequest

index of first cycle to fetch

type ApiGetPoxInfoRequest 

type ApiGetPoxInfoRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetPoxInfoRequest) Execute 

func (r ApiGetPoxInfoRequest) Execute() (*models.CoreNodePoxResponse, *http.Response, error)

type ApiGetRawTransactionByIdRequest 

type ApiGetRawTransactionByIdRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetRawTransactionByIdRequest) Execute 

func (r ApiGetRawTransactionByIdRequest) Execute() (*models.GetRawTransactionResult, *http.Response, error)

type ApiGetSingleTransactionWithTransfersRequest 

type ApiGetSingleTransactionWithTransfersRequest struct {
	ApiService *AccountsAPIService
	// contains filtered or unexported fields
}

func (ApiGetSingleTransactionWithTransfersRequest) Execute 

func (r ApiGetSingleTransactionWithTransfersRequest) Execute() (*models.AddressTransactionWithTransfers, *http.Response, error)

type ApiGetSmartContractsStatusRequest 

type ApiGetSmartContractsStatusRequest struct {
	ApiService *SmartContractsAPIService
	// contains filtered or unexported fields
}

func (ApiGetSmartContractsStatusRequest) ContractId 

func (r ApiGetSmartContractsStatusRequest) ContractId(contractId []string) ApiGetSmartContractsStatusRequest

contract ids to fetch status for

func (ApiGetSmartContractsStatusRequest) Execute 

func (r ApiGetSmartContractsStatusRequest) Execute() (*map[string]models.SmartContractsStatusResponse, *http.Response, error)

type ApiGetStatusRequest 

type ApiGetStatusRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetStatusRequest) Execute 

func (r ApiGetStatusRequest) Execute() (*models.ServerStatusResponse, *http.Response, error)

type ApiGetStxSupplyCirculatingPlainRequest 

type ApiGetStxSupplyCirculatingPlainRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetStxSupplyCirculatingPlainRequest) Execute 

func (r ApiGetStxSupplyCirculatingPlainRequest) Execute() (string, *http.Response, error)

type ApiGetStxSupplyRequest 

type ApiGetStxSupplyRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetStxSupplyRequest) Execute 

func (r ApiGetStxSupplyRequest) Execute() (*models.GetStxSupplyResponse, *http.Response, error)

func (ApiGetStxSupplyRequest) Height 

func (r ApiGetStxSupplyRequest) Height(height float32) ApiGetStxSupplyRequest

Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the `block height` is referred to the stacks blockchain.

type ApiGetStxSupplyTotalSupplyPlainRequest 

type ApiGetStxSupplyTotalSupplyPlainRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetStxSupplyTotalSupplyPlainRequest) Execute 

func (r ApiGetStxSupplyTotalSupplyPlainRequest) Execute() (string, *http.Response, error)

type ApiGetTotalStxSupplyLegacyFormatRequest 

type ApiGetTotalStxSupplyLegacyFormatRequest struct {
	ApiService *InfoAPIService
	// contains filtered or unexported fields
}

func (ApiGetTotalStxSupplyLegacyFormatRequest) Execute 

func (r ApiGetTotalStxSupplyLegacyFormatRequest) Execute() (*models.GetStxSupplyLegacyFormatResponse, *http.Response, error)

func (ApiGetTotalStxSupplyLegacyFormatRequest) Height 

func (r ApiGetTotalStxSupplyLegacyFormatRequest) Height(height float32) ApiGetTotalStxSupplyLegacyFormatRequest

Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.

type ApiGetTransactionByIdRequest 

type ApiGetTransactionByIdRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetTransactionByIdRequest) EventLimit 

func (r ApiGetTransactionByIdRequest) EventLimit(eventLimit int32) ApiGetTransactionByIdRequest

The numbers of events to return

func (ApiGetTransactionByIdRequest) EventOffset 

func (r ApiGetTransactionByIdRequest) EventOffset(eventOffset int32) ApiGetTransactionByIdRequest

The number of events to skip

func (ApiGetTransactionByIdRequest) Execute 

func (r ApiGetTransactionByIdRequest) Execute() (*models.Transaction, *http.Response, error)

func (ApiGetTransactionByIdRequest) Unanchored 

func (r ApiGetTransactionByIdRequest) Unanchored(unanchored bool) ApiGetTransactionByIdRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetTransactionListRequest 

type ApiGetTransactionListRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetTransactionListRequest) ContractId 

func (r ApiGetTransactionListRequest) ContractId(contractId string) ApiGetTransactionListRequest

Filter by contract call transactions involving this contract ID

func (ApiGetTransactionListRequest) EndTime 

func (r ApiGetTransactionListRequest) EndTime(endTime int32) ApiGetTransactionListRequest

Filter by transactions before this timestamp (unix timestamp in seconds)

func (ApiGetTransactionListRequest) Execute 

func (r ApiGetTransactionListRequest) Execute() (*models.TransactionResults, *http.Response, error)

func (ApiGetTransactionListRequest) FromAddress 

func (r ApiGetTransactionListRequest) FromAddress(fromAddress string) ApiGetTransactionListRequest

Option to filter results by sender address

func (ApiGetTransactionListRequest) FunctionName 

func (r ApiGetTransactionListRequest) FunctionName(functionName string) ApiGetTransactionListRequest

Filter by contract call transactions involving this function name

func (ApiGetTransactionListRequest) Limit 

func (r ApiGetTransactionListRequest) Limit(limit int32) ApiGetTransactionListRequest

max number of transactions to fetch

func (ApiGetTransactionListRequest) Nonce 

func (r ApiGetTransactionListRequest) Nonce(nonce int32) ApiGetTransactionListRequest

Filter by transactions with this nonce

func (ApiGetTransactionListRequest) Offset 

func (r ApiGetTransactionListRequest) Offset(offset int32) ApiGetTransactionListRequest

index of first transaction to fetch

func (ApiGetTransactionListRequest) Order 

func (r ApiGetTransactionListRequest) Order(order string) ApiGetTransactionListRequest

Option to sort results in ascending or descending order

func (ApiGetTransactionListRequest) SortBy 

func (r ApiGetTransactionListRequest) SortBy(sortBy string) ApiGetTransactionListRequest

Option to sort results by block height, timestamp, or fee

func (ApiGetTransactionListRequest) StartTime 

func (r ApiGetTransactionListRequest) StartTime(startTime int32) ApiGetTransactionListRequest

Filter by transactions after this timestamp (unix timestamp in seconds)

func (ApiGetTransactionListRequest) ToAddress 

func (r ApiGetTransactionListRequest) ToAddress(toAddress string) ApiGetTransactionListRequest

Option to filter results by recipient address

func (ApiGetTransactionListRequest) Type_ 

func (r ApiGetTransactionListRequest) Type_(type_ []string) ApiGetTransactionListRequest

Filter by transaction type

func (ApiGetTransactionListRequest) Unanchored 

func (r ApiGetTransactionListRequest) Unanchored(unanchored bool) ApiGetTransactionListRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetTransactionsByBlockHashRequest 

type ApiGetTransactionsByBlockHashRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetTransactionsByBlockHashRequest) Execute 

func (r ApiGetTransactionsByBlockHashRequest) Execute() (*models.TransactionResults, *http.Response, error)

func (ApiGetTransactionsByBlockHashRequest) Limit 

func (r ApiGetTransactionsByBlockHashRequest) Limit(limit int32) ApiGetTransactionsByBlockHashRequest

max number of transactions to fetch

func (ApiGetTransactionsByBlockHashRequest) Offset 

func (r ApiGetTransactionsByBlockHashRequest) Offset(offset int32) ApiGetTransactionsByBlockHashRequest

index of first transaction to fetch

type ApiGetTransactionsByBlockHeightRequest 

type ApiGetTransactionsByBlockHeightRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetTransactionsByBlockHeightRequest) Execute 

func (r ApiGetTransactionsByBlockHeightRequest) Execute() (*models.TransactionResults, *http.Response, error)

func (ApiGetTransactionsByBlockHeightRequest) Limit 

func (r ApiGetTransactionsByBlockHeightRequest) Limit(limit int32) ApiGetTransactionsByBlockHeightRequest

max number of transactions to fetch

func (ApiGetTransactionsByBlockHeightRequest) Offset 

func (r ApiGetTransactionsByBlockHeightRequest) Offset(offset int32) ApiGetTransactionsByBlockHeightRequest

index of first transaction to fetch

func (ApiGetTransactionsByBlockHeightRequest) Unanchored 

func (r ApiGetTransactionsByBlockHeightRequest) Unanchored(unanchored bool) ApiGetTransactionsByBlockHeightRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetTransactionsByBlockRequest 

type ApiGetTransactionsByBlockRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetTransactionsByBlockRequest) Execute 

func (r ApiGetTransactionsByBlockRequest) Execute() (*models.TransactionResults, *http.Response, error)

type ApiGetTxListDetailsRequest 

type ApiGetTxListDetailsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiGetTxListDetailsRequest) EventLimit 

func (r ApiGetTxListDetailsRequest) EventLimit(eventLimit int32) ApiGetTxListDetailsRequest

The numbers of events to return

func (ApiGetTxListDetailsRequest) EventOffset 

func (r ApiGetTxListDetailsRequest) EventOffset(eventOffset int32) ApiGetTxListDetailsRequest

The number of events to skip

func (ApiGetTxListDetailsRequest) Execute 

func (r ApiGetTxListDetailsRequest) Execute() (*map[string]models.TransactionList, *http.Response, error)

func (ApiGetTxListDetailsRequest) TxId 

func (r ApiGetTxListDetailsRequest) TxId(txId []string) ApiGetTxListDetailsRequest

Array of transaction ids

func (ApiGetTxListDetailsRequest) Unanchored 

func (r ApiGetTxListDetailsRequest) Unanchored(unanchored bool) ApiGetTxListDetailsRequest

Include transaction data from unanchored (i.e. unconfirmed) microblocks

type ApiGetUnanchoredTxsRequest 

type ApiGetUnanchoredTxsRequest struct {
	ApiService *MicroblocksAPIService
	// contains filtered or unexported fields
}

func (ApiGetUnanchoredTxsRequest) Execute 

func (r ApiGetUnanchoredTxsRequest) Execute() (*models.UnanchoredTransactionListResponse, *http.Response, error)

type ApiPostCoreNodeTransactionsRequest 

type ApiPostCoreNodeTransactionsRequest struct {
	ApiService *TransactionsAPIService
	// contains filtered or unexported fields
}

func (ApiPostCoreNodeTransactionsRequest) Body 

func (r ApiPostCoreNodeTransactionsRequest) Body(body *os.File) ApiPostCoreNodeTransactionsRequest

func (ApiPostCoreNodeTransactionsRequest) Execute 

func (r ApiPostCoreNodeTransactionsRequest) Execute() (string, *http.Response, error)

type ApiPostFeeTransactionRequest 

type ApiPostFeeTransactionRequest struct {
	ApiService *FeesAPIService
	// contains filtered or unexported fields
}

func (ApiPostFeeTransactionRequest) Execute 

func (r ApiPostFeeTransactionRequest) Execute() (*models.TransactionFeeEstimateResponse, *http.Response, error)

func (ApiPostFeeTransactionRequest) TransactionFeeEstimateRequest 

func (r ApiPostFeeTransactionRequest) TransactionFeeEstimateRequest(transactionFeeEstimateRequest models.TransactionFeeEstimateRequest) ApiPostFeeTransactionRequest

type ApiRosettaAccountBalanceRequest 

type ApiRosettaAccountBalanceRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaAccountBalanceRequest) Execute 

func (r ApiRosettaAccountBalanceRequest) Execute() (*models.RosettaAccountBalanceResponse, *http.Response, error)

func (ApiRosettaAccountBalanceRequest) RosettaAccountBalanceRequest 

func (r ApiRosettaAccountBalanceRequest) RosettaAccountBalanceRequest(rosettaAccountBalanceRequest models.RosettaAccountBalanceRequest) ApiRosettaAccountBalanceRequest

type ApiRosettaBlockRequest 

type ApiRosettaBlockRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaBlockRequest) Execute 

func (r ApiRosettaBlockRequest) Execute() (*models.RosettaBlockResponse, *http.Response, error)

func (ApiRosettaBlockRequest) RosettaBlockRequest 

func (r ApiRosettaBlockRequest) RosettaBlockRequest(rosettaBlockRequest models.RosettaBlockRequest) ApiRosettaBlockRequest

type ApiRosettaBlockTransactionRequest 

type ApiRosettaBlockTransactionRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaBlockTransactionRequest) Execute 

func (r ApiRosettaBlockTransactionRequest) Execute() (*models.RosettaBlockTransactionResponse, *http.Response, error)

func (ApiRosettaBlockTransactionRequest) RosettaBlockTransactionRequest 

func (r ApiRosettaBlockTransactionRequest) RosettaBlockTransactionRequest(rosettaBlockTransactionRequest models.RosettaBlockTransactionRequest) ApiRosettaBlockTransactionRequest

type ApiRosettaConstructionCombineRequest 

type ApiRosettaConstructionCombineRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionCombineRequest) Execute 

func (r ApiRosettaConstructionCombineRequest) Execute() (*models.RosettaConstructionCombineResponse, *http.Response, error)

func (ApiRosettaConstructionCombineRequest) RosettaConstructionCombineRequest 

func (r ApiRosettaConstructionCombineRequest) RosettaConstructionCombineRequest(rosettaConstructionCombineRequest models.RosettaConstructionCombineRequest) ApiRosettaConstructionCombineRequest

type ApiRosettaConstructionDeriveRequest 

type ApiRosettaConstructionDeriveRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionDeriveRequest) Execute 

func (r ApiRosettaConstructionDeriveRequest) Execute() (*models.RosettaConstructionDeriveResponse, *http.Response, error)

func (ApiRosettaConstructionDeriveRequest) RosettaConstructionDeriveRequest 

func (r ApiRosettaConstructionDeriveRequest) RosettaConstructionDeriveRequest(rosettaConstructionDeriveRequest models.RosettaConstructionDeriveRequest) ApiRosettaConstructionDeriveRequest

type ApiRosettaConstructionHashRequest 

type ApiRosettaConstructionHashRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionHashRequest) Execute 

func (r ApiRosettaConstructionHashRequest) Execute() (*models.RosettaConstructionHashResponse, *http.Response, error)

func (ApiRosettaConstructionHashRequest) RosettaConstructionHashRequest 

func (r ApiRosettaConstructionHashRequest) RosettaConstructionHashRequest(rosettaConstructionHashRequest models.RosettaConstructionHashRequest) ApiRosettaConstructionHashRequest

type ApiRosettaConstructionMetadataRequest 

type ApiRosettaConstructionMetadataRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionMetadataRequest) Execute 

func (r ApiRosettaConstructionMetadataRequest) Execute() (*models.RosettaConstructionMetadataResponse, *http.Response, error)

func (ApiRosettaConstructionMetadataRequest) RosettaConstructionMetadataRequest 

func (r ApiRosettaConstructionMetadataRequest) RosettaConstructionMetadataRequest(rosettaConstructionMetadataRequest models.RosettaConstructionMetadataRequest) ApiRosettaConstructionMetadataRequest

type ApiRosettaConstructionParseRequest 

type ApiRosettaConstructionParseRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionParseRequest) Execute 

func (r ApiRosettaConstructionParseRequest) Execute() (*models.RosettaConstructionParseResponse, *http.Response, error)

func (ApiRosettaConstructionParseRequest) RosettaConstructionParseRequest 

func (r ApiRosettaConstructionParseRequest) RosettaConstructionParseRequest(rosettaConstructionParseRequest models.RosettaConstructionParseRequest) ApiRosettaConstructionParseRequest

type ApiRosettaConstructionPayloadsRequest 

type ApiRosettaConstructionPayloadsRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionPayloadsRequest) Execute 

func (r ApiRosettaConstructionPayloadsRequest) Execute() (*models.RosettaConstructionPayloadResponse, *http.Response, error)

func (ApiRosettaConstructionPayloadsRequest) RosettaConstructionPayloadsRequest 

func (r ApiRosettaConstructionPayloadsRequest) RosettaConstructionPayloadsRequest(rosettaConstructionPayloadsRequest models.RosettaConstructionPayloadsRequest) ApiRosettaConstructionPayloadsRequest

type ApiRosettaConstructionPreprocessRequest 

type ApiRosettaConstructionPreprocessRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionPreprocessRequest) Execute 

func (r ApiRosettaConstructionPreprocessRequest) Execute() (*models.RosettaConstructionPreprocessResponse, *http.Response, error)

func (ApiRosettaConstructionPreprocessRequest) RosettaConstructionPreprocessRequest 

func (r ApiRosettaConstructionPreprocessRequest) RosettaConstructionPreprocessRequest(rosettaConstructionPreprocessRequest models.RosettaConstructionPreprocessRequest) ApiRosettaConstructionPreprocessRequest

type ApiRosettaConstructionSubmitRequest 

type ApiRosettaConstructionSubmitRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaConstructionSubmitRequest) Execute 

func (r ApiRosettaConstructionSubmitRequest) Execute() (*models.RosettaConstructionSubmitResponse, *http.Response, error)

func (ApiRosettaConstructionSubmitRequest) RosettaConstructionSubmitRequest 

func (r ApiRosettaConstructionSubmitRequest) RosettaConstructionSubmitRequest(rosettaConstructionSubmitRequest models.RosettaConstructionSubmitRequest) ApiRosettaConstructionSubmitRequest

type ApiRosettaMempoolRequest 

type ApiRosettaMempoolRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaMempoolRequest) Execute 

func (r ApiRosettaMempoolRequest) Execute() (*models.RosettaMempoolResponse, *http.Response, error)

func (ApiRosettaMempoolRequest) RosettaMempoolRequest 

func (r ApiRosettaMempoolRequest) RosettaMempoolRequest(rosettaMempoolRequest models.RosettaMempoolRequest) ApiRosettaMempoolRequest

type ApiRosettaMempoolTransactionRequest 

type ApiRosettaMempoolTransactionRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaMempoolTransactionRequest) Execute 

func (r ApiRosettaMempoolTransactionRequest) Execute() (*models.RosettaMempoolTransactionResponse, *http.Response, error)

func (ApiRosettaMempoolTransactionRequest) RosettaMempoolTransactionRequest 

func (r ApiRosettaMempoolTransactionRequest) RosettaMempoolTransactionRequest(rosettaMempoolTransactionRequest models.RosettaMempoolTransactionRequest) ApiRosettaMempoolTransactionRequest

type ApiRosettaNetworkListRequest 

type ApiRosettaNetworkListRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaNetworkListRequest) Execute 

func (r ApiRosettaNetworkListRequest) Execute() (*models.RosettaNetworkListResponse, *http.Response, error)

type ApiRosettaNetworkOptionsRequest 

type ApiRosettaNetworkOptionsRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaNetworkOptionsRequest) Execute 

func (r ApiRosettaNetworkOptionsRequest) Execute() (*models.RosettaNetworkOptionsResponse, *http.Response, error)

func (ApiRosettaNetworkOptionsRequest) RosettaOptionsRequest 

func (r ApiRosettaNetworkOptionsRequest) RosettaOptionsRequest(rosettaOptionsRequest models.RosettaOptionsRequest) ApiRosettaNetworkOptionsRequest

type ApiRosettaNetworkStatusRequest 

type ApiRosettaNetworkStatusRequest struct {
	ApiService *RosettaAPIService
	// contains filtered or unexported fields
}

func (ApiRosettaNetworkStatusRequest) Execute 

func (r ApiRosettaNetworkStatusRequest) Execute() (*models.RosettaNetworkStatusResponse, *http.Response, error)

func (ApiRosettaNetworkStatusRequest) RosettaStatusRequest 

func (r ApiRosettaNetworkStatusRequest) RosettaStatusRequest(rosettaStatusRequest models.RosettaStatusRequest) ApiRosettaNetworkStatusRequest

type ApiRunFaucetBtcRequest 

type ApiRunFaucetBtcRequest struct {
	ApiService *FaucetsAPIService
	// contains filtered or unexported fields
}

func (ApiRunFaucetBtcRequest) Address 

func (r ApiRunFaucetBtcRequest) Address(address string) ApiRunFaucetBtcRequest

A valid testnet BTC address

func (ApiRunFaucetBtcRequest) Execute 

func (r ApiRunFaucetBtcRequest) Execute() (*models.RunFaucetResponse, *http.Response, error)

func (ApiRunFaucetBtcRequest) RunFaucetBtcRequest 

func (r ApiRunFaucetBtcRequest) RunFaucetBtcRequest(runFaucetBtcRequest models.RunFaucetBtcRequest) ApiRunFaucetBtcRequest

type ApiRunFaucetStxRequest 

type ApiRunFaucetStxRequest struct {
	ApiService *FaucetsAPIService
	// contains filtered or unexported fields
}

func (ApiRunFaucetStxRequest) Address 

func (r ApiRunFaucetStxRequest) Address(address string) ApiRunFaucetStxRequest

A valid testnet STX address

func (ApiRunFaucetStxRequest) Execute 

func (r ApiRunFaucetStxRequest) Execute() (*models.RunFaucetResponse, *http.Response, error)

func (ApiRunFaucetStxRequest) Stacking 

func (r ApiRunFaucetStxRequest) Stacking(stacking bool) ApiRunFaucetStxRequest

Request the amount of STX tokens needed for individual address stacking

type ApiSearchByIdRequest 

type ApiSearchByIdRequest struct {
	ApiService *SearchAPIService
	// contains filtered or unexported fields
}

func (ApiSearchByIdRequest) Execute 

func (r ApiSearchByIdRequest) Execute() (*models.SearchResult, *http.Response, error)

func (ApiSearchByIdRequest) IncludeMetadata 

func (r ApiSearchByIdRequest) IncludeMetadata(includeMetadata bool) ApiSearchByIdRequest

This includes the detailed data for purticular hash in the response

type BlocksAPIService 

type BlocksAPIService service

BlocksAPIService BlocksAPI service

func (*BlocksAPIService) GetAverageBlockTimes 

func (a *BlocksAPIService) GetAverageBlockTimes(ctx context.Context) ApiGetAverageBlockTimesRequest

GetAverageBlockTimes Get average block times

Retrieves average block times (in seconds) 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAverageBlockTimesRequest

func (*BlocksAPIService) GetAverageBlockTimesExecute 

func (a *BlocksAPIService) GetAverageBlockTimesExecute(r ApiGetAverageBlockTimesRequest) (*models.AverageBlockTimesResponse, *http.Response, error)

Execute executes the request 

@return AverageBlockTimesResponse

func (*BlocksAPIService) GetBlock 

func (a *BlocksAPIService) GetBlock(ctx context.Context, heightOrHash models.GetBurnBlockHeightOrHashParameter) ApiGetBlockRequest

GetBlock Get block

Retrieves a single block 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param heightOrHash filter by block height, hash, index block hash or the constant `latest` to filter for the most recent block
@return ApiGetBlockRequest

func (*BlocksAPIService) GetBlockByBurnBlockHash 

func (a *BlocksAPIService) GetBlockByBurnBlockHash(ctx context.Context, burnBlockHash string) ApiGetBlockByBurnBlockHashRequest

GetBlockByBurnBlockHash Get block by burnchain block hash

**NOTE:** This endpoint is deprecated in favor of [Get blocks](/api/get-blocks).

Retrieves block details of a specific block for a given burnchain block hash 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param burnBlockHash Hash of the burnchain block
@return ApiGetBlockByBurnBlockHashRequest

Deprecated

func (*BlocksAPIService) GetBlockByBurnBlockHashExecute 

func (a *BlocksAPIService) GetBlockByBurnBlockHashExecute(r ApiGetBlockByBurnBlockHashRequest) (*models.Block, *http.Response, error)

Execute executes the request 

@return Block

Deprecated

func (*BlocksAPIService) GetBlockByBurnBlockHeight 

func (a *BlocksAPIService) GetBlockByBurnBlockHeight(ctx context.Context, burnBlockHeight float32) ApiGetBlockByBurnBlockHeightRequest

GetBlockByBurnBlockHeight Get block by burnchain height

**NOTE:** This endpoint is deprecated in favor of [Get blocks](/api/get-blocks).

Retrieves block details of a specific block for a given burn chain height 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param burnBlockHeight Height of the burn chain block
@return ApiGetBlockByBurnBlockHeightRequest

Deprecated

func (*BlocksAPIService) GetBlockByBurnBlockHeightExecute 

func (a *BlocksAPIService) GetBlockByBurnBlockHeightExecute(r ApiGetBlockByBurnBlockHeightRequest) (*models.Block, *http.Response, error)

Execute executes the request 

@return Block

Deprecated

func (*BlocksAPIService) GetBlockByHash 

func (a *BlocksAPIService) GetBlockByHash(ctx context.Context, hash string) ApiGetBlockByHashRequest

GetBlockByHash Get block by hash

**NOTE:** This endpoint is deprecated in favor of [Get block](/api/get-block).

Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param hash Hash of the block
@return ApiGetBlockByHashRequest

Deprecated

func (*BlocksAPIService) GetBlockByHashExecute 

func (a *BlocksAPIService) GetBlockByHashExecute(r ApiGetBlockByHashRequest) (*models.Block, *http.Response, error)

Execute executes the request 

@return Block

Deprecated

func (*BlocksAPIService) GetBlockByHeight 

func (a *BlocksAPIService) GetBlockByHeight(ctx context.Context, height float32) ApiGetBlockByHeightRequest

GetBlockByHeight Get block by height

**NOTE:** This endpoint is deprecated in favor of [Get block](/api/get-block).

Retrieves block details of a specific block at a given block height 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param height Height of the block
@return ApiGetBlockByHeightRequest

Deprecated

func (*BlocksAPIService) GetBlockByHeightExecute 

func (a *BlocksAPIService) GetBlockByHeightExecute(r ApiGetBlockByHeightRequest) (*models.Block, *http.Response, error)

Execute executes the request 

@return Block

Deprecated

func (*BlocksAPIService) GetBlockExecute 

func (a *BlocksAPIService) GetBlockExecute(r ApiGetBlockRequest) (*models.NakamotoBlock, *http.Response, error)

Execute executes the request 

@return NakamotoBlock

func (*BlocksAPIService) GetBlockList 

func (a *BlocksAPIService) GetBlockList(ctx context.Context) ApiGetBlockListRequest

GetBlockList Get recent blocks

**NOTE:** This endpoint is deprecated in favor of [Get blocks](/api/get-blocks).

Retrieves a list of recently mined blocks

If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBlockListRequest

Deprecated

func (*BlocksAPIService) GetBlockListExecute 

func (a *BlocksAPIService) GetBlockListExecute(r ApiGetBlockListRequest) (*models.BlockListResponse, *http.Response, error)

Execute executes the request 

@return BlockListResponse

Deprecated

func (*BlocksAPIService) GetBlocks 

func (a *BlocksAPIService) GetBlocks(ctx context.Context) ApiGetBlocksRequest

GetBlocks Get blocks

Retrieves a list of recently mined blocks 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBlocksRequest

func (*BlocksAPIService) GetBlocksByBurnBlock 

func (a *BlocksAPIService) GetBlocksByBurnBlock(ctx context.Context, heightOrHash models.GetBurnBlockHeightOrHashParameter) ApiGetBlocksByBurnBlockRequest

GetBlocksByBurnBlock Get blocks by burn block

Retrieves a list of blocks confirmed by a specific burn block 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param heightOrHash filter by burn block height, hash, or the constant `latest` to filter for the most recent burn block
@return ApiGetBlocksByBurnBlockRequest

func (*BlocksAPIService) GetBlocksByBurnBlockExecute 

func (a *BlocksAPIService) GetBlocksByBurnBlockExecute(r ApiGetBlocksByBurnBlockRequest) (*models.NakamotoBlockListResponse, *http.Response, error)

Execute executes the request 

@return NakamotoBlockListResponse

func (*BlocksAPIService) GetBlocksExecute 

func (a *BlocksAPIService) GetBlocksExecute(r ApiGetBlocksRequest) (*models.NakamotoBlockListResponse, *http.Response, error)

Execute executes the request 

@return NakamotoBlockListResponse

type BurnBlocksAPIService 

type BurnBlocksAPIService service

BurnBlocksAPIService BurnBlocksAPI service

func (*BurnBlocksAPIService) GetBurnBlock 

func (a *BurnBlocksAPIService) GetBurnBlock(ctx context.Context, heightOrHash models.GetBurnBlockHeightOrHashParameter) ApiGetBurnBlockRequest

GetBurnBlock Get burn block

Retrieves a single burn block 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param heightOrHash filter by burn block height, hash, or the constant `latest` to filter for the most recent burn block
@return ApiGetBurnBlockRequest

func (*BurnBlocksAPIService) GetBurnBlockExecute 

func (a *BurnBlocksAPIService) GetBurnBlockExecute(r ApiGetBurnBlockRequest) (*models.BurnBlock, *http.Response, error)

Execute executes the request 

@return BurnBlock

func (*BurnBlocksAPIService) GetBurnBlocks 

func (a *BurnBlocksAPIService) GetBurnBlocks(ctx context.Context) ApiGetBurnBlocksRequest

GetBurnBlocks Get burn blocks

Retrieves a list of recent burn blocks 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBurnBlocksRequest

func (*BurnBlocksAPIService) GetBurnBlocksExecute 

func (a *BurnBlocksAPIService) GetBurnBlocksExecute(r ApiGetBurnBlocksRequest) (*models.BurnBlockListResponse, *http.Response, error)

Execute executes the request 

@return BurnBlockListResponse

type FaucetsAPIService 

type FaucetsAPIService service

FaucetsAPIService FaucetsAPI service

func (*FaucetsAPIService) RunFaucetBtc 

func (a *FaucetsAPIService) RunFaucetBtc(ctx context.Context) ApiRunFaucetBtcRequest

RunFaucetBtc Add testnet BTC tokens to address

Add 1 BTC token to the specified testnet BTC address.

The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block.

**Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRunFaucetBtcRequest

func (*FaucetsAPIService) RunFaucetBtcExecute 

func (a *FaucetsAPIService) RunFaucetBtcExecute(r ApiRunFaucetBtcRequest) (*models.RunFaucetResponse, *http.Response, error)

Execute executes the request 

@return RunFaucetResponse

func (*FaucetsAPIService) RunFaucetStx 

func (a *FaucetsAPIService) RunFaucetStx(ctx context.Context) ApiRunFaucetStxRequest

RunFaucetStx Get STX testnet tokens

Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with `ST`. If the `stacking` parameter is set to `true`, the faucet will add the required number of tokens for individual stacking to the specified testnet address.

The endpoint returns the transaction ID, which you can use to view the transaction in the [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has been included in an anchor block.

A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing failed faucet transactions to a testnet address, you can get help in [Discord](https://stacks.chat).

**Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRunFaucetStxRequest

func (*FaucetsAPIService) RunFaucetStxExecute 

func (a *FaucetsAPIService) RunFaucetStxExecute(r ApiRunFaucetStxRequest) (*models.RunFaucetResponse, *http.Response, error)

Execute executes the request 

@return RunFaucetResponse

type FeesAPIService 

type FeesAPIService service

FeesAPIService FeesAPI service

func (*FeesAPIService) FetchFeeRate 

func (a *FeesAPIService) FetchFeeRate(ctx context.Context) ApiFetchFeeRateRequest

FetchFeeRate Fetch fee rate

**NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](/api/get-approximate-fees-for-a-given-transaction).

Retrieves estimated fee rate. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiFetchFeeRateRequest

Deprecated

func (*FeesAPIService) FetchFeeRateExecute 

func (a *FeesAPIService) FetchFeeRateExecute(r ApiFetchFeeRateRequest) (*models.FeeRate, *http.Response, error)

Execute executes the request 

@return FeeRate

Deprecated

func (*FeesAPIService) GetFeeTransfer 

func (a *FeesAPIService) GetFeeTransfer(ctx context.Context) ApiGetFeeTransferRequest

GetFeeTransfer Get estimated fee

Retrieves an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetFeeTransferRequest

func (*FeesAPIService) GetFeeTransferExecute 

func (a *FeesAPIService) GetFeeTransferExecute(r ApiGetFeeTransferRequest) (map[string]interface{}, *http.Response, error)

Execute executes the request 

@return map[string]interface{}

func (*FeesAPIService) PostFeeTransaction 

func (a *FeesAPIService) PostFeeTransaction(ctx context.Context) ApiPostFeeTransactionRequest

PostFeeTransaction Get approximate fees for a given transaction

Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts.

  • `transaction_payload` is a hex-encoded serialization of the TransactionPayload for the transaction.
  • `estimated_len` is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures

If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned.

The 400 response will be a JSON error containing a `reason` field which can be one of the following:

  • `DatabaseError` - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction.
  • `NoEstimateAvailable` - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet.
  • `CostEstimationDisabled` - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint.

The 200 response contains the following data:

  • `estimated_cost` - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction.
  • `estimated_cost_scalar` - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node's estimated fee rate.
  • `cost_scalar_change_by_byte` - a float value that indicates how much the `estimated_cost_scalar` value would increase for every additional byte in the final transaction.
  • `estimations` - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields:
  • `fee_rate` - the estimated value for the current fee rates in the network
  • `fee` - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: `fee_rate` x `estimated_cost_scalar`. If the estimated fees are less than the minimum relay fee `(1 ustx x estimated_len)`, then that minimum relay fee will be returned here instead.

Note: If the final transaction's byte size is larger than supplied to `estimated_len`, then applications should increase this fee amount by: 

 `fee_rate` x `cost_scalar_change_by_byte` x (`final_size` - `estimated_size`)

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiPostFeeTransactionRequest

func (*FeesAPIService) PostFeeTransactionExecute 

func (a *FeesAPIService) PostFeeTransactionExecute(r ApiPostFeeTransactionRequest) (*models.TransactionFeeEstimateResponse, *http.Response, error)

Execute executes the request 

@return TransactionFeeEstimateResponse

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type InfoAPIService 

type InfoAPIService service

InfoAPIService InfoAPI service

func (*InfoAPIService) GetCoreApiInfo 

func (a *InfoAPIService) GetCoreApiInfo(ctx context.Context) ApiGetCoreApiInfoRequest

GetCoreApiInfo Get Core API info

Retrieves information about the Core API including the server version 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetCoreApiInfoRequest

func (*InfoAPIService) GetCoreApiInfoExecute 

func (a *InfoAPIService) GetCoreApiInfoExecute(r ApiGetCoreApiInfoRequest) (*models.CoreNodeInfoResponse, *http.Response, error)

Execute executes the request 

@return CoreNodeInfoResponse

func (*InfoAPIService) GetNetworkBlockTimeByNetwork 

func (a *InfoAPIService) GetNetworkBlockTimeByNetwork(ctx context.Context, network string) ApiGetNetworkBlockTimeByNetworkRequest

GetNetworkBlockTimeByNetwork Get a given network's target block time

Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param network the target block time for a given network (testnet, mainnet).
@return ApiGetNetworkBlockTimeByNetworkRequest

func (*InfoAPIService) GetNetworkBlockTimeByNetworkExecute 

func (a *InfoAPIService) GetNetworkBlockTimeByNetworkExecute(r ApiGetNetworkBlockTimeByNetworkRequest) (*models.TargetBlockTime, *http.Response, error)

Execute executes the request 

@return TargetBlockTime

func (*InfoAPIService) GetNetworkBlockTimes 

func (a *InfoAPIService) GetNetworkBlockTimes(ctx context.Context) ApiGetNetworkBlockTimesRequest

GetNetworkBlockTimes Get the network target block time

Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetNetworkBlockTimesRequest

func (*InfoAPIService) GetNetworkBlockTimesExecute 

func (a *InfoAPIService) GetNetworkBlockTimesExecute(r ApiGetNetworkBlockTimesRequest) (*models.NetworkBlockTimesResponse, *http.Response, error)

Execute executes the request 

@return NetworkBlockTimesResponse

func (*InfoAPIService) GetPoxInfo 

func (a *InfoAPIService) GetPoxInfo(ctx context.Context) ApiGetPoxInfoRequest

GetPoxInfo Get Proof-of-Transfer details

Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetPoxInfoRequest

func (*InfoAPIService) GetPoxInfoExecute 

func (a *InfoAPIService) GetPoxInfoExecute(r ApiGetPoxInfoRequest) (*models.CoreNodePoxResponse, *http.Response, error)

Execute executes the request 

@return CoreNodePoxResponse

func (*InfoAPIService) GetStatus 

func (a *InfoAPIService) GetStatus(ctx context.Context) ApiGetStatusRequest

GetStatus API status

Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetStatusRequest

func (*InfoAPIService) GetStatusExecute 

func (a *InfoAPIService) GetStatusExecute(r ApiGetStatusRequest) (*models.ServerStatusResponse, *http.Response, error)

Execute executes the request 

@return ServerStatusResponse

func (*InfoAPIService) GetStxSupply 

func (a *InfoAPIService) GetStxSupply(ctx context.Context) ApiGetStxSupplyRequest

GetStxSupply Get total and unlocked STX supply

Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetStxSupplyRequest

func (*InfoAPIService) GetStxSupplyCirculatingPlain 

func (a *InfoAPIService) GetStxSupplyCirculatingPlain(ctx context.Context) ApiGetStxSupplyCirculatingPlainRequest

GetStxSupplyCirculatingPlain Get circulating STX supply in plain text format

Retrieves the STX tokens currently in circulation that have been unlocked as plain text. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetStxSupplyCirculatingPlainRequest

func (*InfoAPIService) GetStxSupplyCirculatingPlainExecute 

func (a *InfoAPIService) GetStxSupplyCirculatingPlainExecute(r ApiGetStxSupplyCirculatingPlainRequest) (string, *http.Response, error)

Execute executes the request 

@return string

func (*InfoAPIService) GetStxSupplyExecute 

func (a *InfoAPIService) GetStxSupplyExecute(r ApiGetStxSupplyRequest) (*models.GetStxSupplyResponse, *http.Response, error)

Execute executes the request 

@return GetStxSupplyResponse

func (*InfoAPIService) GetStxSupplyTotalSupplyPlain 

func (a *InfoAPIService) GetStxSupplyTotalSupplyPlain(ctx context.Context) ApiGetStxSupplyTotalSupplyPlainRequest

GetStxSupplyTotalSupplyPlain Get total STX supply in plain text format

Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetStxSupplyTotalSupplyPlainRequest

func (*InfoAPIService) GetStxSupplyTotalSupplyPlainExecute 

func (a *InfoAPIService) GetStxSupplyTotalSupplyPlainExecute(r ApiGetStxSupplyTotalSupplyPlainRequest) (string, *http.Response, error)

Execute executes the request 

@return string

func (*InfoAPIService) GetTotalStxSupplyLegacyFormat 

func (a *InfoAPIService) GetTotalStxSupplyLegacyFormat(ctx context.Context) ApiGetTotalStxSupplyLegacyFormatRequest

GetTotalStxSupplyLegacyFormat Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)

Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetTotalStxSupplyLegacyFormatRequest

func (*InfoAPIService) GetTotalStxSupplyLegacyFormatExecute 

func (a *InfoAPIService) GetTotalStxSupplyLegacyFormatExecute(r ApiGetTotalStxSupplyLegacyFormatRequest) (*models.GetStxSupplyLegacyFormatResponse, *http.Response, error)

Execute executes the request 

@return GetStxSupplyLegacyFormatResponse

type MempoolAPIService 

type MempoolAPIService service

MempoolAPIService MempoolAPI service

func (*MempoolAPIService) GetMempoolFeePriorities 

func (a *MempoolAPIService) GetMempoolFeePriorities(ctx context.Context) ApiGetMempoolFeePrioritiesRequest

GetMempoolFeePriorities Get mempool transaction fee priorities

Returns estimated fee priorities (in micro-STX) for all transactions that are currently in the mempool. Also returns priorities separated by transaction type. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetMempoolFeePrioritiesRequest

func (*MempoolAPIService) GetMempoolFeePrioritiesExecute 

func (a *MempoolAPIService) GetMempoolFeePrioritiesExecute(r ApiGetMempoolFeePrioritiesRequest) (*models.MempoolFeePriorities, *http.Response, error)

Execute executes the request 

@return MempoolFeePriorities

type MicroblocksAPIService 

type MicroblocksAPIService service

MicroblocksAPIService MicroblocksAPI service

func (*MicroblocksAPIService) GetMicroblockByHash 

func (a *MicroblocksAPIService) GetMicroblockByHash(ctx context.Context, hash string) ApiGetMicroblockByHashRequest

GetMicroblockByHash Get microblock

Retrieves a specific microblock by `hash` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param hash Hash of the microblock
@return ApiGetMicroblockByHashRequest

func (*MicroblocksAPIService) GetMicroblockByHashExecute 

func (a *MicroblocksAPIService) GetMicroblockByHashExecute(r ApiGetMicroblockByHashRequest) (*models.Microblock, *http.Response, error)

Execute executes the request 

@return Microblock

func (*MicroblocksAPIService) GetMicroblockList 

func (a *MicroblocksAPIService) GetMicroblockList(ctx context.Context) ApiGetMicroblockListRequest

GetMicroblockList Get recent microblocks

Retrieves a list of microblocks.

If you need to actively monitor new microblocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetMicroblockListRequest

func (*MicroblocksAPIService) GetMicroblockListExecute 

func (a *MicroblocksAPIService) GetMicroblockListExecute(r ApiGetMicroblockListRequest) (*models.MicroblockListResponse, *http.Response, error)

Execute executes the request 

@return MicroblockListResponse

func (*MicroblocksAPIService) GetUnanchoredTxs 

func (a *MicroblocksAPIService) GetUnanchoredTxs(ctx context.Context) ApiGetUnanchoredTxsRequest

GetUnanchoredTxs Get the list of current transactions that belong to unanchored microblocks

Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetUnanchoredTxsRequest

func (*MicroblocksAPIService) GetUnanchoredTxsExecute 

func (a *MicroblocksAPIService) GetUnanchoredTxsExecute(r ApiGetUnanchoredTxsRequest) (*models.UnanchoredTransactionListResponse, *http.Response, error)

Execute executes the request 

@return UnanchoredTransactionListResponse

type NamesAPIService 

type NamesAPIService service

NamesAPIService NamesAPI service

func (*NamesAPIService) FetchSubdomainsListForName 

func (a *NamesAPIService) FetchSubdomainsListForName(ctx context.Context, name string) ApiFetchSubdomainsListForNameRequest

FetchSubdomainsListForName Get Name Subdomains

Retrieves the list of subdomains for a specific name 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name fully-qualified name
@return ApiFetchSubdomainsListForNameRequest

func (*NamesAPIService) FetchSubdomainsListForNameExecute 

func (a *NamesAPIService) FetchSubdomainsListForNameExecute(r ApiFetchSubdomainsListForNameRequest) ([]string, *http.Response, error)

Execute executes the request 

@return []string

func (*NamesAPIService) FetchZoneFile 

func (a *NamesAPIService) FetchZoneFile(ctx context.Context, name string) ApiFetchZoneFileRequest

FetchZoneFile Get Zone File

Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name fully-qualified name
@return ApiFetchZoneFileRequest

func (*NamesAPIService) FetchZoneFileExecute 

func (a *NamesAPIService) FetchZoneFileExecute(r ApiFetchZoneFileRequest) (*models.BnsFetchFileZoneResponse, *http.Response, error)

Execute executes the request 

@return models.BnsFetchFileZoneResponse

func (*NamesAPIService) GetAllNames 

func (a *NamesAPIService) GetAllNames(ctx context.Context) ApiGetAllNamesRequest

GetAllNames Get All Names

Retrieves a list of all names known to the node. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAllNamesRequest

func (*NamesAPIService) GetAllNamesExecute 

func (a *NamesAPIService) GetAllNamesExecute(r ApiGetAllNamesRequest) ([]string, *http.Response, error)

Execute executes the request 

@return []string

func (*NamesAPIService) GetAllNamespaces 

func (a *NamesAPIService) GetAllNamespaces(ctx context.Context) ApiGetAllNamespacesRequest

GetAllNamespaces Get All Namespaces

Retrieves a list of all namespaces known to the node. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetAllNamespacesRequest

func (*NamesAPIService) GetAllNamespacesExecute 

func (a *NamesAPIService) GetAllNamespacesExecute(r ApiGetAllNamespacesRequest) (*models.BnsGetAllNamespacesResponse, *http.Response, error)

Execute executes the request 

@return models.BnsGetAllNamespacesResponse

func (*NamesAPIService) GetHistoricalZoneFile 

func (a *NamesAPIService) GetHistoricalZoneFile(ctx context.Context, name string, zoneFileHash string) ApiGetHistoricalZoneFileRequest

GetHistoricalZoneFile Get Historical Zone File

Retrieves the historical zonefile specified by the username and zone hash. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name fully-qualified name
@param zoneFileHash zone file hash
@return ApiGetHistoricalZoneFileRequest

func (*NamesAPIService) GetHistoricalZoneFileExecute 

func (a *NamesAPIService) GetHistoricalZoneFileExecute(r ApiGetHistoricalZoneFileRequest) (*models.BnsFetchHistoricalZoneFileResponse, *http.Response, error)

Execute executes the request 

@return models.BnsFetchHistoricalZoneFileResponse

func (*NamesAPIService) GetNameInfo 

func (a *NamesAPIService) GetNameInfo(ctx context.Context, name string) ApiGetNameInfoRequest

GetNameInfo Get Name Details

Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name fully-qualified name
@return ApiGetNameInfoRequest

func (*NamesAPIService) GetNameInfoExecute 

func (a *NamesAPIService) GetNameInfoExecute(r ApiGetNameInfoRequest) (*models.BnsGetNameInfoResponse, *http.Response, error)

Execute executes the request 

@return models.BnsGetNameInfoResponse

func (*NamesAPIService) GetNamePrice 

func (a *NamesAPIService) GetNamePrice(ctx context.Context, name string) ApiGetNamePriceRequest

GetNamePrice Get Name Price

Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name the name to query price information for
@return ApiGetNamePriceRequest

func (*NamesAPIService) GetNamePriceExecute 

func (a *NamesAPIService) GetNamePriceExecute(r ApiGetNamePriceRequest) (*models.BnsGetNamePriceResponse, *http.Response, error)

Execute executes the request 

@return models.BnsGetNamePriceResponse

func (*NamesAPIService) GetNamesOwnedByAddress 

func (a *NamesAPIService) GetNamesOwnedByAddress(ctx context.Context, blockchain string, address string) ApiGetNamesOwnedByAddressRequest

GetNamesOwnedByAddress Get Names Owned by Address

Retrieves a list of names owned by the address provided. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blockchain the layer-1 blockchain for the address
@param address the address to lookup
@return ApiGetNamesOwnedByAddressRequest

func (*NamesAPIService) GetNamesOwnedByAddressExecute 

func (a *NamesAPIService) GetNamesOwnedByAddressExecute(r ApiGetNamesOwnedByAddressRequest) (*models.BnsNamesOwnByAddressResponse, *http.Response, error)

Execute executes the request 

@return models.BnsNamesOwnByAddressResponse

func (*NamesAPIService) GetNamespaceNames 

func (a *NamesAPIService) GetNamespaceNames(ctx context.Context, tld string) ApiGetNamespaceNamesRequest

GetNamespaceNames Get Namespace Names

Retrieves a list of names within a given namespace. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tld the namespace to fetch names from.
@return ApiGetNamespaceNamesRequest

func (*NamesAPIService) GetNamespaceNamesExecute 

func (a *NamesAPIService) GetNamespaceNamesExecute(r ApiGetNamespaceNamesRequest) ([]string, *http.Response, error)

Execute executes the request 

@return []string

func (*NamesAPIService) GetNamespacePrice 

func (a *NamesAPIService) GetNamespacePrice(ctx context.Context, tld string) ApiGetNamespacePriceRequest

GetNamespacePrice Get Namespace Price

Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param tld the namespace to fetch price for
@return ApiGetNamespacePriceRequest

func (*NamesAPIService) GetNamespacePriceExecute 

func (a *NamesAPIService) GetNamespacePriceExecute(r ApiGetNamespacePriceRequest) (*models.BnsGetNamespacePriceResponse, *http.Response, error)

Execute executes the request 

@return models.BnsGetNamespacePriceResponse

type NonFungibleTokensAPIService 

type NonFungibleTokensAPIService service

NonFungibleTokensAPIService NonFungibleTokensAPI service

func (*NonFungibleTokensAPIService) GetNftHistory 

func (a *NonFungibleTokensAPIService) GetNftHistory(ctx context.Context) ApiGetNftHistoryRequest

GetNftHistory Non-Fungible Token history

Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.

More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetNftHistoryRequest

func (*NonFungibleTokensAPIService) GetNftHistoryExecute 

func (a *NonFungibleTokensAPIService) GetNftHistoryExecute(r ApiGetNftHistoryRequest) (*models.NonFungibleTokenHistoryEventList, *http.Response, error)

Execute executes the request 

@return NonFungibleTokenHistoryEventList

func (*NonFungibleTokensAPIService) GetNftHoldings 

func (a *NonFungibleTokensAPIService) GetNftHoldings(ctx context.Context) ApiGetNftHoldingsRequest

GetNftHoldings Non-Fungible Token holdings

Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID). Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.

More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetNftHoldingsRequest

func (*NonFungibleTokensAPIService) GetNftHoldingsExecute 

func (a *NonFungibleTokensAPIService) GetNftHoldingsExecute(r ApiGetNftHoldingsRequest) (*models.NonFungibleTokenHoldingsList, *http.Response, error)

Execute executes the request 

@return NonFungibleTokenHoldingsList

func (*NonFungibleTokensAPIService) GetNftMints 

func (a *NonFungibleTokensAPIService) GetNftMints(ctx context.Context) ApiGetNftMintsRequest

GetNftMints Non-Fungible Token mints

Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.

More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetNftMintsRequest

func (*NonFungibleTokensAPIService) GetNftMintsExecute 

func (a *NonFungibleTokensAPIService) GetNftMintsExecute(r ApiGetNftMintsRequest) (*models.NonFungibleTokenMintList, *http.Response, error)

Execute executes the request 

@return NonFungibleTokenMintList

type ProofOfTransferAPIService 

type ProofOfTransferAPIService service

ProofOfTransferAPIService ProofOfTransferAPI service

func (*ProofOfTransferAPIService) GetPoxCycle 

func (a *ProofOfTransferAPIService) GetPoxCycle(ctx context.Context, cycleNumber int32) ApiGetPoxCycleRequest

GetPoxCycle Get PoX cycle

Retrieves details for a PoX cycle 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cycleNumber PoX cycle number
@return ApiGetPoxCycleRequest

func (*ProofOfTransferAPIService) GetPoxCycleExecute 

func (a *ProofOfTransferAPIService) GetPoxCycleExecute(r ApiGetPoxCycleRequest) (*models.PoxCycle, *http.Response, error)

Execute executes the request 

@return PoxCycle

func (*ProofOfTransferAPIService) GetPoxCycleSigner 

func (a *ProofOfTransferAPIService) GetPoxCycleSigner(ctx context.Context, cycleNumber int32, signerKey string) ApiGetPoxCycleSignerRequest

GetPoxCycleSigner Get signer in PoX cycle

Retrieves details for a signer in a PoX cycle 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cycleNumber PoX cycle number
@param signerKey Signer key
@return ApiGetPoxCycleSignerRequest

func (*ProofOfTransferAPIService) GetPoxCycleSignerExecute 

func (a *ProofOfTransferAPIService) GetPoxCycleSignerExecute(r ApiGetPoxCycleSignerRequest) (*models.PoxSigner, *http.Response, error)

Execute executes the request 

@return PoxSigner

func (*ProofOfTransferAPIService) GetPoxCycleSignerStackers 

func (a *ProofOfTransferAPIService) GetPoxCycleSignerStackers(ctx context.Context, cycleNumber int32, signerKey string) ApiGetPoxCycleSignerStackersRequest

GetPoxCycleSignerStackers Get stackers for signer in PoX cycle

Retrieves a list of stackers for a signer in a PoX cycle 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cycleNumber PoX cycle number
@param signerKey Signer key
@return ApiGetPoxCycleSignerStackersRequest

func (*ProofOfTransferAPIService) GetPoxCycleSignerStackersExecute 

func (a *ProofOfTransferAPIService) GetPoxCycleSignerStackersExecute(r ApiGetPoxCycleSignerStackersRequest) (*models.PoxCycleSignerStackersListResponse, *http.Response, error)

Execute executes the request 

@return PoxCycleSignerStackersListResponse

func (*ProofOfTransferAPIService) GetPoxCycleSigners 

func (a *ProofOfTransferAPIService) GetPoxCycleSigners(ctx context.Context, cycleNumber int32) ApiGetPoxCycleSignersRequest

GetPoxCycleSigners Get signers in PoX cycle

Retrieves a list of signers in a PoX cycle 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param cycleNumber PoX cycle number
@return ApiGetPoxCycleSignersRequest

func (*ProofOfTransferAPIService) GetPoxCycleSignersExecute 

func (a *ProofOfTransferAPIService) GetPoxCycleSignersExecute(r ApiGetPoxCycleSignersRequest) (*models.PoxCycleSignersListResponse, *http.Response, error)

Execute executes the request 

@return PoxCycleSignersListResponse

func (*ProofOfTransferAPIService) GetPoxCycles 

func (a *ProofOfTransferAPIService) GetPoxCycles(ctx context.Context) ApiGetPoxCyclesRequest

GetPoxCycles Get PoX cycles

Retrieves a list of PoX cycles 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetPoxCyclesRequest

func (*ProofOfTransferAPIService) GetPoxCyclesExecute 

func (a *ProofOfTransferAPIService) GetPoxCyclesExecute(r ApiGetPoxCyclesRequest) (*models.PoxCycleListResponse, *http.Response, error)

Execute executes the request 

@return PoxCycleListResponse

type RosettaAPIService 

type RosettaAPIService service

RosettaAPIService RosettaAPI service

func (*RosettaAPIService) RosettaAccountBalance 

func (a *RosettaAPIService) RosettaAccountBalance(ctx context.Context) ApiRosettaAccountBalanceRequest

RosettaAccountBalance Get an Account Balance

An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint. If the block_identifier is populated, a historical balance query should be performed. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaAccountBalanceRequest

func (*RosettaAPIService) RosettaAccountBalanceExecute 

func (a *RosettaAPIService) RosettaAccountBalanceExecute(r ApiRosettaAccountBalanceRequest) (*models.RosettaAccountBalanceResponse, *http.Response, error)

Execute executes the request 

@return RosettaAccountBalanceResponse

func (*RosettaAPIService) RosettaBlock 

func (a *RosettaAPIService) RosettaBlock(ctx context.Context) ApiRosettaBlockRequest

RosettaBlock Get a Block

Retrieves the Block information for a given block identifier including a list of all transactions in the block. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaBlockRequest

func (*RosettaAPIService) RosettaBlockExecute 

func (a *RosettaAPIService) RosettaBlockExecute(r ApiRosettaBlockRequest) (*models.RosettaBlockResponse, *http.Response, error)

Execute executes the request 

@return RosettaBlockResponse

func (*RosettaAPIService) RosettaBlockTransaction 

func (a *RosettaAPIService) RosettaBlockTransaction(ctx context.Context) ApiRosettaBlockTransactionRequest

RosettaBlockTransaction Get a Block Transaction

Retrieves a Transaction included in a block that is not returned in a BlockResponse. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaBlockTransactionRequest

func (*RosettaAPIService) RosettaBlockTransactionExecute 

func (a *RosettaAPIService) RosettaBlockTransactionExecute(r ApiRosettaBlockTransactionRequest) (*models.RosettaBlockTransactionResponse, *http.Response, error)

Execute executes the request 

@return RosettaBlockTransactionResponse

func (*RosettaAPIService) RosettaConstructionCombine 

func (a *RosettaAPIService) RosettaConstructionCombine(ctx context.Context) ApiRosettaConstructionCombineRequest

RosettaConstructionCombine Create Network Transaction from Signatures

Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You'll need to use your wallet to generate actual values to use them in the request payload. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionCombineRequest

func (*RosettaAPIService) RosettaConstructionCombineExecute 

func (a *RosettaAPIService) RosettaConstructionCombineExecute(r ApiRosettaConstructionCombineRequest) (*models.RosettaConstructionCombineResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionCombineResponse

func (*RosettaAPIService) RosettaConstructionDerive 

func (a *RosettaAPIService) RosettaConstructionDerive(ctx context.Context) ApiRosettaConstructionDeriveRequest

RosettaConstructionDerive Derive an AccountIdentifier from a PublicKey

Retrieves the Account Identifier information based on a Public Key for a given network 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionDeriveRequest

func (*RosettaAPIService) RosettaConstructionDeriveExecute 

func (a *RosettaAPIService) RosettaConstructionDeriveExecute(r ApiRosettaConstructionDeriveRequest) (*models.RosettaConstructionDeriveResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionDeriveResponse

func (*RosettaAPIService) RosettaConstructionHash 

func (a *RosettaAPIService) RosettaConstructionHash(ctx context.Context) ApiRosettaConstructionHashRequest

RosettaConstructionHash Get the Hash of a Signed Transaction

Retrieves the network-specific transaction hash for a signed transaction. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionHashRequest

func (*RosettaAPIService) RosettaConstructionHashExecute 

func (a *RosettaAPIService) RosettaConstructionHashExecute(r ApiRosettaConstructionHashRequest) (*models.RosettaConstructionHashResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionHashResponse

func (*RosettaAPIService) RosettaConstructionMetadata 

func (a *RosettaAPIService) RosettaConstructionMetadata(ctx context.Context) ApiRosettaConstructionMetadataRequest

RosettaConstructionMetadata Get Metadata for Transaction Construction

To Do 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionMetadataRequest

func (*RosettaAPIService) RosettaConstructionMetadataExecute 

func (a *RosettaAPIService) RosettaConstructionMetadataExecute(r ApiRosettaConstructionMetadataRequest) (*models.RosettaConstructionMetadataResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionMetadataResponse

func (*RosettaAPIService) RosettaConstructionParse 

func (a *RosettaAPIService) RosettaConstructionParse(ctx context.Context) ApiRosettaConstructionParseRequest

RosettaConstructionParse Parse a Transaction

TODO 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionParseRequest

func (*RosettaAPIService) RosettaConstructionParseExecute 

func (a *RosettaAPIService) RosettaConstructionParseExecute(r ApiRosettaConstructionParseRequest) (*models.RosettaConstructionParseResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionParseResponse

func (*RosettaAPIService) RosettaConstructionPayloads 

func (a *RosettaAPIService) RosettaConstructionPayloads(ctx context.Context) ApiRosettaConstructionPayloadsRequest

RosettaConstructionPayloads Generate an Unsigned Transaction and Signing Payloads

Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You'll need to use your wallet to generate actual values to use them in the request payload. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionPayloadsRequest

func (*RosettaAPIService) RosettaConstructionPayloadsExecute 

func (a *RosettaAPIService) RosettaConstructionPayloadsExecute(r ApiRosettaConstructionPayloadsRequest) (*models.RosettaConstructionPayloadResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionPayloadResponse

func (*RosettaAPIService) RosettaConstructionPreprocess 

func (a *RosettaAPIService) RosettaConstructionPreprocess(ctx context.Context) ApiRosettaConstructionPreprocessRequest

RosettaConstructionPreprocess Create a Request to Fetch Metadata

TODO 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionPreprocessRequest

func (*RosettaAPIService) RosettaConstructionPreprocessExecute 

func (a *RosettaAPIService) RosettaConstructionPreprocessExecute(r ApiRosettaConstructionPreprocessRequest) (*models.RosettaConstructionPreprocessResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionPreprocessResponse

func (*RosettaAPIService) RosettaConstructionSubmit 

func (a *RosettaAPIService) RosettaConstructionSubmit(ctx context.Context) ApiRosettaConstructionSubmitRequest

RosettaConstructionSubmit Submit a Signed Transaction

Submit a pre-signed transaction to the node. The examples below are illustrative only. You'll need to use your wallet to generate actual values to use them in the request payload. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaConstructionSubmitRequest

func (*RosettaAPIService) RosettaConstructionSubmitExecute 

func (a *RosettaAPIService) RosettaConstructionSubmitExecute(r ApiRosettaConstructionSubmitRequest) (*models.RosettaConstructionSubmitResponse, *http.Response, error)

Execute executes the request 

@return RosettaConstructionSubmitResponse

func (*RosettaAPIService) RosettaMempool 

func (a *RosettaAPIService) RosettaMempool(ctx context.Context) ApiRosettaMempoolRequest

RosettaMempool Get All Mempool Transactions

Retrieves a list of transactions currently in the mempool for a given network. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaMempoolRequest

func (*RosettaAPIService) RosettaMempoolExecute 

func (a *RosettaAPIService) RosettaMempoolExecute(r ApiRosettaMempoolRequest) (*models.RosettaMempoolResponse, *http.Response, error)

Execute executes the request 

@return RosettaMempoolResponse

func (*RosettaAPIService) RosettaMempoolTransaction 

func (a *RosettaAPIService) RosettaMempoolTransaction(ctx context.Context) ApiRosettaMempoolTransactionRequest

RosettaMempoolTransaction Get a Mempool Transaction

Retrieves transaction details from the mempool for a given transaction id from a given network. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaMempoolTransactionRequest

func (*RosettaAPIService) RosettaMempoolTransactionExecute 

func (a *RosettaAPIService) RosettaMempoolTransactionExecute(r ApiRosettaMempoolTransactionRequest) (*models.RosettaMempoolTransactionResponse, *http.Response, error)

Execute executes the request 

@return RosettaMempoolTransactionResponse

func (*RosettaAPIService) RosettaNetworkList 

func (a *RosettaAPIService) RosettaNetworkList(ctx context.Context) ApiRosettaNetworkListRequest

RosettaNetworkList Get List of Available Networks

Retrieves a list of NetworkIdentifiers that the Rosetta server supports. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaNetworkListRequest

func (*RosettaAPIService) RosettaNetworkListExecute 

func (a *RosettaAPIService) RosettaNetworkListExecute(r ApiRosettaNetworkListRequest) (*models.RosettaNetworkListResponse, *http.Response, error)

Execute executes the request 

@return RosettaNetworkListResponse

func (*RosettaAPIService) RosettaNetworkOptions 

func (a *RosettaAPIService) RosettaNetworkOptions(ctx context.Context) ApiRosettaNetworkOptionsRequest

RosettaNetworkOptions Get Network Options

Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaNetworkOptionsRequest

func (*RosettaAPIService) RosettaNetworkOptionsExecute 

func (a *RosettaAPIService) RosettaNetworkOptionsExecute(r ApiRosettaNetworkOptionsRequest) (*models.RosettaNetworkOptionsResponse, *http.Response, error)

Execute executes the request 

@return RosettaNetworkOptionsResponse

func (*RosettaAPIService) RosettaNetworkStatus 

func (a *RosettaAPIService) RosettaNetworkStatus(ctx context.Context) ApiRosettaNetworkStatusRequest

RosettaNetworkStatus Get Network Status

Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRosettaNetworkStatusRequest

func (*RosettaAPIService) RosettaNetworkStatusExecute 

func (a *RosettaAPIService) RosettaNetworkStatusExecute(r ApiRosettaNetworkStatusRequest) (*models.RosettaNetworkStatusResponse, *http.Response, error)

Execute executes the request 

@return RosettaNetworkStatusResponse

type SearchAPIService 

type SearchAPIService service

SearchAPIService SearchAPI service

func (*SearchAPIService) SearchById 

func (a *SearchAPIService) SearchById(ctx context.Context, id string) ApiSearchByIdRequest

SearchById Search

Search blocks, transactions, contracts, or accounts by hash/ID 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id The hex hash string for a block or transaction, account address, or contract address
@return ApiSearchByIdRequest

func (*SearchAPIService) SearchByIdExecute 

func (a *SearchAPIService) SearchByIdExecute(r ApiSearchByIdRequest) (*models.SearchResult, *http.Response, error)

Execute executes the request 

@return SearchResult

type SmartContractsAPIService 

type SmartContractsAPIService service

SmartContractsAPIService SmartContractsAPI service

func (*SmartContractsAPIService) CallReadOnlyFunction 

func (a *SmartContractsAPIService) CallReadOnlyFunction(ctx context.Context, contractAddress string, contractName string, functionName string) ApiCallReadOnlyFunctionRequest

CallReadOnlyFunction Call read-only function

Call a read-only public function on a given smart contract.

The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format: 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractAddress Stacks address
@param contractName Contract name
@param functionName Function name
@return ApiCallReadOnlyFunctionRequest

func (*SmartContractsAPIService) CallReadOnlyFunctionExecute 

func (a *SmartContractsAPIService) CallReadOnlyFunctionExecute(r ApiCallReadOnlyFunctionRequest) (*models.ReadOnlyFunctionSuccessResponse, *http.Response, error)

Execute executes the request 

@return ReadOnlyFunctionSuccessResponse

func (*SmartContractsAPIService) GetContractById 

func (a *SmartContractsAPIService) GetContractById(ctx context.Context, contractId string) ApiGetContractByIdRequest

GetContractById Get contract info

Retrieves details of a contract with a given `contract_id` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractId Contract identifier formatted as `<contract_address>.<contract_name>`
@return ApiGetContractByIdRequest

func (*SmartContractsAPIService) GetContractByIdExecute 

func (a *SmartContractsAPIService) GetContractByIdExecute(r ApiGetContractByIdRequest) (*models.SmartContract, *http.Response, error)

Execute executes the request 

@return SmartContract

func (*SmartContractsAPIService) GetContractDataMapEntry 

func (a *SmartContractsAPIService) GetContractDataMapEntry(ctx context.Context, contractAddress string, contractName string, mapName string) ApiGetContractDataMapEntryRequest

GetContractDataMapEntry Get specific data-map inside a contract

Attempt to fetch data from a contract data map. The contract is identified with Stacks Address `contract_address` and Contract Name `contract_address` in the URL path. The map is identified with [Map Name].

The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.

In the response, `data` is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractAddress Stacks address
@param contractName Contract name
@param mapName Map name
@return ApiGetContractDataMapEntryRequest

func (*SmartContractsAPIService) GetContractDataMapEntryExecute 

func (a *SmartContractsAPIService) GetContractDataMapEntryExecute(r ApiGetContractDataMapEntryRequest) (*models.MapEntryResponse, *http.Response, error)

Execute executes the request 

@return MapEntryResponse

func (*SmartContractsAPIService) GetContractEventsById 

func (a *SmartContractsAPIService) GetContractEventsById(ctx context.Context, contractId string) ApiGetContractEventsByIdRequest

GetContractEventsById Get contract events

Retrieves a list of events that have been triggered by a given `contract_id` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractId Contract identifier formatted as `<contract_address>.<contract_name>`
@return ApiGetContractEventsByIdRequest

func (*SmartContractsAPIService) GetContractEventsByIdExecute 

func (a *SmartContractsAPIService) GetContractEventsByIdExecute(r ApiGetContractEventsByIdRequest) (*models.TransactionEvent, *http.Response, error)

Execute executes the request 

@return TransactionEvent

func (*SmartContractsAPIService) GetContractInterface 

func (a *SmartContractsAPIService) GetContractInterface(ctx context.Context, contractAddress string, contractName string) ApiGetContractInterfaceRequest

GetContractInterface Get contract interface

Retrieves a contract interface with a given `contract_address` and `contract name` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractAddress Stacks address
@param contractName Contract name
@return ApiGetContractInterfaceRequest

func (*SmartContractsAPIService) GetContractInterfaceExecute 

func (a *SmartContractsAPIService) GetContractInterfaceExecute(r ApiGetContractInterfaceRequest) (*models.ContractInterfaceResponse, *http.Response, error)

Execute executes the request 

@return ContractInterfaceResponse

func (*SmartContractsAPIService) GetContractSource 

func (a *SmartContractsAPIService) GetContractSource(ctx context.Context, contractAddress string, contractName string) ApiGetContractSourceRequest

GetContractSource Get contract source

Retrieves the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param contractAddress Stacks address
@param contractName Contract name
@return ApiGetContractSourceRequest

func (*SmartContractsAPIService) GetContractSourceExecute 

func (a *SmartContractsAPIService) GetContractSourceExecute(r ApiGetContractSourceRequest) (*models.ContractSourceResponse, *http.Response, error)

Execute executes the request 

@return ContractSourceResponse

func (*SmartContractsAPIService) GetContractsByTrait 

func (a *SmartContractsAPIService) GetContractsByTrait(ctx context.Context) ApiGetContractsByTraitRequest

GetContractsByTrait Get contracts by trait

Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetContractsByTraitRequest

func (*SmartContractsAPIService) GetContractsByTraitExecute 

func (a *SmartContractsAPIService) GetContractsByTraitExecute(r ApiGetContractsByTraitRequest) (*models.ContractListResponse, *http.Response, error)

Execute executes the request 

@return ContractListResponse

func (*SmartContractsAPIService) GetSmartContractsStatus 

func (a *SmartContractsAPIService) GetSmartContractsStatus(ctx context.Context) ApiGetSmartContractsStatusRequest

GetSmartContractsStatus Get smart contracts status

Retrieves the deployment status of multiple smart contracts. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetSmartContractsStatusRequest

func (*SmartContractsAPIService) GetSmartContractsStatusExecute 

func (a *SmartContractsAPIService) GetSmartContractsStatusExecute(r ApiGetSmartContractsStatusRequest) (*map[string]models.SmartContractsStatusResponse, *http.Response, error)

Execute executes the request 

@return map[string]SmartContractsStatusResponse

type StackingAPIService 

type StackingAPIService service

StackingAPIService StackingAPI service

func (*StackingAPIService) GetPoolDelegations 

func (a *StackingAPIService) GetPoolDelegations(ctx context.Context, poolPrincipal string) ApiGetPoolDelegationsRequest

GetPoolDelegations Stacking pool members

Retrieves the list of stacking pool members for a given delegator principal. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param poolPrincipal Address principal of the stacking pool delegator
@return ApiGetPoolDelegationsRequest

func (*StackingAPIService) GetPoolDelegationsExecute 

func (a *StackingAPIService) GetPoolDelegationsExecute(r ApiGetPoolDelegationsRequest) (*models.PoolDelegationsResponse, *http.Response, error)

Execute executes the request 

@return models.PoolDelegationsResponse

type StackingRewardsAPIService 

type StackingRewardsAPIService service

StackingRewardsAPIService StackingRewardsAPI service

func (*StackingRewardsAPIService) GetBurnchainRewardList 

func (a *StackingRewardsAPIService) GetBurnchainRewardList(ctx context.Context) ApiGetBurnchainRewardListRequest

GetBurnchainRewardList Get recent burnchain reward recipients

Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBurnchainRewardListRequest

func (*StackingRewardsAPIService) GetBurnchainRewardListByAddress 

func (a *StackingRewardsAPIService) GetBurnchainRewardListByAddress(ctx context.Context, address string) ApiGetBurnchainRewardListByAddressRequest

GetBurnchainRewardListByAddress Get recent burnchain reward for the given recipient

Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param address Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
@return ApiGetBurnchainRewardListByAddressRequest

func (*StackingRewardsAPIService) GetBurnchainRewardListByAddressExecute 

func (a *StackingRewardsAPIService) GetBurnchainRewardListByAddressExecute(r ApiGetBurnchainRewardListByAddressRequest) (*models.BurnchainRewardListResponse, *http.Response, error)

Execute executes the request 

@return BurnchainRewardListResponse

func (*StackingRewardsAPIService) GetBurnchainRewardListExecute 

func (a *StackingRewardsAPIService) GetBurnchainRewardListExecute(r ApiGetBurnchainRewardListRequest) (*models.BurnchainRewardListResponse, *http.Response, error)

Execute executes the request 

@return BurnchainRewardListResponse

func (*StackingRewardsAPIService) GetBurnchainRewardSlotHolders 

func (a *StackingRewardsAPIService) GetBurnchainRewardSlotHolders(ctx context.Context) ApiGetBurnchainRewardSlotHoldersRequest

GetBurnchainRewardSlotHolders Get recent reward slot holders

Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetBurnchainRewardSlotHoldersRequest

func (*StackingRewardsAPIService) GetBurnchainRewardSlotHoldersByAddress 

func (a *StackingRewardsAPIService) GetBurnchainRewardSlotHoldersByAddress(ctx context.Context, address string) ApiGetBurnchainRewardSlotHoldersByAddressRequest

GetBurnchainRewardSlotHoldersByAddress Get recent reward slot holder entries for the given address

Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param address Reward slot holder recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
@return ApiGetBurnchainRewardSlotHoldersByAddressRequest

func (*StackingRewardsAPIService) GetBurnchainRewardSlotHoldersByAddressExecute 

func (a *StackingRewardsAPIService) GetBurnchainRewardSlotHoldersByAddressExecute(r ApiGetBurnchainRewardSlotHoldersByAddressRequest) (*models.BurnchainRewardSlotHolderListResponse, *http.Response, error)

Execute executes the request 

@return BurnchainRewardSlotHolderListResponse

func (*StackingRewardsAPIService) GetBurnchainRewardSlotHoldersExecute 

func (a *StackingRewardsAPIService) GetBurnchainRewardSlotHoldersExecute(r ApiGetBurnchainRewardSlotHoldersRequest) (*models.BurnchainRewardSlotHolderListResponse, *http.Response, error)

Execute executes the request 

@return BurnchainRewardSlotHolderListResponse

func (*StackingRewardsAPIService) GetBurnchainRewardsTotalByAddress 

func (a *StackingRewardsAPIService) GetBurnchainRewardsTotalByAddress(ctx context.Context, address string) ApiGetBurnchainRewardsTotalByAddressRequest

GetBurnchainRewardsTotalByAddress Get total burnchain rewards for the given recipient

Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient `address` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param address Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format
@return ApiGetBurnchainRewardsTotalByAddressRequest

func (*StackingRewardsAPIService) GetBurnchainRewardsTotalByAddressExecute 

func (a *StackingRewardsAPIService) GetBurnchainRewardsTotalByAddressExecute(r ApiGetBurnchainRewardsTotalByAddressRequest) (*models.BurnchainRewardsTotal, *http.Response, error)

Execute executes the request 

@return BurnchainRewardsTotal

type TransactionsAPIService 

type TransactionsAPIService service

TransactionsAPIService TransactionsAPI service

func (*TransactionsAPIService) GetAddressMempoolTransactions 

func (a *TransactionsAPIService) GetAddressMempoolTransactions(ctx context.Context, address string) ApiGetAddressMempoolTransactionsRequest

GetAddressMempoolTransactions Transactions for address

Retrieves all transactions for a given address that are currently in mempool 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param address Transactions for the address
@return ApiGetAddressMempoolTransactionsRequest

func (*TransactionsAPIService) GetAddressMempoolTransactionsExecute 

func (a *TransactionsAPIService) GetAddressMempoolTransactionsExecute(r ApiGetAddressMempoolTransactionsRequest) (*models.MempoolTransactionListResponse, *http.Response, error)

Execute executes the request 

@return MempoolTransactionListResponse

func (*TransactionsAPIService) GetAddressTransactionEvents 

func (a *TransactionsAPIService) GetAddressTransactionEvents(ctx context.Context, address string, txId string) ApiGetAddressTransactionEventsRequest

GetAddressTransactionEvents Get events for an address transaction

Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param address STX address or Smart Contract ID
@param txId Transaction ID
@return ApiGetAddressTransactionEventsRequest

func (*TransactionsAPIService) GetAddressTransactionEventsExecute 

func (a *TransactionsAPIService) GetAddressTransactionEventsExecute(r ApiGetAddressTransactionEventsRequest) (*models.AddressTransactionEventListResponse, *http.Response, error)

Execute executes the request 

@return AddressTransactionEventListResponse

func (*TransactionsAPIService) GetAddressTransactions 

func (a *TransactionsAPIService) GetAddressTransactions(ctx context.Context, address string) ApiGetAddressTransactionsRequest

GetAddressTransactions Get address transactions

Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.

More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param address STX address or Smart Contract ID
@return ApiGetAddressTransactionsRequest

func (*TransactionsAPIService) GetAddressTransactionsExecute 

func (a *TransactionsAPIService) GetAddressTransactionsExecute(r ApiGetAddressTransactionsRequest) (*models.AddressTransactionsV2ListResponse, *http.Response, error)

Execute executes the request 

@return AddressTransactionsV2ListResponse

func (*TransactionsAPIService) GetDroppedMempoolTransactionList 

func (a *TransactionsAPIService) GetDroppedMempoolTransactionList(ctx context.Context) ApiGetDroppedMempoolTransactionListRequest

GetDroppedMempoolTransactionList Get dropped mempool transactions

Retrieves all recently-broadcast transactions that have been dropped from the mempool.

Transactions are dropped from the mempool if:

  • they were stale and awaiting garbage collection or,

  • were expensive, or

  • were replaced with a new fee

    @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiGetDroppedMempoolTransactionListRequest

func (*TransactionsAPIService) GetDroppedMempoolTransactionListExecute 

func (a *TransactionsAPIService) GetDroppedMempoolTransactionListExecute(r ApiGetDroppedMempoolTransactionListRequest) (*models.MempoolTransactionListResponse, *http.Response, error)

Execute executes the request 

@return models.MempoolTransactionListResponse

func (*TransactionsAPIService) GetFilteredEvents 

func (a *TransactionsAPIService) GetFilteredEvents(ctx context.Context) ApiGetFilteredEventsRequest

GetFilteredEvents Transaction Events

Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types. The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset'). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetFilteredEventsRequest

func (*TransactionsAPIService) GetFilteredEventsExecute 

func (a *TransactionsAPIService) GetFilteredEventsExecute(r ApiGetFilteredEventsRequest) (*models.TransactionEventsResponse, *http.Response, error)

Execute executes the request 

@return TransactionEventsResponse

func (*TransactionsAPIService) GetMempoolTransactionList 

func (a *TransactionsAPIService) GetMempoolTransactionList(ctx context.Context) ApiGetMempoolTransactionListRequest

GetMempoolTransactionList Get mempool transactions

Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.

If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetMempoolTransactionListRequest

func (*TransactionsAPIService) GetMempoolTransactionListExecute 

func (a *TransactionsAPIService) GetMempoolTransactionListExecute(r ApiGetMempoolTransactionListRequest) (*models.MempoolTransactionListResponse, *http.Response, error)

Execute executes the request 

@return MempoolTransactionListResponse

func (*TransactionsAPIService) GetMempoolTransactionStats 

func (a *TransactionsAPIService) GetMempoolTransactionStats(ctx context.Context) ApiGetMempoolTransactionStatsRequest

GetMempoolTransactionStats Get statistics for mempool transactions

Queries for transactions counts, age (by block height), fees (simple average), and size. All results broken down by transaction type and percentiles (p25, p50, p75, p95). 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetMempoolTransactionStatsRequest

func (*TransactionsAPIService) GetMempoolTransactionStatsExecute 

func (a *TransactionsAPIService) GetMempoolTransactionStatsExecute(r ApiGetMempoolTransactionStatsRequest) (*models.MempoolTransactionStatsResponse, *http.Response, error)

Execute executes the request 

@return MempoolTransactionStatsResponse

func (*TransactionsAPIService) GetRawTransactionById 

func (a *TransactionsAPIService) GetRawTransactionById(ctx context.Context, txId string) ApiGetRawTransactionByIdRequest

GetRawTransactionById Get Raw Transaction

Retrieves a hex encoded serialized transaction for a given ID 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param txId Hash of transaction
@return ApiGetRawTransactionByIdRequest

func (*TransactionsAPIService) GetRawTransactionByIdExecute 

func (a *TransactionsAPIService) GetRawTransactionByIdExecute(r ApiGetRawTransactionByIdRequest) (*models.GetRawTransactionResult, *http.Response, error)

Execute executes the request 

@return GetRawTransactionResult

func (*TransactionsAPIService) GetTransactionById 

func (a *TransactionsAPIService) GetTransactionById(ctx context.Context, txId string) ApiGetTransactionByIdRequest

GetTransactionById Get transaction

Retrieves transaction details for a given transaction ID

`import type { Transaction } from '@stacks/stacks-blockchain-api-types';` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param txId Hash of transaction
@return ApiGetTransactionByIdRequest

func (*TransactionsAPIService) GetTransactionByIdExecute 

func (a *TransactionsAPIService) GetTransactionByIdExecute(r ApiGetTransactionByIdRequest) (*models.Transaction, *http.Response, error)

Execute executes the request 

@return Transaction

func (*TransactionsAPIService) GetTransactionList 

func (a *TransactionsAPIService) GetTransactionList(ctx context.Context) ApiGetTransactionListRequest

GetTransactionList Get recent transactions

Retrieves all recently mined transactions

If using TypeScript, import typings for this response from our types package:

`import type { TransactionResults } from '@stacks/stacks-blockchain-api-types';` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetTransactionListRequest

func (*TransactionsAPIService) GetTransactionListExecute 

func (a *TransactionsAPIService) GetTransactionListExecute(r ApiGetTransactionListRequest) (*models.TransactionResults, *http.Response, error)

Execute executes the request 

@return TransactionResults

func (*TransactionsAPIService) GetTransactionsByBlock 

func (a *TransactionsAPIService) GetTransactionsByBlock(ctx context.Context, heightOrHash models.GetBurnBlockHeightOrHashParameter) ApiGetTransactionsByBlockRequest

GetTransactionsByBlock Get transactions by block

Retrieves transactions confirmed in a single block 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param heightOrHash filter by block height, hash, index block hash or the constant `latest` to filter for the most recent block
@return ApiGetTransactionsByBlockRequest

func (*TransactionsAPIService) GetTransactionsByBlockExecute 

func (a *TransactionsAPIService) GetTransactionsByBlockExecute(r ApiGetTransactionsByBlockRequest) (*models.TransactionResults, *http.Response, error)

Execute executes the request 

@return TransactionResults

func (*TransactionsAPIService) GetTransactionsByBlockHash 

func (a *TransactionsAPIService) GetTransactionsByBlockHash(ctx context.Context, blockHash string) ApiGetTransactionsByBlockHashRequest

GetTransactionsByBlockHash Transactions by block hash

**NOTE:** This endpoint is deprecated in favor of [Get transactions by block](/api/get-transactions-by-block).

Retrieves a list of all transactions within a block for a given block hash. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param blockHash Hash of block
@return ApiGetTransactionsByBlockHashRequest

Deprecated

func (*TransactionsAPIService) GetTransactionsByBlockHashExecute 

func (a *TransactionsAPIService) GetTransactionsByBlockHashExecute(r ApiGetTransactionsByBlockHashRequest) (*models.TransactionResults, *http.Response, error)

Execute executes the request 

@return TransactionResults

Deprecated

func (*TransactionsAPIService) GetTransactionsByBlockHeight 

func (a *TransactionsAPIService) GetTransactionsByBlockHeight(ctx context.Context, height int32) ApiGetTransactionsByBlockHeightRequest

GetTransactionsByBlockHeight Transactions by block height

**NOTE:** This endpoint is deprecated in favor of [Get transactions by block](/api/get-transactions-by-block).

Retrieves all transactions within a block at a given height 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param height Height of block
@return ApiGetTransactionsByBlockHeightRequest

Deprecated

func (*TransactionsAPIService) GetTransactionsByBlockHeightExecute 

func (a *TransactionsAPIService) GetTransactionsByBlockHeightExecute(r ApiGetTransactionsByBlockHeightRequest) (*models.TransactionResults, *http.Response, error)

Execute executes the request 

@return TransactionResults

Deprecated

func (*TransactionsAPIService) GetTxListDetails 

func (a *TransactionsAPIService) GetTxListDetails(ctx context.Context) ApiGetTxListDetailsRequest

GetTxListDetails Get list of details for transactions

Retrieves a list of transactions for a given list of transaction IDs

If using TypeScript, import typings for this response from our types package:

`import type { Transaction } from '@stacks/stacks-blockchain-api-types';` 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetTxListDetailsRequest

func (*TransactionsAPIService) GetTxListDetailsExecute 

func (a *TransactionsAPIService) GetTxListDetailsExecute(r ApiGetTxListDetailsRequest) (*map[string]models.TransactionList, *http.Response, error)

Execute executes the request 

@return map[string]TransactionList

func (*TransactionsAPIService) PostCoreNodeTransactions 

func (a *TransactionsAPIService) PostCoreNodeTransactions(ctx context.Context) ApiPostCoreNodeTransactionsRequest

PostCoreNodeTransactions Broadcast raw transaction

Broadcasts raw transactions on the network. You can use the [@stacks/transactions](https://github.com/blockstack/stacks.js) project to generate a raw transaction payload. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiPostCoreNodeTransactionsRequest

func (*TransactionsAPIService) PostCoreNodeTransactionsExecute 

func (a *TransactionsAPIService) PostCoreNodeTransactionsExecute(r ApiPostCoreNodeTransactionsRequest) (string, *http.Response, error)

Execute executes the request 

@return string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.