Node Provisioning API

Dynamically provision nodes and receive staking transactions to sign.

What is the Node Provisioning API?
The Node Provisioning API allows partners to programmatically spin-up nodes for staking.  Partners specify the number of nodes needed and receive a transaction to sign that stakes with those node/s. 
Chain
Assets per Node
​ETH2​
32 ETH per Validator
​Dash​
1,000 DASH per Masternode
Horizen
500 ZEN per Supernode
Keep
100,000 KEEP per Node
ETH2
Provision validators with an API request and submit the deposits through a single ETH1 transaction. 
Integration Environments
Staked supports integration testing on ETH2, as defined below.
Base URL
ETH2 Network
ETH1 Network
https://mainnet.staked.cloud/api
Mainnet
Mainnet
https://testnet.staked.cloud/api
Pyrmont
Goerli
post
Post ETH2 Provisioning Request
https://mainnet.staked.cloud/api/provisioning_requests/eth2
Provision ETH2 validators in our secure cloud environments. The response contains a unique identifier for the provisioning request.
Request
Response
Request
Query Parameters
api_key
required
string
Your API Key - (Must have ETH2 access)
Body Parameters
attributes
required
object
ETH2 Attributes Object
Response
200: OK
{
    "id": "163",
    "uuid": "693c10d8-70e5-4a5d-aeb0-6c53ea625433",
    "created": "2020-11-14T19:51:14",
    "status": "CREATED",
    "chain": "ETH2",
    "user_id": null,
    "partner_id": "18",
    "attributes": {
        "validators": [
            {
                "cloud": "amazon",
                "count": 1
            }
        ],
        "withdrawalKey": "b211ebaaa4d28539aec2e323fef6ea205a2c02c3197b1698c3a2252d5eb41b997079a533181a9367b4d2294c758bf472"
    }
}
Postman - Provisioning Request
ETH2 Testnet - Post Provisioning Request.postman_collection.json - 1KB
ETH2 Attributes Object
Field
Description
Type
withdrawalKey
BLS Public Key
String
validators
Array of validator config objects
Array
Validator Config Object
Field
Description
Type
provider
Validator provider enum: "decentralized" or "amazon"
String
count
Number of validators to provision
Number
// example post request body
{
    "attributes": {
        "withdrawalKey": "YOUR ETH2 WITHDRAWAL KEY",
        "validators": [
            {
                "provider": "decentralized",
                "count": 5
            }
        ]
    }
}
Provisioning Response Object
Field
Description
Type
id
Numbered identifier of provisioning request
String
uuid
Unique identifier of provisioning request
String
created
Provisioning request creation datetime
String
status
Provisioning request status - "CREATED"
String
chain
Chain identifier - "ETH2"
String
user_id
User identifier - returns null unless using oauth
String
partner_id
Partner identifier associated with api key
String
attributes
ETH2 attributes object
Object
get
Get ETH2 Delegation Objects
https://mainnet.staked.cloud/api/delegations/eth2
After POSTing a provisioning request, use the unique identifier to GET the delegation objects for each validator. Delegation objects contain the information required to submit deposits on ETH1.
Request
Response
Request
Query Parameters
api_key
required
string
Your API Key - (Must have ETH2 access)
filters
optional
string
provisioning_request_uuid:YOUR UUID
page
optional
number
Page of results to fetch
per_page
optional
number
Number of results per page
Response
200: OK
Paginated results containing ETH2 delegation objects.
{
    "results": [
        {
            "id": 4308,
            "address": "82fcdaa3d3f1429dea23b02eeae00bfff41ec9c1d0281a1b4d58d782111eef691d972af56799fda43a6a46fdac49bd65",
            "chain": "ETH2",
            "attributes": {
                "cloud": "amazon",
                "count": 1,
                "index": 1,
                "depositInput": "22895118000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000012020e35863f9077de93ac5f59bbb8adea7cfd0a4cc02795a0d43ce87cd82b9f1b9000000000000000000000000000000000000000000000000000000000000003082fcdaa3d3f1429dea23b02eeae00bfff41ec9c1d0281a1b4d58d782111eef691d972af56799fda43a6a46fdac49bd650000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200027662cfd6fa4cfe93b5d34c233756e2b972c7b0a0e11f2e4500d1f131e604d0000000000000000000000000000000000000000000000000000000000000060863fc2373413eac068f088acad56c7f5125c852fc45ba531cccfa50db1c375892c56d9d8d6610e9d2954c9232e0ac97009faaa67ae24dacb853002a37baa257651f0bc3ec915b3014c916c18c28fdc92c71b5b3a251c859410ed9651225e9fd5",
                "validatorKey": "82fcdaa3d3f1429dea23b02eeae00bfff41ec9c1d0281a1b4d58d782111eef691d972af56799fda43a6a46fdac49bd65"
            },
            "amount": "0",
            "created": "2020-11-14T19:51:14",
            "status": "CREATED",
            "user_id": null,
            "partner_id": "18",
            "provisioning_request_uuid": "693c10d8-70e5-4a5d-aeb0-6c53ea625433",
            "provisioning_request_id": "163"
        },
        ...
    ],
    "page": 1,
    "pages": 9,
    "per_page": 10,
    "total": 86
}
Postman - Delegation Objects
ETH2 Testnet - Get Delegation Objects.postman_collection.json - 1KB
Validators are provisioned asynchronously, meaning the GET request will fill-in over time as our infrastructure fulfills the associated provisioning request. Use the "total" field in the response object to track the number of validators provisioned at any given time.
Paginated Response Object
Field
Description
Type
results
Array of ETH2 delegation objects
Array
page
Page of fetched results
Number
pages
Total number of pages
Number
per_page
Number of results per page
Number
total
Number of results in total
Number
ETH2 Delegation Object
Field
Description
Type
id
Identifier of delegation object
Number
address
Validator public key
String
chain
Chain identifier - "ETH2"
String
attributes
ETH2 delegation attributes object
Object
amount
Amount currently delegated
String
created
Delegation object creation time
String
status
ETH2 delegation status enum
String
user_id
User identifier - returns null unless using oauth
String
partner_id
Partner identifier associated with api key
String
provisioning_request_uuid
Associated provisioning request unique identifier
String
provisioning_request_id
Associated provisioning request numbered identifier
String
ETH2 Delegation Attributes Object
Field
Description
Type
cloud
Validator cloud configuration
String
count
Total number of validators in associated provisioning request
Number
index
Index of validator in associated provisioning request
Number
depositInput
Validator deposit transaction data
String
validatorKey
Validator public key
String
ETH2 Delegation Status Enum
Value
Definition
Time Period
CREATED
Validator was provisioned through Staked API
n /a
DEPOSITED
Deposit is waiting to be seen by ETH2 chain
0-6 Hours
PENDING
Validator is in the queue waiting to go live	
0-6 Days
ACTIVE
Validator is participating and earning rewards	
n / a
Submit Deposits through the Batching Contract
The canonical ETH2 deposit contract, used to convert ETH1 to ETH2, only supports one deposit transaction at a time. Since 32 ETH is required for each validator, depositors with large amounts of ETH would have to broadcast many deposit transactions.
To simplify submitting deposits, we have created a batching contract which takes up to 185 deposits at once and submits each to the deposit contract. Integrators can therefore stake up to 5920 ETH in one Ethereum transaction, and leave behind the hassle of tracking many individually broadcasted transactions.
Batching Contract Deployments
ETH2 Network
ETH1 Network
Batching Contract Address
Mainnet
Mainnet
​0x39DC6a99209B5e6B81dC8540C86Ff10981ebDA29​
Pyrmont
Goerli
​0x061e6993baFD5858242a4A10b757c870Eb2A8041​
BatchDeposit.json
BatchDeposit.json - 2KB
The batching contract contains an external payable function, batchDeposits, which loops over each validator's deposit and sends them to the deposit contract. The function arguments are passed as a 2-d array where the array at [i] represents the deposit arguments for validator i.
For release notifications of the ETH2 API and developer tools, click here.
Dash
Automate provisioning of Dash masternodes.
Integration Environments
Staked supports integration testing on Dash, as described below.
Base URL
Dash Network
https://mainnet.staked.cloud/api 
Mainnet
https://testnet.staked.cloud/api
Testnet
Email [email protected] for testnet Dash, or request it in the Dash Discord. Staked will support 2 masternodes per partner account in a testnet environment.
Getting Started
Each masternode requires an unspent transaction output (UTXO) of exactly 1,000 DASH. The address that owns this UTXO is the collateral address.
Instructions below assume use of the dash command line tool or debug console in the GUI wallet. If using the debug console, please remove dash-cli from the beginning of each command.
Create a new address to hold your masternode collateral.
dash-cli getnewaddress <address-alias>
Example
dash-cli getnewaddress masternode_collateral_1
Next, send exactly 1,000 Dash to your collateral address.
dash-cli sendtoaddress <address> <amount>
Example
dash-cli sendtoaddress yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg 1000
Get the transaction id and output index of the transaction you just created (you may need to wait up to 2 minutes until your transaction is added to a block).
dash-cli masternode outputs
masternode outputs
schema 
{
  "tx id": "collateral index"
}
​
example
{
  "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2": "1",
  ...
}
​
A payout address is also needed and can be generated using the getnewaddress command. A single payout address can be shared across masternodes.
post
Step 1: Post Masternode Provisioning Request
https://mainnet.staked.cloud/api/delegations/DASH/delegator/:collateralAddress
Provision a new masternode after sending 1,000 DASH to a collateral address.
Request
Response
Request
Path Parameters
collateralAddress
required
string
Your collateral address
Headers
Content-Type
required
string
application/json
Query Parameters
api_key
required
string
Your api key
Body Parameters
attributes
required
object
Using example from pre-reqs:
{ 
"collateralHash": "3483e20a675d7585f0...", "collateralIndex": 1, 
"payoutAddress": "Payout address here"
}
Response
200: OK
{
    "id": 2691,
    "address": "yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg",
    "chain": "DASH",
    "attributes": {
        "payoutAddress": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp",
        "collateralHash": "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2",
        "collateralIndex": 1
    },
    "created": "2020-06-04T21:23:32",
    "status": "CREATED"
}
get
Step 2: Poll Masternode Status
https://mainnet.staked.cloud/api/delegations/DASH/delegator/:collateralAddress
Poll the masternode status. The status is initially set as CREATED. Once the masternode registration message is created through Staked's provisioning infrastructure the response will pass the message for signing along with a status of WaitingForSigning.
Request
Response
Request
Path Parameters
collateralAddress
required
string
Your collateral address used previously.
Query Parameters
api_key
required
string
Your API Key
Response
200: OK
Status is "CREATED"
{
    "results": [
        "id": 2691,
        "address": "yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg",
        "chain": "DASH",
        "attributes": {
            "payoutAddress": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp",
            "collateralHash": "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2",
            "collateralIndex": 1
        },
        "created": "2020-06-04T21:23:32",
        "status": "CREATED"
    ],
    "page": 1,
    "pages": 1,
    "per_page": 10,
    "total": 1
}
​
Status is "WaitingForSigning"
{
    "results": [
        {
            "id": 2691,
            "address": "yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg",
            "chain": "DASH",
            "attributes": {
                "ipAndPort": "52.10.215.49:19999",
                "signMessage": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp|1000|yQFVUWVMP5kVM9Rp8oXLScEAsPMB974rPd|yQFVUWVMP5kVM9Rp8oXLScEAsPMB974rPd|d85fcd73cdb916b1dce77e993cbb915b58381d29067d18757550f9a5dfec5de9",
                "internalPort": 32419,
                "ownerKeyAddr": "yQFVUWVMP5kVM9Rp8oXLScEAsPMB974rPd",
                "registerTxId": "03000100012730d8726ddae3434dfec7e66923b01134a1124982e9e71e1a5f79e2575de2a50000000000feffffff0142b19a3b000000001976a914641138d9d61f2b7d8cccd6c29959349549ba5e8388ac00000000d1010000000000a2d4a5758c419204f88ad86aee5498e55125f57975a0d3f085755d670ae283340100000000000000000000000000ffff340ad7314e1f2b210805a79c2e5e453b20ef85d29633c151076c85c86cdb8d2ebf444fbc40c739b190e56a4c2f8ae9d26567bf2b0d3152ff7c435df652866f572af774d11454fe92a6d12b210805a79c2e5e453b20ef85d29633c151076ce8031976a9142a41da2a5517ae71484594d2187c7f99ed20e91e88ac34dec225612f265fb337240197d8f30ba22a6d5ca12547e50a91ff2aec7bedaa00",
                "payoutAddress": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp",
                "collateralHash": "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2",
                "operatorPubKey": "85c86cdb8d2ebf444fbc40c739b190e56a4c2f8ae9d26567bf2b0d3152ff7c435df652866f572af774d11454fe92a6d1",
                "collateralIndex": 1
            },
            "amount": null,
            "created": "2020-06-04T21:23:32",
            "status": "WaitingForSigning"
        }
    ],
    "page": 1,
    "pages": 1,
    "per_page": 10,
    "total": 1
}
Step 3: Sign Delegation Message
This must be run on the wallet or device that holds collateral key, and can be done completely offline if required. signMessage is returned in the response of the previous step.
signmessage collateralAddress signMessage
Example Output:
H3ub9BATtvuV+zDGdkUQNoUGpaYFr/O1FypmrSmH5WJ0KFRi8T10FSew0EJO/+Ij+OLv4r0rt+HS9pQFsZgc2dE=
put
Step 4: Send Us the Signed Delegation Message
https://mainnet.staked.cloud/api/delegations/DASH/delegator/:collateralAddress
Finally, send Staked the signed transaction and we will broadcast it to the Dash blockchain!
Request
Response
Request
Path Parameters
collateralAddress
required
string
Masternode collateral address set up previously.
Query Parameters
api_key
required
string
Your API Key
Body Parameters
attributes
required
string
{
    "signedTx": "Your Signed Message"
}
status
required
string
Set as "WaitingtoSubmit"

Response
200: OK
​
The status of the delegation object is now WaitingToSubmit. When the Masternode is synched, the signedTx will be submitted and the status will be Ready.
Boom! You've programmatically set up a Masternode. Check out the Reporting API to monitor your position.

Staking - Previous

Delegations

Next - Staking

Reporting API

Last updated 4 months ago

Chain	Assets per Node
ETH2	32 ETH per Validator
Dash	1,000 DASH per Masternode
Horizen	500 ZEN per Supernode
Keep	100,000 KEEP per Node

Base URL	ETH2 Network	ETH1 Network
https://mainnet.staked.cloud/api	Mainnet	Mainnet
https://testnet.staked.cloud/api	Pyrmont	Goerli

Field	Description	Type
withdrawalKey	BLS Public Key	String
validators	Array of validator config objects	Array

Value	Definition	Time Period
CREATED	Validator was provisioned through Staked API	n /a
DEPOSITED	Deposit is waiting to be seen by ETH2 chain	0-6 Hours
PENDING	Validator is in the queue waiting to go live	0-6 Days
ACTIVE	Validator is participating and earning rewards	n / a

ETH2 Network	ETH1 Network	Batching Contract Address
Mainnet	Mainnet	0x39DC6a99209B5e6B81dC8540C86Ff10981ebDA29
Pyrmont	Goerli	0x061e6993baFD5858242a4A10b757c870Eb2A8041

Base URL	Dash Network
https://mainnet.staked.cloud/api	Mainnet
https://testnet.staked.cloud/api	Testnet

Node Provisioning API

What is the Node Provisioning API?

ETH2

Integration Environments

postPost ETH2 Provisioning Request

ETH2 Attributes Object

Validator Config Object

Provisioning Response Object

getGet ETH2 Delegation Objects

Paginated Response Object

ETH2 Delegation Object

ETH2 Delegation Attributes Object

ETH2 Delegation Status Enum

Submit Deposits through the Batching Contract

Batching Contract Deployments

Dash

Integration Environments

Getting Started

postStep 1: Post Masternode Provisioning Request

getStep 2: Poll Masternode Status

Step 3: Sign Delegation Message

putStep 4: Send Us the Signed Delegation Message

post
Post ETH2 Provisioning Request

get
Get ETH2 Delegation Objects

post
Step 1: Post Masternode Provisioning Request

get
Step 2: Poll Masternode Status

put
Step 4: Send Us the Signed Delegation Message