Get principal STX balance

GET

https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves STX account balance information for a given Address or Contract Identifier.

Parameters

include_mempoolbooleanfalsequery

Include pending mempool transactions in the balance calculation

principalstring | stringrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get principal STX balance

curl -X GET 'https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx'

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx')
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/extended/v2/addresses/{principal}/balances/stx')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx";
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/extended/v2/addresses/{principal}/balances/stx', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx')
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)

{
  "balance": "string",
  "estimated_balance": "string",
  "pending_balance_inbound": "string",
  "pending_balance_outbound": "string",
  "total_sent": "string",
  "total_received": "string",
  "total_fees_sent": "string",
  "total_miner_rewards_received": "string",
  "lock_tx_id": "string",
  "locked": "string",
  "lock_height": 0,
  "burnchain_lock_height": 0,
  "burnchain_unlock_height": 0
}

{
  "error": "string",
  "message": "string"
}