Staked
Search…
Staked
Introduction
API KEY
Register API Key
Staking
Yields API
Delegations
Node Provisioning API
Reporting API
Robo-Advisor for Yield (RAY)
RAY Intro
Contract Addresses
RAY Tokens
RAY API
Key Events
Yield Opportunities
Stats
Security
Contributing
Resources
Public Repos
Powered By
GitBook
Reporting API
Everyone loves seeing the additional crypto they are earning. Staked provides an API for full access to the details.
get
https://mainnet.staked.cloud/api
/reports/:chain/delegator/:address/balance
Get Simple Balance Of Address
Balance Object Schema
Field
Description
Type
balance
Staking balance
Number
block
Block of latest snapshot
Number
timestamp
Timestamp at latest snapshot
String
address
Address queried
String
conversion_factor_power
Decimals used in Number values (used to keep precision)
Number
attributes
Extra information depending on the chain
Object
React w/ Axios
jQuery
Node.js
Swift
1
import
axios
from
"axios"
;
2
​
3
const
api_key
=
'YOUR API KEY'
;
4
const
chain
=
'TEZOS'
;
5
const
address
=
'KT1W4Rda7pHrqmbDk4xDZ97YpgqAVHE5hndr'
;
6
​
7
var
api
=
axios
.
create
(
{
8
baseURL
:
"https://mainnet.staked.cloud/api"
,
9
timeout
:
1000000
10
}
)
;
11
​
12
api
.
defaults
.
headers
.
post
[
"Content-Type"
]
=
"application/json"
;
13
​
14
api
.
get
(
`
/reports/
${
chain
}
/delegator/
${
address
}
/balance?api_key=
${
api_key
}
`
)
.
then
(
response
=>
{
15
console
.
log
(
res
)
;
16
}
)
Copied!
1
const
api_key
=
'YOUR API KEY'
;
2
const
chain
=
'TEZOS'
;
3
const
address
=
'KT1W4Rda7pHrqmbDk4xDZ97YpgqAVHE5hndr'
;
4
​
5
var
request
=
{
6
"url"
:
`
https://mainnet.staked.cloud/api/reports/
${
chain
}
/delegator/
${
address
}
/balance?api_key=
${
api_key
}
`
,
7
"method"
:
"GET"
,
8
"timeout"
:
0
,
9
}
;
10
​
11
$
.
ajax
(
request
)
.
done
(
function
(
response
)
{
12
console
.
log
(
response
)
;
13
}
)
;
Copied!
1
var
http
=
require
(
'http'
)
;
2
​
3
const
api_key
=
'YOUR API KEY'
;
4
const
chain
=
'TEZOS'
;
5
const
address
=
'KT1W4Rda7pHrqmbDk4xDZ97YpgqAVHE5hndr'
;
6
​
7
var
options
=
{
8
'method'
:
'GET'
,
9
'hostname'
:
'mainnet.staked.cloud'
,
10
'path'
:
`
/api/reports/
${
chain
}
/delegator/
${
address
}
/balance?api_key=
${
api_key
}
`
11
}
;
12
​
13
var
req
=
http
.
request
(
options
,
function
(
res
)
{
14
var
chunks
=
[
]
;
15
​
16
res
.
on
(
"data"
,
function
(
chunk
)
{
17
chunks
.
push
(
chunk
)
;
18
}
)
;
19
​
20
res
.
on
(
"end"
,
function
(
chunk
)
{
21
var
body
=
Buffer
.
concat
(
chunks
)
;
22
console
.
log
(
body
.
toString
(
)
)
;
23
}
)
;
24
​
25
res
.
on
(
"error"
,
function
(
error
)
{
26
console
.
error
(
error
)
;
27
}
)
;
28
}
)
;
29
​
30
req
.
end
(
)
;
Copied!
1
import
Alamofire
2
​
3
let
api_key
=
'YOUR API KEY'
;
4
let
chain
=
'TEZOS'
;
5
let
address
=
'KT1W4Rda7pHrqmbDk4xDZ97YpgqAVHE5hndr'
;
6
​
7
AF
.
request
(
"https://mainnet.staked.cloud/api/reports/
\(
chain
)
/delegator/
\(
address
)
/balance?api_key=
\(
api_key
)
"
)
.
response
{
response
in
8
debugPrint
(
response
)
9
}
Copied!
get
https://mainnet.staked.cloud/api
/reports/:chain/delegator/:address/detailed_balance
Get Detailed Balance of Address
Response
Object
Schema
Field
Description
Type
results
Array of Detailed Balance Objects
Array
page
Current page of results
Number
pages
Total number of pages
Number
per_page
Results per page
Number
total
Total number of results
Number
Detailed
Balance
Object
Schema
Detailed balance objects are returned for every state change of an account (stake, reward, unstake).
Field
Description
Type
timestamp
Timestamp of snapshot
String
block
Block of snapshot
Number
total_delegation
Total amount delegated
Number
delegation
Delegated amount in state change
Number
balance
Staking balance at snapshot
Number
total_reward_and_fees
Total accumulated reward and fees up to snapshot
Number
reward_and_fees
Reward and fees earned in state change
Number
total_reward
Total accumulated reward up to snapshot
Number
reward
Reward earned in state change
Number
total_fees
Total fees accumulated up to snapshot
Number
fees
Fees in state change
Number
total_gross_return
Total gross return up to snapshot
Number
gross_return
Gross return from state change
Number
annualized_gross_return
Annualized gross return
Number
block_explorer_url
Block Explorer URL for state change
String
kind
Kind of state change ("Delegation" or "Reward")
String
conversion_factor_power
Decimals used in Number values (used to keep precision)
Number
currency
Name of currency
String
get
https://mainnet.staked.cloud/api
/reports/:chain/delegator/:address/txns
Get Transactions and Rewards of Address
Transaction Object Schema
Field
Description
Type
id
Transaction identifier
String
kind
Kind of transaction
Transaction Kind Enum
transaction_time
Timestamp of transaction
String
transaction_address
Hash or identifier of transaction on blockchain
String
holding_address
Address queried
String
Amount
Amount of value in transaction
Number
Reward
Reward in transaction
Number
Fees
Fees in transaction
Number
Total
Net value in transaction
Number
conversion_factor_power
Decimals used in Number values (used to keep precision)
Number
denom
Denomination
Number
block_reference
Block the transaction was included in
Number
Transaction Kind Enum
Value
Meaning
STK
Delegation Transactions
UNSTK
Undelegation Transactions
SCH
Scheduled Future Rewards
PEND
Rewards in Frozen Period
PYBL
Rewards Pending Distribution
PAID
Paid Rewards
Note, reward transactions are updated once per 24 hours.
Staking - Previous
Node Provisioning API
Next - Robo-Advisor for Yield (RAY)
RAY Intro
Last modified
3mo ago
Copy link
Contents
get
Get Simple Balance Of Address
get
Get Detailed Balance of Address
get
Get Transactions and Rewards of Address