Quick Start

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can create an account using the Login Page and request a new API key in the Runner API screen.

Make your first request

Send an authenticated request to the Runner API endpoint to make your first request. This will execute a function and return all the requested information.

Execute a function in a Contract

POST https://runner.devweb3.co/runner/run

Headers

Name	Type	Description
x-api-key*	String	API Key

Request Body

Name	Type	Description
type	String	Execution (default) or Simulation
networkId*	String	Network Id found in https://chainlist.org/. The actual supported list is: 137 - Polygon Mainnet 80001 - Polygon Mumbai 56 - BSC Mainnet 97 - BSC Testnet In Test: Ethereum (Mainnet and Goerli) Arbitrum (Mainet and Goerli) AVAX (Mainet and Testnet) Optimism (Mainet and Goerli) Fantom (Mainet and Testnet)
rpc	String	RPC URL to be used by the execution
proxy	String	Proxy Contract address. Optional if you have only the Implementation address
options	Array	Options to control the response details functionDetails - Return the Function's inputs, outputs and State Mutability abi - Return the Contract's ABI information coinPrice - Return the coin price at ehe time of the transaction executio. input- Return all the inputs provided to execute the transaction walletBalance - Return the current wallet balance result - Return the results of the function called using a CALL events - Return the events emited by the function executed receipt - Return the receipt information rawTransaction - Return the Raw Transaction before it's signed signedTransaction - Return the signed transaction executed
nonce	String	Nonce for the execution
gasPrice	String	Gas Price in Gwei. Automatically calculated using the average price if it's not provided.
gasLimit	String	Gas Limit for the execution. Default is 8000000
value	String	Value in Ether to be transferred in case of payable functions
wallet	String	66-character hexadecimal string of length Wallet Private Key. Required for sign payable/nonpayble Contracts
parameters	Array or String	Array of strings or a string for a single parameter
function*	String	Function name to be executed
abi	Array	Array representing the Implementation Contract address ABI
implementation	String	Implementation Contract Address. Optional if the Proxy was implemented using ERC1967
gasPricePriority	String	Gas Price Priority to be used in the dynamic price calculation for Mainnets. Standard (default), Fast or Rapid. The gas cost of your transaction is directly impacted by this parameter. Reference for ETH: https://etherscan.io/gastracker

200 Function successfully executed

{
    "uuid": "33776068-e3ce-444e-9573-15695825e5f6",
    "input": {
        "type": "execution",
        "networkId": 80001,
        "contractProxyAddress": "0xA67F8389B65708e5846E70E25067E4601A90aA40",
        "functionName": "setValue1",
        "parameters": [
            "10"
        ],
        "wallet": "**************************************************************e2be"
    },
    "executionType": "execution",
    "contract": {
        "abi": [
            {
                "anonymous": false,
                "inputs": [
                    {
                        "indexed": false,
                        "internalType": "address",
                        "name": "newAddress",
                        "type": "address"
                    }
                ],
                "name": "AddressTestSet",
                "type": "event",
                "signature": "0x9be797d8340be45bd8aae1337baa699375ed18e75023e9afb8578eb7bf88b8c0"
            },
            ...
            {
                "inputs": [],
                "name": "value1",
                "outputs": [
                    {
                        "internalType": "uint8",
                        "name": "",
                        "type": "uint8"
                    }
                ],
                "stateMutability": "view",
                "type": "function",
                "constant": true,
                "signature": "0x3033413b"
            }
        ],
        "proxy": "0xA67F8389B65708e5846E70E25067E4601A90aA40",
        "implementation": "0x92e77f3be73e728ed1c7a86eb4bea0d8163148dd"
    },
    "function": {
        "name": "setValue1",
        "inputs": [
            {
                "internalType": "uint8",
                "name": "newValue",
                "type": "uint8",
                "value": "10"
            }
        ],
        "outputs": [],
        "stateMutability": "nonpayable",
        "callData": "0xdb1abb2e000000000000000000000000000000000000000000000000000000000000000a"
    },
    "gasLimit": 8000000,
    "gasPrice": "1500000016",
    "wallet": {
        "address": "0xCd87e714a26350ba69ddbAc392522DD15877Bb5a",
        "balance": "189455902745009360"
    },
    "rawTransaction": {
        "from": "0xCd87e714a26350ba69ddbAc392522DD15877Bb5a",
        "to": "0xA67F8389B65708e5846E70E25067E4601A90aA40",
        "gas": 8000000,
        "gasPrice": "1500000016",
        "data": "0xdb1abb2e000000000000000000000000000000000000000000000000000000000000000a"
    },
    "signedTransaction": {
        "messageHash": "0x596b657987148a172fcfd62585e8e9429bc8fa9cda32ff7a32e7660dbb0ad7a4",
        "v": "0x27126",
        "r": "0x54c700d973904ff4f4d14deeabff4969655604277d7efa94c824ce084d659698",
        "s": "0xac1a72f340ffa27b2dd5c09500b623943ab6b9b1f75f3acc012f5da33e2d23c",
        "rawTransaction": "0xf88b2a8459682f10837a120094a67f8389b65708e5846e70e25067e4601a90aa4080a4db1abb2e000000000000000000000000000000000000000000000000000000000000000a83027126a054c700d973904ff4f4d14deeabff4969655604277d7efa94c824ce084d659698a00ac1a72f340ffa27b2dd5c09500b623943ab6b9b1f75f3acc012f5da33e2d23c",
        "transactionHash": "0x421d9c606cc9c5dcb664d1f3075c70aaac720cfd5d21f54806baf441da9f147d"
    },
    "events": [
        {
            "contract": {
                "address": "0xA67F8389B65708e5846E70E25067E4601A90aA40"
            },
            "event": "Value1Set",
            "parameters": [
                {
                    "type": "uint8",
                    "name": "newValue",
                    "value": "10"
                }
            ],
            "topics": [
                "0x806af2e1b19269eed208fdf67b89f671bfd543ec6026849a0c24e94edde57bdb"
            ]
        },
        {
            "contract": {
                "address": "0x0000000000000000000000000000000000001010"
            },
            "topics": [
                "0x4dfe1bbbcf077ddc3e01291eea2d5c70c2b422b415d95645b9adcfd678cb1d63",
                "0x0000000000000000000000000000000000000000000000000000000000001010",
                "0x000000000000000000000000cd87e714a26350ba69ddbac392522dd15877bb5a",
                "0x0000000000000000000000003a22c8bc68e98b0faf40f349dd2b2890fae01484"
            ],
            "data": "0x00000000000000000000000000000000000000000000000000002906dfb9370000000000000000000000000000000000000000000000000002a11523c7b79cd0000000000000000000000000000000000000000000000c365facd3d93a7ac07200000000000000000000000000000000000000000000000002a0ec1ce7fe65d0000000000000000000000000000000000000000000000c365facfce01a33f772"
        }
    ],
    "costWei": "45109500481168",
    "coinPriceUSD": "0.62100000",
    "costUSD": "0.000028013",
    "receipt": {
        "blockHash": "0xd8045c128071c383090a81b1c1fc9c0c7816b4cd37841be632098f2e3acfa15b",
        "blockNumber": 37430745,
        "contractAddress": null,
        "cumulativeGasUsed": 2316678,
        "effectiveGasPrice": 1500000016,
        "from": "0xcd87e714a26350ba69ddbac392522dd15877bb5a",
        "gasUsed": 30073,
        "logs": [
            {
                "address": "0xA67F8389B65708e5846E70E25067E4601A90aA40",
                "topics": [
                    "0x806af2e1b19269eed208fdf67b89f671bfd543ec6026849a0c24e94edde57bdb"
                ],
                "data": "0x000000000000000000000000000000000000000000000000000000000000000a",
                "blockNumber": 37430745,
                "transactionHash": "0x421d9c606cc9c5dcb664d1f3075c70aaac720cfd5d21f54806baf441da9f147d",
                "transactionIndex": 6,
                "blockHash": "0xd8045c128071c383090a81b1c1fc9c0c7816b4cd37841be632098f2e3acfa15b",
                "logIndex": 38,
                "removed": false,
                "id": "log_4d3d1dee"
            },
            {
                "address": "0x0000000000000000000000000000000000001010",
                "topics": [
                    "0x4dfe1bbbcf077ddc3e01291eea2d5c70c2b422b415d95645b9adcfd678cb1d63",
                    "0x0000000000000000000000000000000000000000000000000000000000001010",
                    "0x000000000000000000000000cd87e714a26350ba69ddbac392522dd15877bb5a",
                    "0x0000000000000000000000003a22c8bc68e98b0faf40f349dd2b2890fae01484"
                ],
                "data": "0x00000000000000000000000000000000000000000000000000002906dfb9370000000000000000000000000000000000000000000000000002a11523c7b79cd0000000000000000000000000000000000000000000000c365facd3d93a7ac07200000000000000000000000000000000000000000000000002a0ec1ce7fe65d0000000000000000000000000000000000000000000000c365facfce01a33f772",
                "blockNumber": 37430745,
                "transactionHash": "0x421d9c606cc9c5dcb664d1f3075c70aaac720cfd5d21f54806baf441da9f147d",
                "transactionIndex": 6,
                "blockHash": "0xd8045c128071c383090a81b1c1fc9c0c7816b4cd37841be632098f2e3acfa15b",
                "logIndex": 39,
                "removed": false,
                "id": "log_541b2809"
            }
        ],
        "logsBloom": "0x00000000000000000000000000000000000000008000000000000000000000000000002000000000000000000000000000008000000000000000008000008000000000000000000000000000000000800000000000000000000100000000000000000000000000000000000000000000000000000008000080020000000000000000000000000000000000000000000000000000000000000000000000000000200000000000800000080000000000000000000000000000000000000000004000000000000010000001000000000100000080000000000000100000000000000000000000000000000000000000000000000000000002000000000000100000",
        "status": true,
        "to": "0xa67f8389b65708e5846e70e25067e4601a90aa40",
        "transactionHash": "0x421d9c606cc9c5dcb664d1f3075c70aaac720cfd5d21f54806baf441da9f147d",
        "transactionIndex": 6,
        "type": "0x0"
    },
    "success": true
}

401 Permission denied

400 Bad Request

500: Internal Server Error Server Error

Example

Postman

Method: POST

URL: https://runner.devweb3.co/runner/run

Headers:

x-api-key: <YOUR-API-KEY-HERE>

Content-Type: application/json

Body raw JSON:

{
    "networkId": 80001,
    "proxy": "0xA67F8389B65708e5846E70E25067E4601A90aA40",
    "function": "setValue1",
    "parameters": ["10"],
    "wallet": "0x38bdfef68d698380e9d32417c7d06a68645ac759039923eeccd7e5e9489ae2be"
}

curl

NodeJS