Struct GetSwapPriceResponse 

pub struct GetSwapPriceResponse {
    pub block_number: GetSwapPriceResponseBlockNumber,
    pub fees: GetSwapPriceResponseFees,
    pub from_amount: GetSwapPriceResponseFromAmount,
    pub from_token: GetSwapPriceResponseFromToken,
    pub gas: Option<GetSwapPriceResponseGas>,
    pub gas_price: GetSwapPriceResponseGasPrice,
    pub issues: GetSwapPriceResponseIssues,
    pub liquidity_available: bool,
    pub min_to_amount: GetSwapPriceResponseMinToAmount,
    pub to_amount: GetSwapPriceResponseToAmount,
    pub to_token: GetSwapPriceResponseToToken,
}

GetSwapPriceResponse

JSON schema

{
 "title": "GetSwapPriceResponse",
 "allOf": [
   {
     "$ref": "#/components/schemas/CommonSwapResponse"
   },
   {
     "type": "object",
     "required": [
       "gas",
       "gasPrice"
     ],
     "properties": {
       "gas": {
         "description": "The estimated gas limit that should be used to send the transaction to guarantee settlement.",
         "examples": [
           "100000"
         ],
         "type": [
           "string",
           "null"
         ],
         "pattern": "^\\d+$"
       },
       "gasPrice": {
         "description": "The gas price, in Wei, that should be used to send the transaction. For EIP-1559 transactions, this value should be seen as the `maxFeePerGas` value. The transaction should be sent with this gas price to guarantee settlement.",
         "examples": [
           "1000000000"
         ],
         "type": "string",
         "pattern": "^\\d+$"
       }
     }
   }
 ]
}

Fields

block_number: GetSwapPriceResponseBlockNumber

The block number at which the liquidity conditions were examined.

fees: GetSwapPriceResponseFees

from_amount: GetSwapPriceResponseFromAmount

The amount of the fromToken that will be sent in this swap, in atomic units of the fromToken. For example, 1000000000000000000 when sending ETH equates to 1 ETH, 1000000 when sending USDC equates to 1 USDC, etc.

from_token: GetSwapPriceResponseFromToken

The 0x-prefixed contract address of the token that will be sent.

gas: Option<GetSwapPriceResponseGas>

The estimated gas limit that should be used to send the transaction to guarantee settlement.

gas_price: GetSwapPriceResponseGasPrice

The gas price, in Wei, that should be used to send the transaction. For EIP-1559 transactions, this value should be seen as the maxFeePerGas value. The transaction should be sent with this gas price to guarantee settlement.

issues: GetSwapPriceResponseIssues

liquidity_available: bool

Whether sufficient liquidity is available to settle the swap. All other fields in the response will be empty if this is false.

min_to_amount: GetSwapPriceResponseMinToAmount

The minimum amount of the toToken that must be received for the swap to succeed, in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc. This value is influenced by the slippageBps parameter.

to_amount: GetSwapPriceResponseToAmount

The amount of the toToken that will be received in atomic units of the toToken. For example, 1000000000000000000 when receiving ETH equates to 1 ETH, 1000000 when receiving USDC equates to 1 USDC, etc.

to_token: GetSwapPriceResponseToToken

The 0x-prefixed contract address of the token that will be received.

Implementations

impl GetSwapPriceResponse

pub fn builder() -> GetSwapPriceResponse

Trait Implementations

impl Clone for GetSwapPriceResponse

fn clone(&self) -> GetSwapPriceResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetSwapPriceResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetSwapPriceResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&GetSwapPriceResponse> for GetSwapPriceResponse

fn from(value: &GetSwapPriceResponse) -> Self

Converts to this type from the input type.

impl From<GetSwapPriceResponse> for GetSwapPriceResponse

fn from(value: GetSwapPriceResponse) -> Self

Converts to this type from the input type.

impl From<GetSwapPriceResponse> for GetSwapPriceResponseWrapper

fn from(value: GetSwapPriceResponse) -> Self

Converts to this type from the input type.

impl Serialize for GetSwapPriceResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<GetSwapPriceResponse> for GetSwapPriceResponse

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: GetSwapPriceResponse) -> Result<Self, ConversionError>

Performs the conversion.