Skip to main content
POST
getQuote

Understanding getQuote

  • getQuote calculates and returns the quote price for the swap (the amount of toTokenAddress tokens you’ll receive) alongside details about the swap. It takes:
    • address - string.
    • Swap information object:
      • fromTokenAddress - string.
      • toTokenAddress - string.
      • amount - string.

Query example

JSON

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request to get a quote for a token swap.

jsonrpc
string
default:2.0
required

Version of the JSON-RPC protocol, should be 2.0.

Example:

"2.0"

id
integer
default:1
required

The request identifier.

Example:

1

method
enum<string>
required

API method being called.

Available options:
particle_swap_getQuote
params
(string | object)[]
required

Parameters for getting a swap quote.

User address.

Example:

"0x369aa8a7a7BE683E1a46d9A056806B2B3FD778C8"

chainId
integer

The blockchain chain ID.

Example:

1

Response

200 - application/json

Successful response with swap quote.

jsonrpc
string
default:2.0
required

Version of the JSON-RPC protocol, should be 2.0.

Example:

"2.0"

id
integer
default:1
required

The request identifier.

Example:

1

result
object
required

Swap quote details.

chainId
integer

The blockchain chain ID.

Example:

1