Skip to content

Get Collaterals

Retrieve configuration for all supported collateral assets, including deposit caps, LTV thresholds, withdrawal fees, and tiered haircut structures.

Endpoint

POST https://papi.synthetix.io/v1/info

Request

Request Format

{
  "params": {
    "action": "getCollaterals"
  }
}

Request Parameters

ParameterTypeRequiredDescription
params.actionstringYesMust be "getCollaterals"

Response

Success Response

{
  "status": "ok",
  "response": [
    {
      "collateral": "USDT",
      "market": "USDTUSD",
      "depositCap": "10000000.00000000",
      "ltv": "0.95",
      "lltv": "0.98",
      "withdrawFee": "5.00000000",
      "tiers": [
        {
          "id": 1,
          "name": "Tier1",
          "minAmount": "0.00000000",
          "maxAmount": "100000.00000000",
          "valueRatio": "1.00000000",
          "haircut": "0.00000000",
          "valueAddition": "0.00000000"
        },
        {
          "id": 2,
          "name": "Tier2",
          "minAmount": "100000.00000000",
          "maxAmount": "",
          "valueRatio": "0.99500000",
          "haircut": "0.00500000",
          "valueAddition": "0.00000000"
        }
      ]
    },
    {
      "collateral": "ETH",
      "market": "ETHUSD",
      "depositCap": "5000.00000000",
      "ltv": "0.90",
      "lltv": "0.95",
      "withdrawFee": "5.00000000",
      "tiers": [
        {
          "id": 3,
          "name": "Tier1",
          "minAmount": "0.00000000",
          "maxAmount": "50000.00000000",
          "valueRatio": "0.98000000",
          "haircut": "0.02000000",
          "valueAddition": "0.00000000"
        }
      ]
    }
  ],
  "requestId": "5ccf215d37e3ae6d"
}

Collateral Object Fields

FieldTypeDescription
collateralstringCollateral asset symbol (e.g., "USDT", "ETH", "WBTC")
marketstringPrice feed market used to value this collateral (e.g., "USDTUSD", "ETHUSD")
depositCapstringPlatform-wide maximum deposit limit for this collateral type (decimal string)
ltvstringLoan-to-Value ratio - target after auto-exchange (e.g., "0.95" for 95%)
lltvstringLiquidation LTV - threshold that triggers auto-exchange to USDT (e.g., "0.98" for 98%)
withdrawFeestringFlat fee in USD charged when withdrawing this collateral (decimal string)
tiersarrayArray of collateral tier configurations for tiered haircut structure

Tier Object Fields

FieldTypeDescription
idintegerUnique tier identifier
namestringTier name (e.g., "Tier1", "Tier2")
minAmountstringMinimum amount in USDT for this tier (decimal string)
maxAmountstringMaximum amount in USDT for this tier (decimal string, empty if unlimited)
valueRatiostringCollateral value ratio (e.g., "0.995" for 99.5% value)
haircutstringCollateral haircut percentage (e.g., "0.01" for 1% haircut)
valueAdditionstringFixed value addition in USDT (decimal string)

Error Response

{
  "status": "error",
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Could not retrieve collateral configuration",
    "details": {}
  },
  "requestId": "5ccf215d37e3ae6d"
}

Code Examples

Get All Collaterals

{
  "params": {
    "action": "getCollaterals"
  }
}

Collateral Information

  • No Authentication Required: Public endpoint accessible without signing
  • Supported Assets: Returns all collateral types supported by the platform
  • Tiered Haircuts: Larger collateral holdings may have larger haircuts applied
  • Auto-Exchange: Non-USDT collateral may be auto-exchanged when LLTV threshold is breached

Use Cases

  • Deposit Planning: Check deposit caps and supported assets before depositing
  • Withdrawal Validation: Verify withdrawal fees for each collateral type
  • Risk Assessment: Understand LTV/LLTV thresholds for non-USDT collateral
  • Collateral Valuation: Calculate effective collateral value using tier haircuts

Validation Rules

  • No authentication required
  • No rate limiting beyond standard API limits
  • Returns data for all configured collateral assets

Error Handling

Common error scenarios:

Error CodeDescriptionRetryable
UNAUTHORIZEDEIP-712 signature validation failedNo
VALIDATION_ERRORRequest validation failedNo
MISSING_REQUIRED_FIELDRequired field is missingNo
INVALID_FORMATField format is invalidNo
INVALID_VALUEInvalid parameter valueNo
RATE_LIMIT_EXCEEDEDToo many requests in time windowYes
INSUFFICIENT_MARGINNot enough margin for tradeNo
ORDER_NOT_FOUNDOrder does not existNo
OPERATION_TIMEOUTOperation timed outYes
ErrorDescription
Collateral configuration unavailableFailed to retrieve collateral data from configuration service
Internal errorService temporarily unavailable

Related Endpoints