list_contractsPython,latest
Go to PyPIFetch a list of contracts that you've imported and/or deployed.
Parameters
x_request_id
string
Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
blockchain
string
Filter by blockchain.
Allowed valuesETHETH-SEPOLIAMATICMATIC-AMOYARBARB-SEPOLIAUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIA
contract_input_type
string
Filter contracts by input type.
Allowed valuesIMPORTBYTECODETEMPLATEAUTO_IMPORT
deployer_address
string
Filter contracts by deployer address.
name
string
Filter contracts by name.
status
string
Filter contracts by status.
Allowed valuesPENDINGFAILEDCOMPLETE
from
string
Queries items created since the specified date-time (inclusive) in ISO 8601 format.
to
string
Queries items created before the specified date-time (inclusive) in ISO 8601 format.
page_before
string
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.
page_after
string
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.
page_size
integer
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.
Responses
Example
1from circle.web3 import smart_contract_platform
2from circle.web3 import utils
3
4client = utils.init_smart_contract_platform_client(api_key=key, entity_secret=entitySecret)
5
6api_instance = smart_contract_platform.ViewUpdateApi(client)
7
8response = api_instance.list_contracts()
9print(response.json())
10ResponseChoose an example
1{
2 "data": {
3 "contracts": [
4 {
5 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6 "deployer_wallet_id": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
7 "deployment_transaction_id": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
8 "tx_hash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
9 "abi_json": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
10 "archived": false,
11 "blockchain": "MATIC-AMOY",
12 "bytecode": "0x60806040523480156200001157600080fd5b50604051806040...",
13 "contract_address": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
14 "contract_input_type": "IMPORT",
15 "deployer_address": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
16 "deployer_user_id": "",
17 "deployment_error_reason": "",
18 "deployment_error_details": "",
19 "name": "First Contract",
20 "description": "My first hello world contract",
21 "status": "PENDING",
22 "verification_status": "UNVERIFIED",
23 "metadata_link": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
24 "update_date": "2023-01-01T12:04:05Z",
25 "create_date": "2023-01-01T12:04:05Z",
26 "source_code": [
27 {
28 "file_name": "openzeppelin-solidity/contracts/math/SafeMath.sol",
29 "file_content": "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 "state_mutability": "nonpayable",
36 "type": "function",
37 "inputs": [
38 {
39 "components": [],
40 "indexed": false,
41 "name": "to",
42 "type": "address",
43 "flattened_type": ""
44 }
45 ],
46 "outputs": [
47 {
48 "components": [],
49 "indexed": false,
50 "name": "to",
51 "type": "address",
52 "flattened_type": ""
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 "flattened_type": ""
69 }
70 ]
71 }
72 ],
73 "implementation_contract": {}
74 }
75 ]
76 }
77}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
