stellar-sdk/com.soneso.stellar.sdk.horizon.responses/TradeResponse

TradeResponse

@Serializable

data class TradeResponse(val id: String, val pagingToken: String, val ledgerCloseTime: String, val tradeType: String, val offerId: Long? = null, val liquidityPoolFeeBP: Int? = null, val baseLiquidityPoolId: String? = null, val baseOfferId: Long? = null, val baseAccount: String? = null, val baseAmount: String, val baseAssetType: String, val baseAssetCode: String? = null, val baseAssetIssuer: String? = null, val counterLiquidityPoolId: String? = null, val counterOfferId: Long? = null, val counterAccount: String? = null, val counterAmount: String, val counterAssetType: String, val counterAssetCode: String? = null, val counterAssetIssuer: String? = null, val baseIsSeller: Boolean? = null, val price: Price? = null, val links: TradeResponse.Links) : Response, Pageable

Represents a trade response from the Horizon API.

A trade represents an exchange of assets between two parties on the Stellar network. Trades can occur between two offers (orderbook trades) or between an offer and a liquidity pool.

Constructors

TradeResponse

constructor(id: String, pagingToken: String, ledgerCloseTime: String, tradeType: String, offerId: Long? = null, liquidityPoolFeeBP: Int? = null, baseLiquidityPoolId: String? = null, baseOfferId: Long? = null, baseAccount: String? = null, baseAmount: String, baseAssetType: String, baseAssetCode: String? = null, baseAssetIssuer: String? = null, counterLiquidityPoolId: String? = null, counterOfferId: Long? = null, counterAccount: String? = null, counterAmount: String, counterAssetType: String, counterAssetCode: String? = null, counterAssetIssuer: String? = null, baseIsSeller: Boolean? = null, price: Price? = null, links: TradeResponse.Links)

Types

Links

@Serializable

data class Links(val base: Link, val counter: Link, val operation: Link)

HAL links connected to this trade.

Properties

baseAccount

@SerialName(value = "base_account")

val baseAccount: String?

The account ID of the base party in this trade

baseAmount

@SerialName(value = "base_amount")

val baseAmount: String

The amount of the base asset that was moved from base to counter

baseAssetCode

@SerialName(value = "base_asset_code")

val baseAssetCode: String?

The code of the base asset (null for native)

baseAssetIssuer

@SerialName(value = "base_asset_issuer")

val baseAssetIssuer: String?

The issuer of the base asset (null for native)

baseAssetType

@SerialName(value = "base_asset_type")

val baseAssetType: String

The type of asset on the base side (native, credit_alphanum4, credit_alphanum12)

baseIsSeller

@SerialName(value = "base_is_seller")

val baseIsSeller: Boolean?

Indicates which party is the seller (true if base is seller)

baseLiquidityPoolId

@SerialName(value = "base_liquidity_pool_id")

val baseLiquidityPoolId: String?

The liquidity pool ID for the base side (for liquidity pool trades)

baseOfferId

@SerialName(value = "base_offer_id")

val baseOfferId: Long?

The offer ID of the base account

counterAccount

@SerialName(value = "counter_account")

val counterAccount: String?

The account ID of the counter party in this trade

counterAmount

@SerialName(value = "counter_amount")

val counterAmount: String

The amount of the counter asset that was moved from counter to base

counterAssetCode

@SerialName(value = "counter_asset_code")

val counterAssetCode: String?

The code of the counter asset (null for native)

counterAssetIssuer

@SerialName(value = "counter_asset_issuer")

val counterAssetIssuer: String?

The issuer of the counter asset (null for native)

counterAssetType

@SerialName(value = "counter_asset_type")

val counterAssetType: String

The type of asset on the counter side (native, credit_alphanum4, credit_alphanum12)

counterLiquidityPoolId

@SerialName(value = "counter_liquidity_pool_id")

val counterLiquidityPoolId: String?

The liquidity pool ID for the counter side (for liquidity pool trades)

counterOfferId

@SerialName(value = "counter_offer_id")

val counterOfferId: Long?

The offer ID of the counter account

@SerialName(value = "id")

val id: String

Unique identifier for this trade

ledgerCloseTime

@SerialName(value = "ledger_close_time")

val ledgerCloseTime: String

An ISO 8601 formatted string of when the ledger with this trade was closed

links

@SerialName(value = "_links")

val links: TradeResponse.Links

HAL links related to this trade

liquidityPoolFeeBP

@SerialName(value = "liquidity_pool_fee_bp")

val liquidityPoolFeeBP: Int?

The liquidity pool fee in basis points (for liquidity pool trades)

offerId

@SerialName(value = "offer_id")

val offerId: Long?

The offer ID (for backwards compatibility, deprecated - use baseOfferId or counterOfferId)

pagingToken

@SerialName(value = "paging_token")

open override val pagingToken: String

A cursor value for use in pagination

price

@SerialName(value = "price")

val price: Price?

The original offer price (counter / base)

tradeType

@SerialName(value = "trade_type")

val tradeType: String

The type of trade (orderbook, liquidity_pool)

TradeResponse

See also

Constructors

Types

Properties