Create a collect request

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

import requests

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

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

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

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

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

POST

transactions

collect

Create a collect request

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

import requests

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

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

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

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

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

{
  "errorType": "InternalError",
  "message": "Missing required field 'amount'."
}

Signed and idempotent. The signer injects idempotentId into the body before computing the signature.

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"

source

SimpleSourceResourceDetails · object

required

An object representing a resource capable of sending funds.

Construction example:

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

Show child attributes

stakingPositionId

string

required

Unique identifier of the staking position

Example:

"9bc4c2ccba8192b64d41b46d1770abe9ddbb430b85de3fe73e1b4f21336bc48a"

amount

string

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"

idempotentId

string

A client-provided unique ID for idempotent requests

Maximum string length: 128

Example:

"12838927347"

isFullAmount

boolean

default:false

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

Response

Successfully initiated a collect transaction

data

CreateStakeDetails · object

required

Show child attributes

Example:

{
  "transactionId": "8696144cca28a634c05858d00e51191408498a7808a837fc4645b4b6997dde09"
}

Getting started

Anchorage custody

Move money

Atlas

Wealth Management & ETF

Trading

Webhooks

Create a collect request

Authorizations

Headers

Body

Response