Create a stake request

curl --request POST \
  --url https://api.anchorage-staging.com/v2/transactions/stake \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "32",
  "assetType": "ETH",
  "idempotentId": "12838927347",
  "source": {
    "id": "1c920f4241b78a1d483a29f3c24b6c4c",
    "type": "WALLET"
  },
  "description": "Internal ID: #12838927347",
  "parameters": {
    "stakingProviderAddress": "<string>"
  }
}
'

import requests

url = "https://api.anchorage-staging.com/v2/transactions/stake"

payload = {
    "amount": "32",
    "assetType": "ETH",
    "idempotentId": "12838927347",
    "source": {
        "id": "1c920f4241b78a1d483a29f3c24b6c4c",
        "type": "WALLET"
    },
    "description": "Internal ID: #12838927347",
    "parameters": { "stakingProviderAddress": "<string>" }
}
headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '32',
    assetType: 'ETH',
    idempotentId: '12838927347',
    source: {id: '1c920f4241b78a1d483a29f3c24b6c4c', type: 'WALLET'},
    description: 'Internal ID: #12838927347',
    parameters: {stakingProviderAddress: '<string>'}
  })
};

fetch('https://api.anchorage-staging.com/v2/transactions/stake', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "transactionId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
  }
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

Create a stake request

Permissions required: Initiate Staking and Unstaking

Identify the sending asset

To initiate a staking operation, you must identify which asset you’d like to stake funds from. Provide a source and assetType.

Permissions

The provided API key must be associated with a permission group that has Initiate Staking and Unstaking permission for the sending vault.

Additional Metadata

You may provide a description with each staking operation, that will be visible within your organization in the Anchorage Digital iOS Application.

Successful Staking

If the stake request is valid, the request will initiate a stake transaction from the sending wallet. It will still require a quorum of approvals on the Anchorage Digital iOS app and will undergo manual Anchorage Digital Risk Review. Like other transactions, these will be visible on the Anchorage Digital iOS Application, the Web Dashboard, and in the list transactions API endpoint.

Unsuccessful Stakes

A stake request may fail for any of the following reasons:

An ongoing stake already exists
The specified asset does not exist
The specified amount exceeds the available funds for this asset (insufficient funds)
The provided API key does not have permissions to initiate staking from this vault

If the initiated stake is approved by the quorum, the transaction may fail for any of the following reasons:

There are insufficient funds to pay the blockchain network fee at the time of this transaction
There is a failure on the blockchain

Feature under development

Currently, specific assets parameters are under development and will not be considered in any staking request. These include:

Solana staking;
ETH Pectra staking.

POST

transactions

stake

Create a stake request

curl --request POST \
  --url https://api.anchorage-staging.com/v2/transactions/stake \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "32",
  "assetType": "ETH",
  "idempotentId": "12838927347",
  "source": {
    "id": "1c920f4241b78a1d483a29f3c24b6c4c",
    "type": "WALLET"
  },
  "description": "Internal ID: #12838927347",
  "parameters": {
    "stakingProviderAddress": "<string>"
  }
}
'

import requests

url = "https://api.anchorage-staging.com/v2/transactions/stake"

payload = {
    "amount": "32",
    "assetType": "ETH",
    "idempotentId": "12838927347",
    "source": {
        "id": "1c920f4241b78a1d483a29f3c24b6c4c",
        "type": "WALLET"
    },
    "description": "Internal ID: #12838927347",
    "parameters": { "stakingProviderAddress": "<string>" }
}
headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '32',
    assetType: 'ETH',
    idempotentId: '12838927347',
    source: {id: '1c920f4241b78a1d483a29f3c24b6c4c', type: 'WALLET'},
    description: 'Internal ID: #12838927347',
    parameters: {stakingProviderAddress: '<string>'}
  })
};

fetch('https://api.anchorage-staging.com/v2/transactions/stake', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "transactionId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
  }
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

{
  "message": "Missing required field 'amount'."
}

Authorizations

Api-Access-Key

string

header

required

An API key associated with a security role

Headers

Api-Signature

string

required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Construction example:

toHex(
  ed25519Sign(
    signing_key,
    '{}{}{}{}'.format(timestamp_epoch_seconds, toUpper(httpMethod), httpRequestPath, httpBody)
  )
)

Pattern: ^[0-9A-Fa-f]{128,160}$

Api-Timestamp

integer<int64>

required

Current timestamp, represented as unix epoch seconds

Body

application/json

amount

string

required

An amount of a crypto-asset to transfer, without units. The unit is derived from the asset type.

Example:

"32"

assetType

string

required

A string representing a type of crypto-asset, which usually corresponds to the crypto asset's ticker symbol.

Use /asset-types to list all of the supported asset types for your organization.

Example:

"ETH"

idempotentId

string

required

A client-provided unique ID for idempotent requests

Maximum string length: 128

Example:

"12838927347"

source

SimpleSourceResourceDetails · object

required

An object representing a resource capable of sending funds.

Construction example:

{
"id":"1c920f4241b78a1d483a29f3c24b6c4c",
"type":"WALLET"
}

Show child attributes

description

string | null

An optional string providing more context to this transaction. It will be visible on the Anchorage Digital iOS app and will not be published to the blockchain.

Example:

"Internal ID: #12838927347"

parameters

SOLStakingParameters · object

UNDER DEVELOPMENT: Solana specific staking parameters

SOLStakingParameters
SOLStakingParameters
ETHStakingParameters

Show child attributes

Response

Successfully initiated a stake transaction

data

CreateStakeDetails · object

required

Show child attributes

Example:

{
  "transactionId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
}

Get transaction by ID Create an unstake request

⌘I