Estimate fee for a contract template deployment

curl --request POST \
  --url https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blockchain": "MATIC-AMOY",
  "sourceAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
  "templateParameters": {},
  "walletId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}
'

import requests

url = "https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee"

payload = {
    "blockchain": "MATIC-AMOY",
    "sourceAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
    "templateParameters": {},
    "walletId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}
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({
    blockchain: 'MATIC-AMOY',
    sourceAddress: '0x1bf9ad0cc2ad298c69a2995aa806ee832788218c',
    templateParameters: {},
    walletId: 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'
  })
};

fetch('https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee', 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.circle.com/v1/w3s/templates/{id}/deploy/estimateFee",
  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([
    'blockchain' => 'MATIC-AMOY',
    'sourceAddress' => '0x1bf9ad0cc2ad298c69a2995aa806ee832788218c',
    'templateParameters' => [
        
    ],
    'walletId' => 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'
  ]),
  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://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee"

	payload := strings.NewReader("{\n  \"blockchain\": \"MATIC-AMOY\",\n  \"sourceAddress\": \"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c\",\n  \"templateParameters\": {},\n  \"walletId\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\"\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://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"blockchain\": \"MATIC-AMOY\",\n  \"sourceAddress\": \"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c\",\n  \"templateParameters\": {},\n  \"walletId\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee")

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  \"blockchain\": \"MATIC-AMOY\",\n  \"sourceAddress\": \"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c\",\n  \"templateParameters\": {},\n  \"walletId\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\"\n}"

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

{
  "data": {
    "high": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    },
    "low": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    },
    "medium": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    }
  }
}

{
  "code": 123,
  "message": "<string>"
}

POST

w3s

templates

{id}

deploy

estimateFee

Estimate fee for a contract template deployment

curl --request POST \
  --url https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "blockchain": "MATIC-AMOY",
  "sourceAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
  "templateParameters": {},
  "walletId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}
'

import requests

url = "https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee"

payload = {
    "blockchain": "MATIC-AMOY",
    "sourceAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
    "templateParameters": {},
    "walletId": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}
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({
    blockchain: 'MATIC-AMOY',
    sourceAddress: '0x1bf9ad0cc2ad298c69a2995aa806ee832788218c',
    templateParameters: {},
    walletId: 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'
  })
};

fetch('https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee', 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.circle.com/v1/w3s/templates/{id}/deploy/estimateFee",
  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([
    'blockchain' => 'MATIC-AMOY',
    'sourceAddress' => '0x1bf9ad0cc2ad298c69a2995aa806ee832788218c',
    'templateParameters' => [
        
    ],
    'walletId' => 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11'
  ]),
  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://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee"

	payload := strings.NewReader("{\n  \"blockchain\": \"MATIC-AMOY\",\n  \"sourceAddress\": \"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c\",\n  \"templateParameters\": {},\n  \"walletId\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\"\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://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"blockchain\": \"MATIC-AMOY\",\n  \"sourceAddress\": \"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c\",\n  \"templateParameters\": {},\n  \"walletId\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.circle.com/v1/w3s/templates/{id}/deploy/estimateFee")

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  \"blockchain\": \"MATIC-AMOY\",\n  \"sourceAddress\": \"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c\",\n  \"templateParameters\": {},\n  \"walletId\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\"\n}"

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

{
  "data": {
    "high": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    },
    "low": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    },
    "medium": {
      "gasLimit": "21000",
      "gasPrice": "<string>",
      "maxFee": "5.935224468",
      "priorityFee": "1.022783914",
      "baseFee": "1.022783914",
      "networkFee": "0.0001246397138",
      "networkFeeRaw": "0.0001246397138",
      "l1Fee": "0.000000000000140021"
    }
  }
}

{
  "code": 123,
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Headers

X-Request-Id

string<uuid>

Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. Must be a UUID to appear in logs. Non-UUID values are accepted by the API but are ignored by logging and tracing systems.

A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

string<uuid>

required

The universally unique identifier of the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

application/json

Request object for estimating the transaction fees for deploying a contract from a template.

blockchain

enum<string>

required

The blockchain network that the resource is to be created on or is currently on. Required along with sourceAddress if you don't provide walletId. The blockchain and walletId fields are mutually exclusive.

Available options:

ETH,

ETH-SEPOLIA,

MATIC,

MATIC-AMOY,

ARB,

ARB-SEPOLIA,

UNI,

UNI-SEPOLIA,

BASE,

BASE-SEPOLIA,

OP,

OP-SEPOLIA,

AVAX,

AVAX-FUJI,

ARC,

ARC-TESTNET,

MONAD,

MONAD-TESTNET

Example:

"MATIC-AMOY"

sourceAddress

string

Source address of the transaction. Required along with blockchain if walletId is not provided. The sourceAddress and walletId fields are mutually exclusive.

Example:

"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c"

templateParameters

object

JSON object that contains the template deployment parameters used to initialize the contract(s) on-chain.

Show child attributes

walletId

string<uuid>

Unique system generated identifier of the wallet. For contract deploys this wallet ID will be used as the source.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

Response

Response object with estimated transaction fee values.

data

object

required

Show child attributes

API overview

Contracts

Estimate fee for a contract template deployment

Authorizations

Headers

Path Parameters

Body

Response