Call read-only function

POST

https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format:

Body

application/json

map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.

Describes representation of a Type-0 Stacks 2.0 transaction. https://github.com/stacksgov/sips/blob/main/sips/sip-005/sip-005-blocks-and-transactions.md#type-0-transferring-an-asset

senderstringrequired

The simulated tx-sender

argumentsArray<string>required

An array of hex serialized Clarity values

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

function_namestringrequiredpath

Function name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Call read-only function

curl -X POST 'https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
    "arguments": [
      "0x0011...",
      "0x00231..."
    ]
  }'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
      "arguments": [
        "0x0011...",
        "0x00231..."
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
    "arguments": [
      "0x0011...",
      "0x00231..."
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

payload = {
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

response = requests.post('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', json=payload)
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
      "arguments": [
        "0x0011...",
        "0x00231..."
      ]
    }),
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
    "arguments": [
      "0x0011...",
      "0x00231..."
    ]
  });
console.log(result);

const response = await fetch('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
      "arguments": [
        "0x0011...",
        "0x00231..."
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

response = requests.post('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
    "arguments": [
      "0x0011...",
      "0x00231..."
    ]
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

{
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

200

{
  "okay": true,
  "result": "0x111..."
}

{
  "okay": false,
  "cause": "Unchecked(PublicFunctionNotReadOnly(..."
}