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

Path Parameters

principal

string

REQUIRED

Loading...

Query Parameters

limit

integer

Loading...

cursor

string

Loading...

Returns

total

integer

Loading...

limit

integer

Loading...

cursor

object

Loading...

next

string

Loading...

previous

string

Loading...

current

string

Loading...

results

array

Loading...

bond_index

integer

Loading...

status

string

Loading...

active

boolean

Loading...

enrollment

object

Loading...

tx_id

string

Loading...

btc_lockup

object

Loading...

amount

string

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/bonds?limit=1' \
3
  --header 'accept: application/json'
4

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

1
const response = await fetch(
2
	'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v3/principals/SP5KCQ6CQAS73AMM002HMK94CCYEA4P3C94VX3K4/staking/bonds?limit=1',
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/bonds?limit=1',
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/bonds?limit=1"
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/bonds?limit=1"
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/bonds?limit=1")
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/bonds?limit=1")
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
  "total": 0,
3
  "limit": 1,
4
  "cursor": {
5
    "next": null,
6
    "previous": null,
7
    "current": null
8
  },
9
  "results": []
10
}

1
{
2
  "total": 0,
3
  "limit": 1,
4
  "cursor": {
5
    "next": null,
6
    "previous": null,
7
    "current": null
8
  },
9
  "results": []
10
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free