Limits

Get the global limits.

get

/limits

Responses

200

Limits retrieved successfully

application/json

Represents the current sBTC limits.

availableToWithdrawinteger · int64 · nullableOptional

Total amount sBTC still available for withdrawals in current window. All withdrawals except rejected counted here

pegCapinteger · int64 · nullableOptional

Represents the total cap for all pegged-in BTC/sBTC.

perDepositCapinteger · int64 · nullableOptional

Per deposit cap. If none then there is no cap.

perDepositMinimuminteger · int64 · nullableOptional

Per deposit minimum. If none then there is no minimum.

perWithdrawalCapinteger · int64 · nullableOptional

Per withdrawal cap. If none then there is no cap.

rollingWithdrawalBlocksinteger · int64 · nullableOptional

Number of blocks that define the rolling withdrawal window.

rollingWithdrawalCapinteger · int64 · nullableOptional

Maximum total sBTC that can be withdrawn within the rolling withdrawal window.

throttleModeInitiatorstring · nullableOptional

Name of key which triggered throttle mode (if throttle mode is active)

405

Method not allowed

application/json

500

Internal server error

application/json

get/limits

GET /limits HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "accountCaps": {
    "ANY_ADDITIONAL_PROPERTY": {
      "pegCap": 1,
      "perDepositCap": 1,
      "perDepositMinimum": 1,
      "perWithdrawalCap": 1,
      "rollingWithdrawalBlocks": 1,
      "rollingWithdrawalCap": 1,
      "throttleModeInitiator": "text"
    }
  },
  "availableToWithdraw": 1,
  "pegCap": 1,
  "perDepositCap": 1,
  "perDepositMinimum": 1,
  "perWithdrawalCap": 1,
  "rollingWithdrawalBlocks": 1,
  "rollingWithdrawalCap": 1,
  "throttleModeInitiator": "text"
}

Get limits for account handler.

get

/limits/{account}

Path parameters

accountstringRequired

The account for which to get the limits.

Responses

201

Account limits retrieved successfully

application/json

The representation of a limit for a specific account.

pegCapinteger · int64 · nullableOptional

Represents the current sBTC limits.

perDepositCapinteger · int64 · nullableOptional

Per deposit cap. If none then the cap is the same as the global per deposit cap.

perDepositMinimuminteger · int64 · nullableOptional

Per deposit minimum. If none then there is no minimum.

perWithdrawalCapinteger · int64 · nullableOptional

Per withdrawal cap. If none then the cap is the same as the global per withdrawal cap.

rollingWithdrawalBlocksinteger · int64 · nullableOptional

Number of blocks that define the rolling withdrawal window.

rollingWithdrawalCapinteger · int64 · nullableOptional

Maximum total sBTC that can be withdrawn within the rolling withdrawal window.

throttleModeInitiatorstring · nullableOptional

Throttle key initiated throttle

400

Invalid request body

application/json

404

Address not found

application/json

405

Method not allowed

application/json

500

Internal server error

application/json

get/limits/{account}

GET /limits/{account} HTTP/1.1
Host: localhost:3031
Accept: */*

{
  "pegCap": 1,
  "perDepositCap": 1,
  "perDepositMinimum": 1,
  "perWithdrawalCap": 1,
  "rollingWithdrawalBlocks": 1,
  "rollingWithdrawalCap": 1,
  "throttleModeInitiator": "text"
}