Skip to main content
GET
/
v1
/
w3s
/
contracts
List contracts
curl --request GET \
  --url https://api.circle.com/v1/w3s/contracts \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "contracts": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
        "deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
        "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
        "abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
        "archived": false,
        "blockchain": "MATIC-AMOY",
        "contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
        "contractInputType": "IMPORT",
        "deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
        "deployerUserID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "deploymentErrorReason": "<string>",
        "deploymentErrorDetails": "<string>",
        "name": "First Contract",
        "description": "My first hello world contract",
        "status": "PENDING",
        "verificationStatus": "UNVERIFIED",
        "metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
        "updateDate": "2023-01-01T12:04:05Z",
        "createDate": "2023-01-01T12:04:05Z",
        "sourceCode": [
          {
            "fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol",
            "fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks..."
          }
        ],
        "functions": [
          {
            "name": "approve",
            "stateMutability": "nonpayable",
            "type": "function",
            "inputs": [
              {
                "components": [
                  "<any>"
                ],
                "indexed": true,
                "name": "to",
                "type": "address",
                "flattenedType": "<string>"
              }
            ],
            "outputs": [
              {
                "components": [
                  "<any>"
                ],
                "indexed": true,
                "name": "to",
                "type": "address",
                "flattenedType": "<string>"
              }
            ]
          }
        ],
        "events": [
          {
            "name": "Approval",
            "type": "event",
            "anonymous": false,
            "inputs": [
              {
                "components": [
                  "<any>"
                ],
                "indexed": true,
                "name": "to",
                "type": "address",
                "flattenedType": "<string>"
              }
            ]
          }
        ],
        "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.

Example:

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

Query Parameters

​
blockchain
enum<string>

Filter by blockchain.

Available options:
ETH,
ETH-SEPOLIA,
MATIC,
MATIC-AMOY,
ARB,
ARB-SEPOLIA,
UNI,
UNI-SEPOLIA,
BASE,
BASE-SEPOLIA,
OP,
OP-SEPOLIA
Example:

"MATIC-AMOY"

​
contractInputType
enum<string>

Filter contracts by input type.

Available options:
IMPORT,
BYTECODE,
TEMPLATE,
AUTO_IMPORT
​
deployerAddress
string

Filter contracts by deployer address.

Example:

"0x1bf9ad0cc2ad298c69a2995aa806ee832788218c"

​
name
string

Filter contracts by name.

​
status
enum<string>

Filter contracts by status.

Available options:
PENDING,
FAILED,
COMPLETE
​
from
string<date-time>

Queries items created since the specified date-time (inclusive) in ISO 8601 format.

Example:

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

​
to
string<date-time>

Queries items created before the specified date-time (inclusive) in ISO 8601 format.

Example:

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

​
pageBefore
string<uuid>

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

​
pageAfter
string<uuid>

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

​
pageSize
integer
default:10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: 1 <= x <= 50

Response

Contract list retrieved.

​
data
object
required