Get contract interface

GET

https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Get contract interface using a contract_address and contract name

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract 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

Contract interface

Get contract interface

curl -X GET 'https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}')
request = Net::HTTP::Get.new(uri)

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

import requests

response = requests.get('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

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

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

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}')
request = Net::HTTP::Get.new(uri)

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

200

{
  "functions": [
    {
      "name": "get-value",
      "access": "public",
      "args": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "outputs": {
        "type": {
          "response": {
            "ok": {
              "buffer": {
                "length": 32
              }
            },
            "error": "int128"
          }
        }
      }
    },
    {
      "name": "set-value",
      "access": "public",
      "args": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        },
        {
          "name": "value",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    },
    {
      "name": "test-emit-event",
      "access": "public",
      "args": [],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    },
    {
      "name": "test-event-types",
      "access": "public",
      "args": [],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    }
  ],
  "variables": [
    {
      "name": "recipient",
      "type": "principal",
      "access": "constant"
    },
    {
      "name": "sender",
      "type": "principal",
      "access": "constant"
    }
  ],
  "maps": [
    {
      "name": "store",
      "key": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "value": [
        {
          "name": "value",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ]
    }
  ],
  "fungible_tokens": [
    {
      "name": "novel-token-19"
    }
  ],
  "non_fungible_tokens": [
    {
      "name": "hello-nft",
      "type": "uint128"
    }
  ]
}