Import a contract
curl --request POST \
--url https://api.circle.com/v1/w3s/contracts/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"name": "First Contract",
"address": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"blockchain": "MATIC-AMOY",
"description": "My first hello world contract",
"refreshVerification": true
}
'import requests
url = "https://api.circle.com/v1/w3s/contracts/import"
payload = {
"idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"name": "First Contract",
"address": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"blockchain": "MATIC-AMOY",
"description": "My first hello world contract",
"refreshVerification": True
}
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({
idempotencyKey: 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
name: 'First Contract',
address: '0x1e124d7384cd34448ea5907bd0052a79355ab5eb',
blockchain: 'MATIC-AMOY',
description: 'My first hello world contract',
refreshVerification: true
})
};
fetch('https://api.circle.com/v1/w3s/contracts/import', 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/contracts/import",
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([
'idempotencyKey' => 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
'name' => 'First Contract',
'address' => '0x1e124d7384cd34448ea5907bd0052a79355ab5eb',
'blockchain' => 'MATIC-AMOY',
'description' => 'My first hello world contract',
'refreshVerification' => true
]),
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/contracts/import"
payload := strings.NewReader("{\n \"idempotencyKey\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n \"name\": \"First Contract\",\n \"address\": \"0x1e124d7384cd34448ea5907bd0052a79355ab5eb\",\n \"blockchain\": \"MATIC-AMOY\",\n \"description\": \"My first hello world contract\",\n \"refreshVerification\": true\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/contracts/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotencyKey\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n \"name\": \"First Contract\",\n \"address\": \"0x1e124d7384cd34448ea5907bd0052a79355ab5eb\",\n \"blockchain\": \"MATIC-AMOY\",\n \"description\": \"My first hello world contract\",\n \"refreshVerification\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.circle.com/v1/w3s/contracts/import")
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 \"idempotencyKey\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n \"name\": \"First Contract\",\n \"address\": \"0x1e124d7384cd34448ea5907bd0052a79355ab5eb\",\n \"blockchain\": \"MATIC-AMOY\",\n \"description\": \"My first hello world contract\",\n \"refreshVerification\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contract": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"archived": false,
"blockchain": "MATIC-AMOY",
"contractInputType": "IMPORT",
"name": "First Contract",
"status": "PENDING",
"verificationStatus": "UNVERIFIED",
"updateDate": "2023-01-01T12:04:05Z",
"createDate": "2023-01-01T12:04:05Z",
"sourceCode": [
{
"fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks...",
"fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol"
}
],
"functions": [
{
"type": "function",
"name": "approve",
"stateMutability": "nonpayable",
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
],
"outputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"events": [
{
"type": "event",
"name": "Approval",
"anonymous": false,
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
"deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
"txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
"abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
"contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
"deployerUserID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deploymentErrorReason": "<string>",
"deploymentErrorDetails": "<string>",
"description": "My first hello world contract",
"metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
"implementationContract": {}
},
"warnings": [
{
"code": "IMPLEMENTATION_ABI_UNVERIFIED",
"message": "Implementation contract ABI is unavailable. Verify the implementation contract on the block explorer and re-import before creating event monitors."
}
]
}
}{
"data": {
"contract": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"archived": false,
"blockchain": "MATIC-AMOY",
"contractInputType": "IMPORT",
"name": "First Contract",
"status": "PENDING",
"verificationStatus": "UNVERIFIED",
"updateDate": "2023-01-01T12:04:05Z",
"createDate": "2023-01-01T12:04:05Z",
"sourceCode": [
{
"fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks...",
"fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol"
}
],
"functions": [
{
"type": "function",
"name": "approve",
"stateMutability": "nonpayable",
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
],
"outputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"events": [
{
"type": "event",
"name": "Approval",
"anonymous": false,
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
"deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
"txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
"abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
"contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
"deployerUserID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deploymentErrorReason": "<string>",
"deploymentErrorDetails": "<string>",
"description": "My first hello world contract",
"metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
"implementationContract": {}
},
"warnings": [
{
"code": "IMPLEMENTATION_ABI_UNVERIFIED",
"message": "Implementation contract ABI is unavailable. Verify the implementation contract on the block explorer and re-import before creating event monitors."
}
]
}
}{
"code": 123,
"message": "<string>"
}Import a contract
Add an existing smart contract to your library of contracts. It also can be done in the Developer Services Console.
POST
/
v1
/
w3s
/
contracts
/
import
Import a contract
curl --request POST \
--url https://api.circle.com/v1/w3s/contracts/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"name": "First Contract",
"address": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"blockchain": "MATIC-AMOY",
"description": "My first hello world contract",
"refreshVerification": true
}
'import requests
url = "https://api.circle.com/v1/w3s/contracts/import"
payload = {
"idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"name": "First Contract",
"address": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"blockchain": "MATIC-AMOY",
"description": "My first hello world contract",
"refreshVerification": True
}
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({
idempotencyKey: 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
name: 'First Contract',
address: '0x1e124d7384cd34448ea5907bd0052a79355ab5eb',
blockchain: 'MATIC-AMOY',
description: 'My first hello world contract',
refreshVerification: true
})
};
fetch('https://api.circle.com/v1/w3s/contracts/import', 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/contracts/import",
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([
'idempotencyKey' => 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11',
'name' => 'First Contract',
'address' => '0x1e124d7384cd34448ea5907bd0052a79355ab5eb',
'blockchain' => 'MATIC-AMOY',
'description' => 'My first hello world contract',
'refreshVerification' => true
]),
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/contracts/import"
payload := strings.NewReader("{\n \"idempotencyKey\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n \"name\": \"First Contract\",\n \"address\": \"0x1e124d7384cd34448ea5907bd0052a79355ab5eb\",\n \"blockchain\": \"MATIC-AMOY\",\n \"description\": \"My first hello world contract\",\n \"refreshVerification\": true\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/contracts/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotencyKey\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n \"name\": \"First Contract\",\n \"address\": \"0x1e124d7384cd34448ea5907bd0052a79355ab5eb\",\n \"blockchain\": \"MATIC-AMOY\",\n \"description\": \"My first hello world contract\",\n \"refreshVerification\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.circle.com/v1/w3s/contracts/import")
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 \"idempotencyKey\": \"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11\",\n \"name\": \"First Contract\",\n \"address\": \"0x1e124d7384cd34448ea5907bd0052a79355ab5eb\",\n \"blockchain\": \"MATIC-AMOY\",\n \"description\": \"My first hello world contract\",\n \"refreshVerification\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contract": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"archived": false,
"blockchain": "MATIC-AMOY",
"contractInputType": "IMPORT",
"name": "First Contract",
"status": "PENDING",
"verificationStatus": "UNVERIFIED",
"updateDate": "2023-01-01T12:04:05Z",
"createDate": "2023-01-01T12:04:05Z",
"sourceCode": [
{
"fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks...",
"fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol"
}
],
"functions": [
{
"type": "function",
"name": "approve",
"stateMutability": "nonpayable",
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
],
"outputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"events": [
{
"type": "event",
"name": "Approval",
"anonymous": false,
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
"deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
"txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
"abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
"contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
"deployerUserID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deploymentErrorReason": "<string>",
"deploymentErrorDetails": "<string>",
"description": "My first hello world contract",
"metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
"implementationContract": {}
},
"warnings": [
{
"code": "IMPLEMENTATION_ABI_UNVERIFIED",
"message": "Implementation contract ABI is unavailable. Verify the implementation contract on the block explorer and re-import before creating event monitors."
}
]
}
}{
"data": {
"contract": {
"id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
"archived": false,
"blockchain": "MATIC-AMOY",
"contractInputType": "IMPORT",
"name": "First Contract",
"status": "PENDING",
"verificationStatus": "UNVERIFIED",
"updateDate": "2023-01-01T12:04:05Z",
"createDate": "2023-01-01T12:04:05Z",
"sourceCode": [
{
"fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks...",
"fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol"
}
],
"functions": [
{
"type": "function",
"name": "approve",
"stateMutability": "nonpayable",
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
],
"outputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"events": [
{
"type": "event",
"name": "Approval",
"anonymous": false,
"inputs": [
{
"components": [
"<unknown>"
],
"indexed": true,
"name": "to",
"type": "address",
"flattenedType": "<string>"
}
]
}
],
"deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
"deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
"txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
"abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
"contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
"deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
"deployerUserID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deploymentErrorReason": "<string>",
"deploymentErrorDetails": "<string>",
"description": "My first hello world contract",
"metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
"implementationContract": {}
},
"warnings": [
{
"code": "IMPLEMENTATION_ABI_UNVERIFIED",
"message": "Implementation contract ABI is unavailable. Verify the implementation contract on the block explorer and re-import before creating event monitors."
}
]
}
}{
"code": 123,
"message": "<string>"
}Authorizations
Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.
Headers
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"
Body
application/json
Import contract request
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.
Example:
"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
The name for a contract. Must be alphanumeric [a-zA-Z0-9].
Example:
"First Contract"
The on-chain address of this contract.
Example:
"0x1e124d7384cd34448ea5907bd0052a79355ab5eb"
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"
The description for a contract.
Example:
"My first hello world contract"
If true, refreshes the contract's ABI and source code from the blockchain explorer for contracts that have since been verified on-chain.
Example:
true
Response
Idempotent request. Contract was already imported.
Show child attributes
Show child attributes
Was this page helpful?