balances

package
v2.6.0 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountBalance

type AccountBalance struct {
	Descriptor        string          `json:"descriptor,omitempty"`
	CurrencyAccountId string          `json:"currency_account_id,omitempty"`
	HoldingCurrency   common.Currency `json:"holding_currency,omitempty"`
	BalancesAsOf      *time.Time      `json:"balances_as_of,omitempty"`
	Balances          Balances        `json:"balances,omitempty"`
}

QueryResponse

type Balances

type Balances struct {
	Pending             int64                `json:"pending,omitempty"`
	Available           int64                `json:"available,omitempty"`
	Payable             int64                `json:"payable,omitempty"`
	Collateral          int64                `json:"collateral,omitempty"`
	Operational         int64                `json:"operational,omitempty"`
	CollateralBreakdown *CollateralBreakdown `json:"collateral_breakdown,omitempty"`
}

QueryResponse

type Client

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

func NewClient

func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client

func (*Client) RetrieveEntityBalances

func (c *Client) RetrieveEntityBalances(entityId string, query QueryFilter) (*QueryResponse, error)

func (*Client) RetrieveEntityBalancesWithContext

func (c *Client) RetrieveEntityBalancesWithContext(
	ctx context.Context,
	entityId string,
	query QueryFilter,
) (*QueryResponse, error)

type CollateralBreakdown added in v2.4.0

type CollateralBreakdown struct {
	FixedReserve   int64 `json:"fixed_reserve,omitempty"`
	RollingReserve int64 `json:"rolling_reserve,omitempty"`
}

QueryResponse

type QueryFilter

type QueryFilter struct {
	Query                 string     `url:"query,omitempty"`
	WithCurrencyAccountId bool       `url:"withCurrencyAccountId,omitempty"`
	BalancesAt            *time.Time `url:"balancesAt,omitempty"`
}

type QueryResponse

type QueryResponse struct {
	HttpMetadata common.HttpMetadata
	Data         []AccountBalance `json:"data,omitempty"`
}

QueryResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL