Call read-only function

RPC node

Calls a read-only public function on a given smart contract.

POST

Parameters

Path Parameters

contract_address
REQUIRED
string Standard Stacks address (e.g. `SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0`). Must be 28-41 characters long using Stacks base58check format.
contract_name
REQUIRED
string Contract name. Must start with a letter and can contain letters, numbers, hyphens, and underscores. Maximum length is 40 characters for new contracts. Legacy contracts may have names up to 128 characters.
function_name
REQUIRED
string

Query Parameters

tip
string Stacks chain tip to query from. Options: - (empty/omitted): Use latest anchored tip (canonical confirmed state) - `latest`: Use latest known tip including unconfirmed microblocks - `{block_id}`: Use specific block ID (64 hex characters)

Body

application/json
sender
REQUIRED
string
The simulated tx-sender
sponsor
string
The simulated sponsor address
arguments
REQUIRED
array
An array of hex serialized Clarity values
Status codeDescription
200Function executed successfully
400Bad request
404Not found
500Internal Server Error
cURL
curl -L -X POST \

  "https://api.hiro.so/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}?tip={tip}" \

  -H 'Accept: application/json'
Response
{

  "okay": false,

  "result": "string"

}

How is this guide?