listContracts

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

List contracts

GEThttps://api.circle.com/v1/w3s/contracts

Fetch a list of contracts that you've imported and/or deployed.

Query parameters

blockchain

string

Filter by blockchain.

contractInputType

string

Filter contracts by input type.

deployerAddress

string

Filter contracts by deployer address.

name

string

Filter contracts by name.

status

string

Filter contracts by status.

from

date-time

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

date-time

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

pageBefore

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

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

1 to 50

Default is 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.

Response

200ContractsResponse

Response Body

object

data

object

Required

Show 1 properties

contracts

array of objects

Required

Contracts are all the contracts that match criteria.

Show 25 properties

string

Required

System-generated unique identifier of the resource.

deployerWalletID

string

The id of the Programmable Wallet that deployed this contract.

deploymentTransactionId

string

The id of the deployment transaction for this contract.

txHash

string

Blockchain generated identifier of the transaction.

abiJson

string

The contract's ABI in a JSON stringified format.

archived

boolean

Required

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

blockchain

string

Required

The blockchain network that the resource is to be created on or is currently on.

bytecode

string

Bytecode of the contract being deployed.

contractAddress

string

The on-chain address of this contract.

contractInputType

string

Required

The input type for the contract.

deployerAddress

string

The address that created this contract, if deployed.

deployerUserID

string

deploymentErrorReason

string

deploymentErrorDetails

string

name

string

Required

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

description

string

The description for a contract.

status

string

Required

The status of the contract.

verificationStatus

string

Required

The verification status of the contract.

metadataLink

string

The ipfs metadata link of the contract.

updateDate

string

Required

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

createDate

string

Required

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

sourceCode

array of objects

Required

Show 2 properties

functions

array of objects

Required

Functions supported by this contract. Parsed from abi_json.

Show 5 properties

events

array of objects

Required

Events this contract can emit. Parsed from abi_json.

Show 4 properties

implementationContract

object

Object of the implementation contract.

defaultError

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "contracts": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
7        "deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
8        "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
9        "abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
10        "archived": false,
11        "blockchain": "MATIC-AMOY",
12        "bytecode": "0x60806040523480156200001157600080fd5b50604051806040...",
13        "contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
14        "contractInputType": "IMPORT",
15        "deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
16        "deployerUserID": "",
17        "deploymentErrorReason": "",
18        "deploymentErrorDetails": "",
19        "name": "First Contract",
20        "description": "My first hello world contract",
21        "status": "PENDING",
22        "verificationStatus": "UNVERIFIED",
23        "metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
24        "updateDate": "2023-01-01T12:04:05Z",
25        "createDate": "2023-01-01T12:04:05Z",
26        "sourceCode": [
27          {
28            "fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol",
29            "fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks..."
30          }
31        ],
32        "functions": [
33          {
34            "name": "approve",
35            "stateMutability": "nonpayable",
36            "type": "function",
37            "inputs": [
38              {
39                "components": [],
40                "indexed": false,
41                "name": "to",
42                "type": "address",
43                "flattenedType": ""
44              }
45            ],
46            "outputs": [
47              {
48                "components": [],
49                "indexed": false,
50                "name": "to",
51                "type": "address",
52                "flattenedType": ""
53              }
54            ]
55          }
56        ],
57        "events": [
58          {
59            "name": "Approval",
60            "type": "event",
61            "anonymous": false,
62            "inputs": [
63              {
64                "components": [],
65                "indexed": false,
66                "name": "to",
67                "type": "address",
68                "flattenedType": ""
69              }
70            ]
71          }
72        ],
73        "implementationContract": {}
74      }
75    ]
76  }
77}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy