Update a collateral package

curl --request PATCH \
  --url https://api.anchorage-staging.com/v2/collateral_management/packages/{packageId} \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acceleratedMarginCall": {
    "curePeriod": "<string>",
    "ltv": "<string>"
  },
  "autoDeleveraging": {
    "levels": [
      {
        "liquidationPercentage": "<string>",
        "price": "<string>"
      }
    ]
  },
  "clientReferenceId": "<string>",
  "collateralAssetsConfig": [
    {
      "asset": {
        "assetType": "<string>"
      },
      "liquidationPriority": 123,
      "maxStalenessMinutes": 123,
      "notes": "<string>",
      "weight": "<string>"
    }
  ],
  "critical": {
    "defaultNotice": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "warningLtv": "<string>"
  },
  "isActive": true,
  "ltvRoundingPrecision": 123,
  "marginCall": {
    "curePeriod": "<string>",
    "curePeriodProtection": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "warningLtv": "<string>"
  },
  "marginReturn": {
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "returnType": "<string>"
  }
}
'

import requests

url = "https://api.anchorage-staging.com/v2/collateral_management/packages/{packageId}"

payload = {
    "acceleratedMarginCall": {
        "curePeriod": "<string>",
        "ltv": "<string>"
    },
    "autoDeleveraging": { "levels": [
            {
                "liquidationPercentage": "<string>",
                "price": "<string>"
            }
        ] },
    "clientReferenceId": "<string>",
    "collateralAssetsConfig": [
        {
            "asset": { "assetType": "<string>" },
            "liquidationPriority": 123,
            "maxStalenessMinutes": 123,
            "notes": "<string>",
            "weight": "<string>"
        }
    ],
    "critical": {
        "defaultNotice": True,
        "ltv": "<string>",
        "returnToLtv": "<string>",
        "warningLtv": "<string>"
    },
    "isActive": True,
    "ltvRoundingPrecision": 123,
    "marginCall": {
        "curePeriod": "<string>",
        "curePeriodProtection": True,
        "ltv": "<string>",
        "returnToLtv": "<string>",
        "warningLtv": "<string>"
    },
    "marginReturn": {
        "ltv": "<string>",
        "returnToLtv": "<string>",
        "returnType": "<string>"
    }
}
headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    acceleratedMarginCall: {curePeriod: '<string>', ltv: '<string>'},
    autoDeleveraging: {levels: [{liquidationPercentage: '<string>', price: '<string>'}]},
    clientReferenceId: '<string>',
    collateralAssetsConfig: [
      {
        asset: {assetType: '<string>'},
        liquidationPriority: 123,
        maxStalenessMinutes: 123,
        notes: '<string>',
        weight: '<string>'
      }
    ],
    critical: {
      defaultNotice: true,
      ltv: '<string>',
      returnToLtv: '<string>',
      warningLtv: '<string>'
    },
    isActive: true,
    ltvRoundingPrecision: 123,
    marginCall: {
      curePeriod: '<string>',
      curePeriodProtection: true,
      ltv: '<string>',
      returnToLtv: '<string>',
      warningLtv: '<string>'
    },
    marginReturn: {ltv: '<string>', returnToLtv: '<string>', returnType: '<string>'}
  })
};

fetch('https://api.anchorage-staging.com/v2/collateral_management/packages/{packageId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "active": true,
  "clientReferenceId": "<string>",
  "collateralAssets": [
    {
      "asset": {
        "assetType": "<string>",
        "type": "ANCHORAGECUSTODY"
      },
      "weight": "<string>",
      "autoWalletAddress": "<string>",
      "autoWalletID": "<string>",
      "price": "<string>",
      "priceSource": "COINBASEPRO",
      "priceStrategy": "DEFAULT",
      "quantity": "<string>",
      "weightedValue": "<string>"
    }
  ],
  "critical": {
    "action": "NONE",
    "defaultNotice": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "warningLtv": "<string>"
  },
  "packageId": "<string>",
  "pledgorId": "<string>",
  "securedPartyId": "<string>",
  "acceleratedMarginCall": {
    "action": "NONE",
    "curePeriod": "<string>",
    "ltv": "<string>"
  },
  "currentLtv": "<string>",
  "exposureValue": "<string>",
  "ltvTimestamp": "<string>",
  "marginCall": {
    "action": "NONE",
    "curePeriod": "<string>",
    "curePeriodProtection": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "topUpType": "LTV",
    "warningLtv": "<string>"
  },
  "marginReturn": {
    "action": "NONE",
    "ltv": "<string>",
    "returnToLtv": "<string>"
  },
  "packageValue": "<string>",
  "state": "MARGIN_RETURN"
}

{
  "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'."
}

PATCH

collateral_management

packages

{packageId}

Update a collateral package

curl --request PATCH \
  --url https://api.anchorage-staging.com/v2/collateral_management/packages/{packageId} \
  --header 'Api-Access-Key: <api-key>' \
  --header 'Api-Signature: <api-signature>' \
  --header 'Api-Timestamp: <api-timestamp>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "acceleratedMarginCall": {
    "curePeriod": "<string>",
    "ltv": "<string>"
  },
  "autoDeleveraging": {
    "levels": [
      {
        "liquidationPercentage": "<string>",
        "price": "<string>"
      }
    ]
  },
  "clientReferenceId": "<string>",
  "collateralAssetsConfig": [
    {
      "asset": {
        "assetType": "<string>"
      },
      "liquidationPriority": 123,
      "maxStalenessMinutes": 123,
      "notes": "<string>",
      "weight": "<string>"
    }
  ],
  "critical": {
    "defaultNotice": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "warningLtv": "<string>"
  },
  "isActive": true,
  "ltvRoundingPrecision": 123,
  "marginCall": {
    "curePeriod": "<string>",
    "curePeriodProtection": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "warningLtv": "<string>"
  },
  "marginReturn": {
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "returnType": "<string>"
  }
}
'

import requests

url = "https://api.anchorage-staging.com/v2/collateral_management/packages/{packageId}"

payload = {
    "acceleratedMarginCall": {
        "curePeriod": "<string>",
        "ltv": "<string>"
    },
    "autoDeleveraging": { "levels": [
            {
                "liquidationPercentage": "<string>",
                "price": "<string>"
            }
        ] },
    "clientReferenceId": "<string>",
    "collateralAssetsConfig": [
        {
            "asset": { "assetType": "<string>" },
            "liquidationPriority": 123,
            "maxStalenessMinutes": 123,
            "notes": "<string>",
            "weight": "<string>"
        }
    ],
    "critical": {
        "defaultNotice": True,
        "ltv": "<string>",
        "returnToLtv": "<string>",
        "warningLtv": "<string>"
    },
    "isActive": True,
    "ltvRoundingPrecision": 123,
    "marginCall": {
        "curePeriod": "<string>",
        "curePeriodProtection": True,
        "ltv": "<string>",
        "returnToLtv": "<string>",
        "warningLtv": "<string>"
    },
    "marginReturn": {
        "ltv": "<string>",
        "returnToLtv": "<string>",
        "returnType": "<string>"
    }
}
headers = {
    "Api-Signature": "<api-signature>",
    "Api-Timestamp": "<api-timestamp>",
    "Api-Access-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Api-Signature': '<api-signature>',
    'Api-Timestamp': '<api-timestamp>',
    'Api-Access-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    acceleratedMarginCall: {curePeriod: '<string>', ltv: '<string>'},
    autoDeleveraging: {levels: [{liquidationPercentage: '<string>', price: '<string>'}]},
    clientReferenceId: '<string>',
    collateralAssetsConfig: [
      {
        asset: {assetType: '<string>'},
        liquidationPriority: 123,
        maxStalenessMinutes: 123,
        notes: '<string>',
        weight: '<string>'
      }
    ],
    critical: {
      defaultNotice: true,
      ltv: '<string>',
      returnToLtv: '<string>',
      warningLtv: '<string>'
    },
    isActive: true,
    ltvRoundingPrecision: 123,
    marginCall: {
      curePeriod: '<string>',
      curePeriodProtection: true,
      ltv: '<string>',
      returnToLtv: '<string>',
      warningLtv: '<string>'
    },
    marginReturn: {ltv: '<string>', returnToLtv: '<string>', returnType: '<string>'}
  })
};

fetch('https://api.anchorage-staging.com/v2/collateral_management/packages/{packageId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "active": true,
  "clientReferenceId": "<string>",
  "collateralAssets": [
    {
      "asset": {
        "assetType": "<string>",
        "type": "ANCHORAGECUSTODY"
      },
      "weight": "<string>",
      "autoWalletAddress": "<string>",
      "autoWalletID": "<string>",
      "price": "<string>",
      "priceSource": "COINBASEPRO",
      "priceStrategy": "DEFAULT",
      "quantity": "<string>",
      "weightedValue": "<string>"
    }
  ],
  "critical": {
    "action": "NONE",
    "defaultNotice": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "warningLtv": "<string>"
  },
  "packageId": "<string>",
  "pledgorId": "<string>",
  "securedPartyId": "<string>",
  "acceleratedMarginCall": {
    "action": "NONE",
    "curePeriod": "<string>",
    "ltv": "<string>"
  },
  "currentLtv": "<string>",
  "exposureValue": "<string>",
  "ltvTimestamp": "<string>",
  "marginCall": {
    "action": "NONE",
    "curePeriod": "<string>",
    "curePeriodProtection": true,
    "ltv": "<string>",
    "returnToLtv": "<string>",
    "topUpType": "LTV",
    "warningLtv": "<string>"
  },
  "marginReturn": {
    "action": "NONE",
    "ltv": "<string>",
    "returnToLtv": "<string>"
  },
  "packageValue": "<string>",
  "state": "MARGIN_RETURN"
}

{
  "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'."
}

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

Path Parameters

packageId

string

required

The unique identifier of the package to update.

Minimum string length: 1

Body

application/json

The details for updating an existing collateral package

The request payload for updating an existing collateral package. All fields are optional - only provide the fields you want to update.

acceleratedMarginCall

object

Accelerated Margin Call level configuration for updates. All fields are optional.

Show child attributes

autoDeleveraging

object

Auto-deleveraging configuration for updates. All fields are optional.

Show child attributes

clientReferenceId

string

A reference identifier provided by the client for this collateral package

collateralAssetsConfig

object[]

Array of asset tracking configurations. If provided, this will replace the entire existing asset tracking configuration.

Show child attributes

critical

object

Critical level configuration for updates. All fields are optional.

Show child attributes

isActive

boolean

Indicates whether the package should be activated for monitoring or not

ltvRoundingPrecision

integer

Number of decimal places to round LTV values to

marginCall

object

Margin Call level configuration for updates. All fields are optional.

Show child attributes

marginReturn

object

Margin Return level configuration for updates. All fields are optional.

Show child attributes

priceStrategy

enum<string>

deprecated

Deprecated: set priceStrategy on each collateralAssetsConfig entry instead. When sent, every asset on the package takes this value, listed in collateralAssetsConfig or not, and no collateralAssetsConfig entry may carry its own priceStrategy.

Available options:

DEFAULT,

BID,

ASK,

MID,

LAST,

CHAINLINK_STRATEGY

Response

Successfully updated collateral package

A package of different types of collateral which, together, secure a collection of exposures.

active

boolean

required

Indicates whether the package has been activated for monitoring or not

clientReferenceId

string

required

Client-provided reference ID for this Collateral Package

collateralAssets

object[]

required

An array containing objects, where each object represents a specific asset held within the Collateral Package and its associated details

Show child attributes

critical

object

required

Critical level config

Show child attributes

packageId

string

required

Unique identifier for the Collateral Package

pledgorId

string

required

Collateral management participant ID of the Pledgor (borrower) associated with this collateral package

securedPartyId

string

required

Collateral management participant ID of the Secure Party (lender) associated with this collateral package

acceleratedMarginCall

object

Accelerated Margin Call level config

Show child attributes

currentLtv

string

The current Loan-to-Value (LTV) ratio for the Collateral Package, expressed as a decimal string

exposureValue

string

The current total value of the Exposure(s) associated with this Collateral Package, expressed in USD

ltvTimestamp

string

Timestamp indicating the last time the currentLtv was calculated and updated. This timestamp provides context for the recency of the LTV value

marginCall

object

Margin Call level config

Show child attributes

marginReturn

object

Margin Return level config

Show child attributes

packageValue

string

The current total value of the Collateral Package, calculated using the configured pricing methodology and real-time price data, expressed in USD

state

enum<string>

Current state of the Collateral Package

Available options:

MARGIN_RETURN,

HEALTHY,

MARGIN_CALL,

CRITICAL,

CLOSED,

CURE_PERIOD_EXPIRED,

DEFAULTED

Getting started

Anchorage custody

Move money

Atlas

Wealth Management & ETF

Trading

Webhooks

Update a collateral package

Authorizations

Headers

Path Parameters

Body

Response