Get a contract

curl --request GET \
  --url https://api.circle.com/v1/w3s/contracts/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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": {}
    }
  }
}

GET

w3s

contracts

{id}

Get a contract

curl --request GET \
  --url https://api.circle.com/v1/w3s/contracts/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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": {}
    }
  }
}

Authorizations

Authorization

string

header

required

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

Headers

X-Request-Id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. 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"

Response

Contract retrieved successfully.

data

object

required

Show child attributes

data.contract

object

required

Show child attributes

data.contract.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

data.contract.archived

boolean

required

The archive state of the contract. If true, the contract will not be visible in your dashboard.

Example:

false

data.contract.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

Example:

"MATIC-AMOY"

data.contract.contractInputType

enum<string>

required

The input type for the contract.

Available options:

IMPORT,

BYTECODE,

TEMPLATE,

AUTO_IMPORT

data.contract.name

string

required

The name for a contract. Must be alphanumeric [a-zA-Z0-9].

Example:

"First Contract"

data.contract.status

enum<string>

required

The status of the contract.

Available options:

PENDING,

FAILED,

COMPLETE

data.contract.verificationStatus

enum<string>

required

The verification status of the contract.

Available options:

UNVERIFIED,

VERIFIED

data.contract.updateDate

string<date-time>

required

Date and time the resource was last updated, in ISO-8601 UTC format.

Example:

"2023-01-01T12:04:05Z"

data.contract.createDate

string<date-time>

required

Date and time the resource was created, in ISO-8601 UTC format.

Example:

"2023-01-01T12:04:05Z"

data.contract.sourceCode

object[]

required

Show child attributes

data.contract.sourceCode.fileContent

string

required

Content of the file. If the contract's source code was flattened before verification, this may be the entire source code.

Example:

"pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks..."

data.contract.sourceCode.fileName

string

Name of the file.

Example:

"openzeppelin-solidity/contracts/math/SafeMath.sol"

data.contract.functions

object[]

required

Functions supported by this contract. Parsed from abi_json.

Show child attributes

data.contract.functions.type

string

required

Example:

"function"

data.contract.functions.name

string

Example:

"approve"

data.contract.functions.stateMutability

string

Example:

"nonpayable"

data.contract.functions.inputs

object[]

Show child attributes

data.contract.functions.inputs.components

any[]

Can be any value - string, number, boolean, array or object.

data.contract.functions.inputs.indexed

boolean

data.contract.functions.inputs.name

string

Example:

"to"

data.contract.functions.inputs.type

string

Example:

"address"

data.contract.functions.inputs.flattenedType

string

data.contract.functions.outputs

object[]

Show child attributes

data.contract.functions.outputs.components

any[]

Can be any value - string, number, boolean, array or object.

data.contract.functions.outputs.indexed

boolean

data.contract.functions.outputs.name

string

Example:

"to"

data.contract.functions.outputs.type

string

Example:

"address"

data.contract.functions.outputs.flattenedType

string

data.contract.events

object[]

required

Events this contract can emit. Parsed from abi_json.

Show child attributes

data.contract.events.type

string

required

Example:

"event"

data.contract.events.name

string

Example:

"Approval"

data.contract.events.anonymous

boolean

Example:

false

data.contract.events.inputs

object[]

Show child attributes

data.contract.events.inputs.components

any[]

Can be any value - string, number, boolean, array or object.

data.contract.events.inputs.indexed

boolean

data.contract.events.inputs.name

string

Example:

"to"

data.contract.events.inputs.type

string

Example:

"address"

data.contract.events.inputs.flattenedType

string

data.contract.deployerWalletID

string<uuid>

The id of the Circle Wallet that deployed this contract.

Example:

"f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a"

data.contract.deploymentTransactionId

string<uuid>

The id of the deployment transaction for this contract.

Example:

"00ca46f3-c31b-4e3a-92a9-068d4ff26a63"

data.contract.txHash

string

Blockchain generated identifier of the transaction.

Example:

"0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d"

data.contract.abiJson

string

The contract's ABI in a JSON stringified format.

Example:

"[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},..."

data.contract.contractAddress

string

The on-chain address of this contract.

Example:

"0x1e124d7384cd34448ea5907bd0052a79355ab5eb"

data.contract.deployerAddress

string

The address that created this contract, if deployed.

Example:

"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c"

data.contract.deployerUserID

string<uuid>

data.contract.deploymentErrorReason

string

data.contract.deploymentErrorDetails

string

data.contract.description

string

The description for a contract.

Example:

"My first hello world contract"

data.contract.metadataLink

string

The ipfs metadata link of the contract.

Example:

"https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu"

data.contract.implementationContract

object

Object of the implementation contract.

List contracts

Update a contract

API Overview

Contracts

Get a contract

Authorizations

Headers

Path Parameters

Response