Create an unstake request

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

import requests

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

payload = {
    "assetType": "ETH",
    "idempotentId": "12838927347",
    "source": {
        "id": "1c920f4241b78a1d483a29f3c24b6c4c",
        "type": "WALLET"
    },
    "amount": "32",
    "description": "Internal ID: #12838927347",
    "isFullAmount": False,
    "stakingPositionId": "9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a"
}
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({
    assetType: 'ETH',
    idempotentId: '12838927347',
    source: {id: '1c920f4241b78a1d483a29f3c24b6c4c', type: 'WALLET'},
    amount: '32',
    description: 'Internal ID: #12838927347',
    isFullAmount: false,
    stakingPositionId: '9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a'
  })
};

fetch('https://api.anchorage-staging.com/v2/transactions/unstake', 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 an unstake request

Permissions required: Initiate Staking and Unstaking

Identify the sending asset

To initiate an unstake transaction, you must identify which asset you’d like to unstake 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 stake, that will be visible within your organization in the Anchorage Digital iOS Application.

Successful Unstakes

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 Unstakes

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

An ongoing unstake already exists
The specified asset does not exist
The specified amount exceeds the available funds to unstake 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

POST

transactions

unstake

Create an unstake request

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

import requests

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

payload = {
    "assetType": "ETH",
    "idempotentId": "12838927347",
    "source": {
        "id": "1c920f4241b78a1d483a29f3c24b6c4c",
        "type": "WALLET"
    },
    "amount": "32",
    "description": "Internal ID: #12838927347",
    "isFullAmount": False,
    "stakingPositionId": "9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a"
}
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({
    assetType: 'ETH',
    idempotentId: '12838927347',
    source: {id: '1c920f4241b78a1d483a29f3c24b6c4c', type: 'WALLET'},
    amount: '32',
    description: 'Internal ID: #12838927347',
    isFullAmount: false,
    stakingPositionId: '9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a'
  })
};

fetch('https://api.anchorage-staging.com/v2/transactions/unstake', 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

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

amount

string | null

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

Example:

"32"

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"

isFullAmount

boolean

default:false

Specifies whether to unstake the full amount, which overrides any provided amount if set to true.

stakingPositionId

string

Unique identifier of the staking position

Example:

"9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a"

Response

Successfully initiated a unstake transaction

data

CreateStakeDetails · object

required

Show child attributes

Example:

{
  "transactionId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
}

Create a stake request Create a collect request

⌘I