Runner

REST API that allows a Web 2.0 application to call any compatible Web3 EVM Network Contract function.

Run

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

Good to know: A transaction can take a few seconds to be completed due to the nature of the blockchain network. Unlike a web 2.0 application, a blockchain network needs more time to process and include it in the ledger.

200 Code: The API response with a status code 200 indicates that the transaction was successfully submitted to the blockchain. However, it's essential to check the response details for potential reasons if the transaction was reverted by the blockchain. Other status codes may indicate issues with the API itself, unrelated to the blockchain network.

Last updated