\FeesAPI

July 14, 2024 ยท View on GitHub

MethodHTTP requestDescription
FetchFeeRatePost /extended/v1/fee_rateFetch fee rate
GetFeeTransferGet /v2/fees/transferGet estimated fee
PostFeeTransactionPost /v2/fees/transactionGet approximate fees for a given transaction

FetchFeeRate

FeeRate FetchFeeRate(ctx).FeeRateRequest(feeRateRequest).Execute()

Fetch fee rate

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/cbadawi/go-stacks"
)

func main() {
	feeRateRequest := *openapiclient.NewFeeRateRequest("Transaction_example") // FeeRateRequest | 

	configuration :=config.NewConfiguration()
	apiClient := NewAPIClient(configuration)
	resp, r, err := apiClient.FeesAPI.FetchFeeRate(context.Background()).FeeRateRequest(feeRateRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FeesAPI.FetchFeeRate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `FetchFeeRate`: FeeRate
	fmt.Fprintf(os.Stdout, "Response from `FeesAPI.FetchFeeRate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiFetchFeeRateRequest struct via the builder pattern

NameTypeDescriptionNotes
feeRateRequestFeeRateRequest

Return type

FeeRate

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetFeeTransfer

map[string]interface{} GetFeeTransfer(ctx).Execute()

Get estimated fee

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/cbadawi/go-stacks"
)

func main() {

	configuration :=config.NewConfiguration()
	apiClient := NewAPIClient(configuration)
	resp, r, err := apiClient.FeesAPI.GetFeeTransfer(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FeesAPI.GetFeeTransfer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetFeeTransfer`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `FeesAPI.GetFeeTransfer`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetFeeTransferRequest struct via the builder pattern

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostFeeTransaction

TransactionFeeEstimateResponse PostFeeTransaction(ctx).TransactionFeeEstimateRequest(transactionFeeEstimateRequest).Execute()

Get approximate fees for a given transaction

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/cbadawi/go-stacks"
)

func main() {
	transactionFeeEstimateRequest := *openapiclient.NewTransactionFeeEstimateRequest("TransactionPayload_example") // TransactionFeeEstimateRequest |  (optional)

	configuration :=config.NewConfiguration()
	apiClient := NewAPIClient(configuration)
	resp, r, err := apiClient.FeesAPI.PostFeeTransaction(context.Background()).TransactionFeeEstimateRequest(transactionFeeEstimateRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FeesAPI.PostFeeTransaction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostFeeTransaction`: TransactionFeeEstimateResponse
	fmt.Fprintf(os.Stdout, "Response from `FeesAPI.PostFeeTransaction`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPostFeeTransactionRequest struct via the builder pattern

NameTypeDescriptionNotes
transactionFeeEstimateRequestTransactionFeeEstimateRequest

Return type

TransactionFeeEstimateResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]