Get submitOrder calldata

curl --request GET \
  --url https://api.paxoslabs.com/v1/transit/orders/quote \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.paxoslabs.com/v1/transit/orders/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://api.paxoslabs.com/v1/transit/orders/quote",
  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.paxoslabs.com/v1/transit/orders/quote"

	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.paxoslabs.com/v1/transit/orders/quote")

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

{
  "transaction": {
    "to": "0xabcdef1234567890abcdef1234567890abcdef12",
    "value": "0",
    "data": "0x47e7ef24...",
    "abi": [
      "<string>"
    ],
    "functionName": "submitOrder",
    "args": [
      "<string>"
    ]
  },
  "amountOut": "992500",
  "protocolFee": "5000",
  "fillCostFee": "2500",
  "conversionRateFee": "2500",
  "conversionRateHundredthsBps": 500,
  "integratorFee": "0",
  "totalFees": "7500",
  "estimatedLatencyMs": 300000
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

GET

transit

orders

quote

Get submitOrder calldata

curl --request GET \
  --url https://api.paxoslabs.com/v1/transit/orders/quote \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.paxoslabs.com/v1/transit/orders/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://api.paxoslabs.com/v1/transit/orders/quote",
  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.paxoslabs.com/v1/transit/orders/quote"

	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.paxoslabs.com/v1/transit/orders/quote")

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

{
  "transaction": {
    "to": "0xabcdef1234567890abcdef1234567890abcdef12",
    "value": "0",
    "data": "0x47e7ef24...",
    "abi": [
      "<string>"
    ],
    "functionName": "submitOrder",
    "args": [
      "<string>"
    ]
  },
  "amountOut": "992500",
  "protocolFee": "5000",
  "fillCostFee": "2500",
  "conversionRateFee": "2500",
  "conversionRateHundredthsBps": 500,
  "integratorFee": "0",
  "totalFees": "7500",
  "estimatedLatencyMs": 300000
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": 400,
    "message": "Invalid filter syntax.",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.paxoslabs.dev/errors/BadRequest",
        "fieldViolations": [
          {
            "field": "filter",
            "description": "vaultAddress 0x0x is an invalid hex address."
          }
        ]
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

API key in format: pxl_<public_id>_

Query Parameters

userAddress

string

required

User wallet address that receives the wantAsset on the destination chain.

Example:

"0x1234567890abcdef1234567890abcdef12345678"

offerAmount

string

required

Amount of offerAsset to send, in token base units (decimal string). Must meet the route's minOrderSize (see GET /v1/transit/routes).

Example:

"300000000"

offerAsset

string

required

Asset being offered (debited on the source chain).

Example:

"0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

sourceChainId

number

required

EVM chain ID of the source chain (where the transaction is submitted).

Example:

1

wantAsset

string

required

Asset desired (credited on the destination chain).

Example:

"0x5fc5360D0400a0Fd4f2af552ADD042D716F1d168"

destinationChainId

number

required

EVM chain ID of the destination chain. Server translates this to the destination chain EID.

Example:

4663

permitSignature

string

EIP-2612 permit signature (65-byte hex, from the authorize step). Required when permitDeadline is provided.

permitDeadline

number

Permit deadline as Unix timestamp. Required when permitSignature is provided.

integratorFee

string

Integrator fee charged on offerAsset in the asset's base units. For example, if the offerAsset is USDC, which has 6 decimals, provide a value of 10000 to charge a fee of $0.01. When provided, integratorFeeReceiver is required.

integratorFeeReceiver

string

Address to receive the integrator fee. Required when integratorFee is provided.

distributorCode

string

Optional 32-byte hex code (0x + 64 hex chars) tagging the source of funds. Emitted on-chain with the order. When omitted, uses the organization's default distributor code if one is configured, otherwise defaults to the zero hash.

responseFormat

enum<string>

Controls which fields appear in the transaction response. "encoded" (default): only ABI-encoded calldata. "full": encoded calldata plus ABI fragment, function name, and args. "structured": ABI fragment, function name, and args only (no encoded data).

Available options:

encoded,

full,

structured

Response

transaction

object

required

Show child attributes

amountOut

string

required

Net amount credited toward the order after fees, in want-asset base units (decimal string). Equals offerAmount - protocolFee and integratorFee, converted to want-asset base units.

Example:

"992500"

protocolFee

string

required

Total protocol fee charged on the order, in offer-asset base units, as a string.

Example:

"5000"

fillCostFee

string

required

Part of the protocol fee – this is an estimation of the transfer cost we pay after conversion to deliver funds to the end user, in offer-asset base units.

Example:

"2500"

conversionRateFee

string

required

Part of the protocol fee - the conversion rate fee we charge to convert the offer asset into the want asset, in offer-asset base units.

Example:

"2500"

conversionRateHundredthsBps

number

required

Rate applied to offer amount to get the conversionRateFee in hundredths of bps. For example, a value of 500 represents a 5 bip fee rate, or 0.05%.

Example:

500

integratorFee

string

required

Integrator fee charged on the order, in offer-asset base units. "0" when no integrator fee applies.

Example:

"0"

totalFees

string

required

Total fees charged on the order, in offer-asset base units. Sum of protocolFee and integratorFee.

Example:

"7500"

estimatedLatencyMs

number

Estimated time for order fulfillment in milliseconds, based on the asset pair and order volume. Undefined when no SLA data is available for the route.

Example:

300000

⌘I