/extended/v3/principals/{principal}/staking REST API Endpoint

Path Parameters

principal

string

REQUIRED

Loading...

Returns

stx

object

Loading...

locked

string

Loading...

rewards

object

Loading...

btc

object

Loading...

accrued

string

Loading...

claimed

string

Loading...

claimable

string

Loading...

bonds

object

Loading...

count

integer

Loading...

locked

object

Loading...

btc

string

Loading...

stx

string

Loading...

rewards

object

Loading...

btc

object

Loading...

accrued

string

Loading...

claimed

string

Loading...

claimable

string

Loading...

Request

1
curl --request GET \
2
  'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking' \
3
  --header 'accept: application/json'
4

1
curl --request GET \
2
  'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking' \
3
  --header 'accept: application/json'
4

1
const response = await fetch(
2
	'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking',
3
	{
4
		method: 'GET',
5
		headers: { accept: 'application/json' },
6
	}
7
)
8

9
if (!response.ok) {
10
	throw new Error(`Request failed with status ${response.status}`)
11
}
12

13
console.log(await response.json())
14

1
const response = await fetch(
2
	'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking',
3
	{
4
		method: 'GET',
5
		headers: { accept: 'application/json' },
6
	}
7
)
8

9
if (!response.ok) {
10
	throw new Error(`Request failed with status ${response.status}`)
11
}
12

13
console.log(await response.json())
14

1
import requests
2

3
url = "https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking"
4
response = requests.get(url, headers={"accept": "application/json"}, timeout=30)
5
response.raise_for_status()
6

7
print(response.json())
8

1
import requests
2

3
url = "https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking"
4
response = requests.get(url, headers={"accept": "application/json"}, timeout=30)
5
response.raise_for_status()
6

7
print(response.json())
8

1
require "json"
2
require "net/http"
3
require "uri"
4

5
url = URI("https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking")
6
request = Net::HTTP::Get.new(url)
7
request["accept"] = "application/json"
8

9
response = Net::HTTP.start(url.hostname, url.port, use_ssl: url.scheme == "https") do |http|
10
  http.request(request)
11
end
12

13
raise "Request failed with status #{response.code}" unless response.is_a?(Net::HTTPSuccess)
14

15
puts JSON.pretty_generate(JSON.parse(response.body))
16

1
require "json"
2
require "net/http"
3
require "uri"
4

5
url = URI("https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking")
6
request = Net::HTTP::Get.new(url)
7
request["accept"] = "application/json"
8

9
response = Net::HTTP.start(url.hostname, url.port, use_ssl: url.scheme == "https") do |http|
10
  http.request(request)
11
end
12

13
raise "Request failed with status #{response.code}" unless response.is_a?(Net::HTTPSuccess)
14

15
puts JSON.pretty_generate(JSON.parse(response.body))
16

Response

1
{
2
  "stx": {
3
    "locked": "0",
4
    "rewards": {
5
      "btc": {
6
        "accrued": "0",
7
        "claimed": "0",
8
        "claimable": "0"
9
      }
10
    }
11
  },
12
  "bonds": {
13
    "count": 0,
14
    "locked": {
15
      "btc": "0",
16
      "stx": "0"
17
    },
18
    "rewards": {
19
      "btc": {
20
        "accrued": "0",
21
        "claimed": "0",
22
        "claimable": "0"
23
      }
24
    }
25
  }
26
}

1
{
2
  "stx": {
3
    "locked": "0",
4
    "rewards": {
5
      "btc": {
6
        "accrued": "0",
7
        "claimed": "0",
8
        "claimable": "0"
9
      }
10
    }
11
  },
12
  "bonds": {
13
    "count": 0,
14
    "locked": {
15
      "btc": "0",
16
      "stx": "0"
17
    },
18
    "rewards": {
19
      "btc": {
20
        "accrued": "0",
21
        "claimed": "0",
22
        "claimable": "0"
23
      }
24
    }
25
  }
26
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free