Get Action

Get Action

curl --request GET \
  --url https://api-v2.swaps.xyz/api/getAction \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-v2.swaps.xyz/api/getAction', 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://api-v2.swaps.xyz/api/getAction",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-v2.swaps.xyz/api/getAction"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-v2.swaps.xyz/api/getAction")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "tx": {
    "to": "<string>",
    "data": "<string>",
    "value": "<string>",
    "chainId": 123
  },
  "txId": "<string>",
  "vmId": "evm",
  "amountIn": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "amountInMax": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "amountOut": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "amountOutMin": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "protocolFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "applicationFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "exchangeRate": 123,
  "estimatedTxTime": 123,
  "estimatedPriceImpact": 123,
  "requiresTokenApproval": true,
  "requiresRegisterTransaction": true,
  "allRoutes": [
    {
      "tx": {
        "to": "<string>",
        "data": "<string>",
        "value": "<string>",
        "chainId": 123
      },
      "txId": "<string>",
      "vmId": "evm",
      "amountIn": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "amountInMax": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "amountOut": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "amountOutMin": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "protocolFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "applicationFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "exchangeRate": 123,
      "estimatedTxTime": 123,
      "estimatedPriceImpact": 123,
      "requiresRegisterTransaction": true,
      "bridgeFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "bridgeIds": [
        "<string>"
      ],
      "bridgeRoute": [
        {
          "srcChainId": 123,
          "dstChainId": 123,
          "srcBridgeToken": "<string>",
          "dstBridgeToken": "<string>",
          "bridgeId": "<string>"
        }
      ],
      "executionsType": "DEFAULT",
      "executions": [
        {
          "txType": "evmTransactionSign",
          "data": "<string>",
          "signature": "<string>"
        }
      ],
      "relayerFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      }
    }
  ],
  "bridgeFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "bridgeIds": [
    "<string>"
  ],
  "bridgeRoute": [
    {
      "srcChainId": 123,
      "dstChainId": 123,
      "srcBridgeToken": "<string>",
      "dstBridgeToken": "<string>",
      "bridgeId": "<string>"
    }
  ],
  "executionsType": "DEFAULT",
  "executions": [
    {
      "txType": "evmTransactionSign",
      "data": "<string>",
      "signature": "<string>"
    }
  ],
  "relayerFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  }
}

GET

getAction

Get Action

curl --request GET \
  --url https://api-v2.swaps.xyz/api/getAction \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-v2.swaps.xyz/api/getAction', 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://api-v2.swaps.xyz/api/getAction",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-v2.swaps.xyz/api/getAction"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-v2.swaps.xyz/api/getAction")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "tx": {
    "to": "<string>",
    "data": "<string>",
    "value": "<string>",
    "chainId": 123
  },
  "txId": "<string>",
  "vmId": "evm",
  "amountIn": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "amountInMax": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "amountOut": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "amountOutMin": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "protocolFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "applicationFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "exchangeRate": 123,
  "estimatedTxTime": 123,
  "estimatedPriceImpact": 123,
  "requiresTokenApproval": true,
  "requiresRegisterTransaction": true,
  "allRoutes": [
    {
      "tx": {
        "to": "<string>",
        "data": "<string>",
        "value": "<string>",
        "chainId": 123
      },
      "txId": "<string>",
      "vmId": "evm",
      "amountIn": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "amountInMax": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "amountOut": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "amountOutMin": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "protocolFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "applicationFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "exchangeRate": 123,
      "estimatedTxTime": 123,
      "estimatedPriceImpact": 123,
      "requiresRegisterTransaction": true,
      "bridgeFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      },
      "bridgeIds": [
        "<string>"
      ],
      "bridgeRoute": [
        {
          "srcChainId": 123,
          "dstChainId": 123,
          "srcBridgeToken": "<string>",
          "dstBridgeToken": "<string>",
          "bridgeId": "<string>"
        }
      ],
      "executionsType": "DEFAULT",
      "executions": [
        {
          "txType": "evmTransactionSign",
          "data": "<string>",
          "signature": "<string>"
        }
      ],
      "relayerFee": {
        "chainId": 123,
        "address": "<string>",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "isNative": true,
        "amount": "<string>",
        "logo": "<string>",
        "swapsXyzCode": "<string>",
        "usdAmount": 123
      }
    }
  ],
  "bridgeFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  },
  "bridgeIds": [
    "<string>"
  ],
  "bridgeRoute": [
    {
      "srcChainId": 123,
      "dstChainId": 123,
      "srcBridgeToken": "<string>",
      "dstBridgeToken": "<string>",
      "bridgeId": "<string>"
    }
  ],
  "executionsType": "DEFAULT",
  "executions": [
    {
      "txType": "evmTransactionSign",
      "data": "<string>",
      "signature": "<string>"
    }
  ],
  "relayerFee": {
    "chainId": 123,
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123,
    "isNative": true,
    "amount": "<string>",
    "logo": "<string>",
    "swapsXyzCode": "<string>",
    "usdAmount": 123
  }
}

Authorizations

x-api-key

string

header

required

Limited demo key for API Reference: 5c951bc81da566bbd030ba8e20724063.

Query Parameters

actionType

enum<string>

required

Type of action to perform Type of action to perform.

Available options:

swap-action,

evm-calldata-tx,

polymarket

sender

string

required

The address of the sender/user Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

srcChainId

integer

required

Source chain ID Chain ID. Find in the list of supported networks.

srcToken

string

required

Source token address Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

dstChainId

integer

required

Destination chain ID Chain ID. Find in the list of supported networks.

dstToken

string

required

Destination token address Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

slippage

number<float>

required

Slippage tolerance in bps

Required range: 0 <= x <= 10000

amount

string

The exact in or exact out amount of the swap

Required: for swap-action

Required: for polymarket action type

Pattern: ^[0-9]+$

swapDirection

enum<string>

Swap direction for the action

Required: for swap-action

For polymarket, optional — defaults to exact-amount-in (recommended). Swap direction for the action.

Available options:

exact-amount-in,

exact-amount-out

recipient

string

Address to receive the swapped tokens

Optional: for swap-action

Required: for polymarket action type (should be the proxy wallet address) Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

string

The EVM address of the target contract (20 bytes hex)

Required: for evm-calldata-tx action type Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

data

string

Calldata for the transaction

Required: for evm-calldata-tx action type Hex string with 0x prefix

Pattern: ^0x[a-fA-F0-9]*$

value

string

Value to send with transaction

Optional: for evm-calldata-tx action type

Pattern: ^[0-9]+$

erc20Amount

string

The amount of Erc20 being transferred

Optional: for evm-calldata-tx action type (use for calls requiring Erc20 transfers)

Pattern: ^[0-9]+$

erc20Spender

string

The Erc20 spender requiring approval for the transaction call

Optional: for evm-calldata-tx action type (will default to the to address) Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

Solana address that pays for tx fees and rent (e.g. ATA creation). Only used for Solana same chain swaps. Transaction must be signed by both the user and the sponsor.

Optional: When provided, the sponsor covers transaction costs on behalf of the user. Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

bridgeIds

string[]

Specific bridge protocols to use

Optional: Will default to all available protocols

Bridge protocol identifier (e.g. "across", "relay", "mayan").

refundTo

string

Alternate address to receive refunds

Optional: Will default to the sender Address type - can be EvmAddress, HyperCoreAddress, SolanaAddress, or AltVmAddress.

returnDepositAddress

boolean

default:false

Return a deposit address for deposit-based flows

Optional: Set to true to receive a deposit address in the response

appFees

string

Application fees configuration as JSON array

Optional: Will default to fees configured for the application

Example: [{ "bps": 50, "receiverAddress": "0x..." }]

userId

string

Polymarket user ID - returned from POST /workflows/polymarket/createOrFetchPolymarketUser

Required: for polymarket action type

side

enum<string>

Order side for Polymarket orders

Required: for polymarket action type

Available options:

BUY,

SELL

tokenID

string

Polymarket CLOB token ID

Required: for polymarket action type

orderType

enum<string>

Polymarket order type

Required: for polymarket action type

FOK: Fill or Kill (market order)
FAK: Fill and Kill (market order)

Available options:

FOK,

FAK

tickSize

enum<string>

Price tick size for Polymarket orders

Required: for polymarket action type

Available options:

0.01,

0.001,

0.0001

negRisk

enum<string>

Negative risk flag for Polymarket

Required: for polymarket action type

Available options:

true,

false

gasless

boolean

default:false

Request gasless execution. When true, the response includes an executions array of signed steps to relay through the gasless provider instead of broadcasting a transaction directly.

Optional: Only supported on chains with a configured gasless provider (currently Tron). Requires the API key to have gasless enabled.

Response

Successful response with action data

EVM Transaction · object

required

Transaction data for execution

Show child attributes

txId

string

required

Transaction ID

Pattern: ^0x[a-fA-F0-9]*$

vmId

enum<string>

required

Virtual machine identifier.

Available options:

evm,

solana,

alt-vm,

hypercore,

tron,

ton

amountIn

object

required

Expected amount to input (exclusive of slippage - recommended value to display in frontend)

Show child attributes

amountInMax

object

required

Maximum amount to input (inclusive of slippage)

Show child attributes

amountOut

object

required

Expected amount delivered to users (exclusive of slippage - recommended value to display in frontend)

Show child attributes

amountOutMin

object

required

Minimum amount delivered to users (inclusive of slippage)

Show child attributes

protocolFee

object

required

Swaps.xyz fee

Show child attributes

applicationFee

object

required

Application fee (your fee!)

Show child attributes

exchangeRate

number<float>

required

Exchange rate for the swap.

estimatedTxTime

number<float>

required

Estimated transaction time in seconds.

estimatedPriceImpact

number<float> | null

required

Estimated price impact percentage.

requiresTokenApproval

boolean

required

Flag indicating whether the transaction object requires a source token approval check.

requiresRegisterTransaction

boolean

required

Flag indicating whether the transaction requires registration via the registerTxs endpoint. Mandatory for non-EVM transactions.

allRoutes

object[]

required

All available routes for the action.

Show child attributes

bridgeFee

object

Bridge fee (from aggregated providers)

Show child attributes

bridgeIds

string[]

Bridge IDs used in the route.

Bridge protocol identifier (e.g. "across", "relay", "mayan").

bridgeRoute

object[]

Bridge route information (src chain + token, dst chain + token, BridgeId)

Show child attributes

executionsType

enum<string>

Indicates the execution mode. GASLESS when gasless=true was requested and a relay provider is available; DEFAULT otherwise.

Available options:

DEFAULT,

GASLESS

executions

object[]

Ordered list of signing steps the client must complete before calling POST /submitTx. Only present when executionsType is GASLESS.

A single signing step returned in the executions array of a gasless getAction response. Only available for Tron same-chain swaps. The client must sign each item in order and include the signatures when calling POST /submitTx.

Option 1
Option 2

Show child attributes

relayerFee

object

Fee charged by the relay provider, denominated in USDT. If non-zero, the user must hold USDT in addition to the source token. Only present when executionsType is GASLESS.

Show child attributes

Getting Started

Core

Gasless

Data

Utilities

Authorizations

Query Parameters

Response