Generate a swap quote

Returns a swap/bridge quote for the given token pair without creating any transaction state. Supports both fromAmount and toAmount (mutually exclusive).

POST /sdk/{environmentId}/swap/quote

Generate a swap quote

cURL

curl --request POST \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": {
    "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
    "chainId": "An example name",
    "tokenAddress": "An example name",
    "amount": "<string>"
  },
  "to": {
    "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
    "chainId": "An example name",
    "tokenAddress": "An example name",
    "amount": "<string>"
  },
  "maxPriceImpact": 0.5,
  "slippage": 0.5
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote"

payload = {
    "from": {
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "chainId": "An example name",
        "tokenAddress": "An example name",
        "amount": "<string>"
    },
    "to": {
        "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
        "chainId": "An example name",
        "tokenAddress": "An example name",
        "amount": "<string>"
    },
    "maxPriceImpact": 0.5,
    "slippage": 0.5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: {
      address: '0xbF394748301603f18d953C90F0b087CBEC0E1834',
      chainId: 'An example name',
      tokenAddress: 'An example name',
      amount: '<string>'
    },
    to: {
      address: '0xbF394748301603f18d953C90F0b087CBEC0E1834',
      chainId: 'An example name',
      tokenAddress: 'An example name',
      amount: '<string>'
    },
    maxPriceImpact: 0.5,
    slippage: 0.5
  })
};

fetch('https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => [
        'address' => '0xbF394748301603f18d953C90F0b087CBEC0E1834',
        'chainId' => 'An example name',
        'tokenAddress' => 'An example name',
        'amount' => '<string>'
    ],
    'to' => [
        'address' => '0xbF394748301603f18d953C90F0b087CBEC0E1834',
        'chainId' => 'An example name',
        'tokenAddress' => 'An example name',
        'amount' => '<string>'
    ],
    'maxPriceImpact' => 0.5,
    'slippage' => 0.5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote"

	payload := strings.NewReader("{\n  \"from\": {\n    \"address\": \"0xbF394748301603f18d953C90F0b087CBEC0E1834\",\n    \"chainId\": \"An example name\",\n    \"tokenAddress\": \"An example name\",\n    \"amount\": \"<string>\"\n  },\n  \"to\": {\n    \"address\": \"0xbF394748301603f18d953C90F0b087CBEC0E1834\",\n    \"chainId\": \"An example name\",\n    \"tokenAddress\": \"An example name\",\n    \"amount\": \"<string>\"\n  },\n  \"maxPriceImpact\": 0.5,\n  \"slippage\": 0.5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": {\n    \"address\": \"0xbF394748301603f18d953C90F0b087CBEC0E1834\",\n    \"chainId\": \"An example name\",\n    \"tokenAddress\": \"An example name\",\n    \"amount\": \"<string>\"\n  },\n  \"to\": {\n    \"address\": \"0xbF394748301603f18d953C90F0b087CBEC0E1834\",\n    \"chainId\": \"An example name\",\n    \"tokenAddress\": \"An example name\",\n    \"amount\": \"<string>\"\n  },\n  \"maxPriceImpact\": 0.5,\n  \"slippage\": 0.5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/sdk/{environmentId}/swap/quote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": {\n    \"address\": \"0xbF394748301603f18d953C90F0b087CBEC0E1834\",\n    \"chainId\": \"An example name\",\n    \"tokenAddress\": \"An example name\",\n    \"amount\": \"<string>\"\n  },\n  \"to\": {\n    \"address\": \"0xbF394748301603f18d953C90F0b087CBEC0E1834\",\n    \"chainId\": \"An example name\",\n    \"tokenAddress\": \"An example name\",\n    \"amount\": \"<string>\"\n  },\n  \"maxPriceImpact\": 0.5,\n  \"slippage\": 0.5\n}"

response = http.request(request)
puts response.read_body

200

{
  "from": {
    "address": "<string>",
    "amount": "<string>",
    "token": {
      "address": "<string>",
      "chainId": "<string>",
      "decimals": 123,
      "name": "<string>",
      "symbol": "<string>",
      "coinKey": "<string>",
      "logoURI": "<string>",
      "priceUSD": "<string>"
    },
    "amountMin": "<string>",
    "amountUSD": "<string>"
  },
  "id": "<string>",
  "steps": [
    {
      "from": {
        "amount": "<string>",
        "token": {
          "address": "<string>",
          "chainId": "<string>",
          "decimals": 123,
          "name": "<string>",
          "symbol": "<string>",
          "coinKey": "<string>",
          "logoURI": "<string>",
          "priceUSD": "<string>"
        },
        "amountMin": "<string>",
        "amountUSD": "<string>"
      },
      "id": "<string>",
      "to": {
        "amount": "<string>",
        "token": {
          "address": "<string>",
          "chainId": "<string>",
          "decimals": 123,
          "name": "<string>",
          "symbol": "<string>",
          "coinKey": "<string>",
          "logoURI": "<string>",
          "priceUSD": "<string>"
        },
        "amountMin": "<string>",
        "amountUSD": "<string>"
      },
      "tool": "<string>",
      "type": "<string>",
      "feeCosts": [
        {
          "amount": "<string>",
          "included": true,
          "name": "<string>",
          "token": {
            "address": "<string>",
            "chainId": "<string>",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "coinKey": "<string>",
            "logoURI": "<string>",
            "priceUSD": "<string>"
          },
          "amountUSD": "<string>"
        }
      ],
      "gasCosts": [
        {
          "amount": "<string>",
          "token": {
            "address": "<string>",
            "chainId": "<string>",
            "decimals": 123,
            "name": "<string>",
            "symbol": "<string>",
            "coinKey": "<string>",
            "logoURI": "<string>",
            "priceUSD": "<string>"
          },
          "amountUSD": "<string>"
        }
      ]
    }
  ],
  "to": {
    "address": "<string>",
    "amount": "<string>",
    "token": {
      "address": "<string>",
      "chainId": "<string>",
      "decimals": 123,
      "name": "<string>",
      "symbol": "<string>",
      "coinKey": "<string>",
      "logoURI": "<string>",
      "priceUSD": "<string>"
    },
    "amountMin": "<string>",
    "amountUSD": "<string>"
  },
  "approvalAddress": "<string>",
  "feeCosts": [
    {
      "amount": "<string>",
      "included": true,
      "name": "<string>",
      "token": {
        "address": "<string>",
        "chainId": "<string>",
        "decimals": 123,
        "name": "<string>",
        "symbol": "<string>",
        "coinKey": "<string>",
        "logoURI": "<string>",
        "priceUSD": "<string>"
      },
      "amountUSD": "<string>"
    }
  ],
  "gasCostUSD": "<string>",
  "signingPayload": {
    "chainId": "<string>",
    "evmTransaction": {
      "to": "<string>",
      "data": "<string>",
      "value": "<string>",
      "gasLimit": "<string>",
      "gasPrice": "<string>",
      "maxFeePerGas": "<string>",
      "maxPriorityFeePerGas": "<string>",
      "nonce": 123
    },
    "evmApproval": {
      "tokenAddress": "<string>",
      "spenderAddress": "<string>",
      "amount": "<string>"
    },
    "serializedTransaction": "<string>",
    "psbt": "<string>",
    "tronTransaction": {
      "rawDataHex": "<string>",
      "to": "<string>",
      "value": "<string>"
    }
  }
}

{
  "error": "<string>"
}

{
  "error": "Resources already exists for this Object",
  "payload": {
    "email": "[e-mail]",
    "embeddedWalletName": "<string>",
    "mergeConflicts": {
      "fromUser": {
        "id": "95b11417-f18f-457f-8804-68e361f9164f",
        "projectEnvironmentId": "95b11417-f18f-457f-8804-68e361f9164f",
        "verifiedCredentials": [
          {
            "id": "95b11417-f18f-457f-8804-68e361f9164f",
            "signInEnabled": true,
            "address": "0xbF394748301603f18d953C90F0b087CBEC0E1834",
            "chain": "<string>",
            "refId": "95b11417-f18f-457f-8804-68e361f9164f",
            "signerRefId": "95b11417-f18f-457f-8804-68e361f9164f",
            "email": "[e-mail]",
            "name_service": {
              "avatar": "<string>",
              "name": "<string>"
            },
            "public_identifier": "<string>",
            "wallet_name": "<string>",
            "wallet_properties": {
              "turnkeySubOrganizationId": "95b11417-f18f-457f-8804-68e361f9164f",
              "turnkeyPrivateKeyId": "95b11417-f18f-457f-8804-68e361f9164f",
              "turnkeyHDWalletId": "95b11417-f18f-457f-8804-68e361f9164f",
              "isAuthenticatorAttached": true,
              "turnkeyUserId": "95b11417-f18f-457f-8804-68e361f9164f",
              "isSessionKeyCompatible": true
            },
            "business_account_properties": {
              "businessAccountId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountCreatedAt": "2023-11-07T05:31:56Z",
              "businessAccountSignerId": "95b11417-f18f-457f-8804-68e361f9164f",
              "businessAccountName": "<string>",
              "businessAccountExternalRef": "<string>"
            },
            "oauth_username": "<string>",
            "oauth_display_name": "<string>",
            "oauth_account_id": "<string>",
            "phoneNumber": "9171113333",
            "phoneCountryCode": "1",
            "isoCountryCode": "US",
            "oauth_account_photos": [
              "<string>"
            ],
            "oauth_emails": [
              "<string>"
            ],
            "oauth_metadata": {},
            "previous_users": [
              "95b11417-f18f-457f-8804-68e361f9164f"
            ],
            "embedded_wallet_id": "<string>",
            "wallet_additional_addresses": [
              {
                "address": "<string>",
                "publicKey": "<string>",
                "network": "<string>"
              }
            ],
            "lastSelectedAt": "2023-11-07T05:31:56Z",
            "verifiedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "lastVerifiedCredentialId": "95b11417-f18f-457f-8804-68e361f9164f",
        "sessionId": "95b11417-f18f-457f-8804-68e361f9164f",
        "alias": "An example name",
        "country": "US",
        "email": "[e-mail]",
        "firstName": "An example name",
        "jobTitle": "An example name",
        "lastName": "An example name",
        "phoneNumber": "<string>",
        "policiesConsent": true,
        "tShirtSize": "An example name",
        "team": "An example name",
        "username": "An example name",
        "firstVisit": "2023-11-07T05:31:56Z",
        "lastVisit": "2023-11-07T05:31:56Z",
        "newUser": true,
        "metadata": {},
        "btcWallet": "<string>",
        "kdaWallet": "<string>",
        "ltcWallet": "<string>",
        "ckbWallet": "<string>",
        "kasWallet": "<string>",
        "dogeWallet": "<string>",
        "emailNotification": true,
        "discordNotification": true,
        "newsletterNotification": true,
        "lists": [
          "<string>"
        ],
        "scope": "superuser marketing operations",
        "missingFields": [
          {
            "name": "<string>",
            "required": true,
            "enabled": true,
            "unique": true,
            "verify": true,
            "validationRules": {
              "unique": true,
              "regex": "^0x",
              "validOptions": [
                {
                  "label": "small"
                },
                {
                  "label": "medium"
                },
                {
                  "label": "large"
                }
              ],
              "checkboxText": "Agree to the terms and conditions"
            },
            "label": "<string>",
            "position": 123
          }
        ]
      },
      "conflicts": [
        {
          "field": {
            "name": "<string>",
            "required": true,
            "enabled": true,
            "unique": true,
            "verify": true,
            "validationRules": {
              "unique": true,
              "regex": "^0x",
              "validOptions": [
                {
                  "label": "small"
                },
                {
                  "label": "medium"
                },
                {
                  "label": "large"
                }
              ],
              "checkboxText": "Agree to the terms and conditions"
            },
            "label": "<string>",
            "position": 123
          },
          "fromUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          },
          "currentUser": {
            "userId": "95b11417-f18f-457f-8804-68e361f9164f",
            "value": "An example name"
          }
        }
      ]
    },
    "additionalMessages": [
      "<string>"
    ]
  }
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

from · object · required

Show child attributes

to · object · required

Show child attributes

maxPriceImpact · number

The price impact threshold above which routes are hidden. As an example, one should specify 0.15 (15%) to hide routes with more than 15% price impact. The default is 10%.

Required range: 0 <= x <= 1

order · enum<string>

Route optimization preference.

Available options: CHEAPEST, FASTEST

slippage · number

Slippage tolerance (e.g. 0.005 for 0.5%)

Required range: 0 <= x <= 1

Response

200

application/json

Swap quote

from · object · required

Show child attributes

id · string · required

Unique identifier of the swap quote

steps · object[] · required

List of steps required to execute the swap

Show child attributes

to · object · required

Show child attributes

approvalAddress · string

Address that needs token approval (spender), if applicable

feeCosts · object[]

List of fee costs associated with the swap

Show child attributes

gasCostUSD · string

Total estimated gas cost in USD

signingPayload · object

Chain-aware signing payload. Which fields are populated depends on chainName: EVM uses evmTransaction + optional evmApproval. SOL and SUI use serializedTransaction. BTC uses psbt. TRON uses tronTransaction.

Show child attributes