Create Swap Quote

JavaScript

import Whop from '@whop/sdk';

const client = new Whop();

const response = await client.swaps.createQuote({
  amount: '100',
  from_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  to_token: '0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193',
});

console.log(response.bridge_fee);

curl --request POST \
  --url https://api.whop.com/api/v1/swaps/quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "100",
  "from_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "to_token": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
  "from_address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
  "from_chain": "plasma",
  "metadata": {
    "external_id": "shop_4417"
  },
  "slippage_bps": 50,
  "to_address": "0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c",
  "to_chain": "plasma"
}
'

import requests

url = "https://api.whop.com/api/v1/swaps/quote"

payload = {
    "amount": "100",
    "from_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "to_token": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
    "from_address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
    "from_chain": "plasma",
    "metadata": { "external_id": "shop_4417" },
    "slippage_bps": 50,
    "to_address": "0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c",
    "to_chain": "plasma"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/swaps/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([
    'amount' => '100',
    'from_token' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    'to_token' => '0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193',
    'from_address' => '0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80',
    'from_chain' => 'plasma',
    'metadata' => [
        'external_id' => 'shop_4417'
    ],
    'slippage_bps' => 50,
    'to_address' => '0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c',
    'to_chain' => 'plasma'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.whop.com/api/v1/swaps/quote"

	payload := strings.NewReader("{\n  \"amount\": \"100\",\n  \"from_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"to_token\": \"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193\",\n  \"from_address\": \"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80\",\n  \"from_chain\": \"plasma\",\n  \"metadata\": {\n    \"external_id\": \"shop_4417\"\n  },\n  \"slippage_bps\": 50,\n  \"to_address\": \"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c\",\n  \"to_chain\": \"plasma\"\n}")

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

	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://api.whop.com/api/v1/swaps/quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100\",\n  \"from_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"to_token\": \"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193\",\n  \"from_address\": \"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80\",\n  \"from_chain\": \"plasma\",\n  \"metadata\": {\n    \"external_id\": \"shop_4417\"\n  },\n  \"slippage_bps\": 50,\n  \"to_address\": \"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c\",\n  \"to_chain\": \"plasma\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/swaps/quote")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"100\",\n  \"from_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"to_token\": \"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193\",\n  \"from_address\": \"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80\",\n  \"from_chain\": \"plasma\",\n  \"metadata\": {\n    \"external_id\": \"shop_4417\"\n  },\n  \"slippage_bps\": 50,\n  \"to_address\": \"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c\",\n  \"to_chain\": \"plasma\"\n}"

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

{
  "amount_in": "100",
  "amount_out": "0.15",
  "fee_bps": 100,
  "from_token": {
    "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "chain_id": 9745,
    "decimals": 6,
    "network": "plasma",
    "symbol": "USDT"
  },
  "metadata": {
    "external_id": "shop_4417"
  },
  "object": "swap_quote",
  "rate": "1.5",
  "to_token": {
    "address": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
    "chain_id": 9745,
    "decimals": 6,
    "network": "plasma",
    "symbol": "XAUT"
  },
  "amount_out_min": "0.148",
  "bridge_fee": "0.25",
  "estimated_duration_seconds": 30,
  "from_address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
  "requires_token_approval": true,
  "to_address": "0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

POST

swaps

quote

JavaScript

import Whop from '@whop/sdk';

const client = new Whop();

const response = await client.swaps.createQuote({
  amount: '100',
  from_token: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  to_token: '0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193',
});

console.log(response.bridge_fee);

curl --request POST \
  --url https://api.whop.com/api/v1/swaps/quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "100",
  "from_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "to_token": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
  "from_address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
  "from_chain": "plasma",
  "metadata": {
    "external_id": "shop_4417"
  },
  "slippage_bps": 50,
  "to_address": "0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c",
  "to_chain": "plasma"
}
'

import requests

url = "https://api.whop.com/api/v1/swaps/quote"

payload = {
    "amount": "100",
    "from_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "to_token": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
    "from_address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
    "from_chain": "plasma",
    "metadata": { "external_id": "shop_4417" },
    "slippage_bps": 50,
    "to_address": "0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c",
    "to_chain": "plasma"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/swaps/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([
    'amount' => '100',
    'from_token' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    'to_token' => '0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193',
    'from_address' => '0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80',
    'from_chain' => 'plasma',
    'metadata' => [
        'external_id' => 'shop_4417'
    ],
    'slippage_bps' => 50,
    'to_address' => '0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c',
    'to_chain' => 'plasma'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.whop.com/api/v1/swaps/quote"

	payload := strings.NewReader("{\n  \"amount\": \"100\",\n  \"from_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"to_token\": \"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193\",\n  \"from_address\": \"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80\",\n  \"from_chain\": \"plasma\",\n  \"metadata\": {\n    \"external_id\": \"shop_4417\"\n  },\n  \"slippage_bps\": 50,\n  \"to_address\": \"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c\",\n  \"to_chain\": \"plasma\"\n}")

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

	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://api.whop.com/api/v1/swaps/quote")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"100\",\n  \"from_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"to_token\": \"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193\",\n  \"from_address\": \"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80\",\n  \"from_chain\": \"plasma\",\n  \"metadata\": {\n    \"external_id\": \"shop_4417\"\n  },\n  \"slippage_bps\": 50,\n  \"to_address\": \"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c\",\n  \"to_chain\": \"plasma\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/swaps/quote")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"100\",\n  \"from_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"to_token\": \"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193\",\n  \"from_address\": \"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80\",\n  \"from_chain\": \"plasma\",\n  \"metadata\": {\n    \"external_id\": \"shop_4417\"\n  },\n  \"slippage_bps\": 50,\n  \"to_address\": \"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c\",\n  \"to_chain\": \"plasma\"\n}"

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

{
  "amount_in": "100",
  "amount_out": "0.15",
  "fee_bps": 100,
  "from_token": {
    "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "chain_id": 9745,
    "decimals": 6,
    "network": "plasma",
    "symbol": "USDT"
  },
  "metadata": {
    "external_id": "shop_4417"
  },
  "object": "swap_quote",
  "rate": "1.5",
  "to_token": {
    "address": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
    "chain_id": 9745,
    "decimals": 6,
    "network": "plasma",
    "symbol": "XAUT"
  },
  "amount_out_min": "0.148",
  "bridge_fee": "0.25",
  "estimated_duration_seconds": 30,
  "from_address": "0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80",
  "requires_token_approval": true,
  "to_address": "0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Headers

Idempotency-Key

string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Body

application/json

amount

string

required

Source token amount.

Example:

"100"

from_token

string

required

Source token contract address or ticker symbol, such as "USDT".

Example:

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

to_token

string

required

Destination token contract address or ticker symbol, such as "XAUT".

Example:

"0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193"

from_address

string | null

Source wallet address used for the quote.

Example:

"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80"

from_chain

Source chain name or chain ID. Defaults to the source token's chain when omitted.

Example:

"plasma"

metadata

object

Metadata to include with the quote response.

Example:

{ "external_id": "shop_4417" }

slippage_bps

integer | null

Maximum slippage tolerance in basis points.

Example:

50

to_address

string | null

Destination wallet address used for the quote.

Example:

"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c"

to_chain

Destination chain name or chain ID. Defaults to the destination token's chain when omitted.

Example:

"plasma"

Response

swap quote created

amount_in

string

required

Source token amount used for the quote.

Example:

"100"

amount_out

string

required

Estimated destination token amount.

Example:

"0.15"

fee_bps

integer

required

Whop fee in basis points.

Example:

100

from_token

object

required

Resolved source token details.

Example:

{
  "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "chain_id": 9745,
  "decimals": 6,
  "network": "plasma",
  "symbol": "USDT"
}

metadata

object

required

Metadata from the request.

Example:

{ "external_id": "shop_4417" }

object

enum<string>

required

Available options:

swap_quote

Example:

"swap_quote"

rate

string

required

Quoted exchange rate.

Example:

"1.5"

to_token

object

required

Resolved destination token details.

Example:

{
  "address": "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193",
  "chain_id": 9745,
  "decimals": 6,
  "network": "plasma",
  "symbol": "XAUT"
}

amount_out_min

string

Minimum destination amount after slippage.

Example:

"0.148"

bridge_fee

string | null

Estimated bridge fee for cross-chain swaps.

Example:

"0.25"

estimated_duration_seconds

integer | null

Estimated time for the swap to complete.

Example:

30

from_address

string | null

Source wallet address used for the quote.

Example:

"0x6f1c0a3d5b2e4f8a9c7d1e0b3a5f7c9d2e4b6a80"

requires_token_approval

boolean | null

Whether the source token needs approval before swapping.

Example:

true

to_address

string | null

Destination wallet address used for the quote.

Example:

"0x9d2e4b6a806f1c0a3d5b2e4f8a9c7d1e0b3a5f7c"

⌘I

Introduction

Reference

Webhooks & events

Core Resources

Notifications

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Headers

Body

Response