SwapQuote

Quote data captured when the swap was created.

inputAmount objectrequired

Input source amount that will be paid by the user (including fees, but excluding source network fees).

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000

decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

outputAmount objectrequired

Output destination amount that will be paid out to the user.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000

decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

fees objectrequired

Fee breakdown included in the quote.

swap objectrequired

Swap service fee (charged in source token).

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000

decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

networkOutput object

Swap fee to cover the transaction network fees on the destination side (charged in source token).

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000

decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

expiryint64required

Quote expiration timestamp in milliseconds since Unix epoch.

outputAddressstringrequired

Output address of the swap, the destination tokens will be sent here.

SwapQuote

{
  "inputAmount": {
    "amount": "string",
    "rawAmount": "1500000000000000000",
    "decimals": 0,
    "symbol": "string",
    "chain": "string"
  },
  "outputAmount": {
    "amount": "string",
    "rawAmount": "1500000000000000000",
    "decimals": 0,
    "symbol": "string",
    "chain": "string"
  },
  "fees": {
    "swap": {
      "amount": "string",
      "rawAmount": "1500000000000000000",
      "decimals": 0,
      "symbol": "string",
      "chain": "string"
    },
    "networkOutput": {
      "amount": "string",
      "rawAmount": "1500000000000000000",
      "decimals": 0,
      "symbol": "string",
      "chain": "string"
    }
  },
  "expiry": 0,
  "outputAddress": "string"
}