API docs by Redocly

Zarban API (2.0.0)

Download OpenAPI specification:

Zarban Support Team: [email protected] URL: https://zarban.io/

API for Zarban services.

Websocket

Operations related to websocket connections

Websocket Upgrade

Upgrade to websocket connection

Responses

Permit

Operations related to token permits

Get permit for single token

Get permit for single token

query Parameters
token
required
string0x[a-fA-F0-9]{40}

Ethereum address of the token

user
required
string0x[a-fA-F0-9]{40}

Ethereum address of the user

Responses

Response samples

Content type
application/json
{
  • "typedData": {
    },
  • "hash": "string"
}

Swap

Operations related to swap

Get a quote for a swap

Get a quote for a swap

Request Body schema: application/json
required
requestId
string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]...
type
string (OrderType)
Enum: "Classic" "DutchLimit"
tradeType
required
string (TradeType)
Enum: "ExactInput" "ExactOutput"
inputToken
required
string^(0x)?[0-9a-fA-F]{40}$
outputToken
required
string^(0x)?[0-9a-fA-F]{40}$
amount
string
recipient
string^(0x)?[0-9a-fA-F]{40}$
object (QuoteRequestOptions)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "type": "Classic",
  • "tradeType": "ExactInput",
  • "inputToken": "0x1234567890123456789012345678901234567890",
  • "outputToken": "0x1234567890123456789012345678901234567890",
  • "amount": "123.456789",
  • "recipient": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Classic",
  • "tradeType": "ExactInput",
  • "time": {
    },
  • "amount": {
    },
  • "quote": {
    },
  • "quoteId": "string",
  • "gasPrice": {
    },
  • "gasUseEstimate": 0,
  • "gasFeeEstimate": {
    },
  • "routeString": "A -- [0x0000000000000000000000000000000000000012] --> B -- [0x0000000000000000000000000000000000000023] --> C",
  • "methodParameters": {
    },
  • "route": [
    ],
  • "orderInfo": {
    },
  • "encodedOrder": "string",
  • "orderHash": "string",
  • "permitData": {
    }
}

Get steps for a swap

Request Body schema: application/json
required
requestId
string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]...
type
string (OrderType)
Enum: "Classic" "DutchLimit"
tradeType
required
string (TradeType)
Enum: "ExactInput" "ExactOutput"
inputToken
required
string^(0x)?[0-9a-fA-F]{40}$
outputToken
required
string^(0x)?[0-9a-fA-F]{40}$
amount
string
recipient
string^(0x)?[0-9a-fA-F]{40}$
object (QuoteRequestOptions)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "type": "Classic",
  • "tradeType": "ExactInput",
  • "inputToken": "0x1234567890123456789012345678901234567890",
  • "outputToken": "0x1234567890123456789012345678901234567890",
  • "amount": "123.456789",
  • "recipient": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "quote": {
    }
}

Orders

Operations related to orders

Updates Order Entity

updates an order entity in database

Request Body schema: application/json
required
orderHash
required
string^(0x)?[0-9a-fA-F]{64}$

Responses

Request samples

Content type
application/json
{
  • "orderHash": "string"
}

Response samples

Content type
application/json
{
  • "msg": "Bad request",
  • "reasons": [
    ]
}

Fetch Unfilled Orders

Get a list of unfilled orders filtered by different parameters.

query Parameters
type
string
Enum: "limit" "dutch"

Type of the order

hash
string^0x[0-9,a-z,A-Z]{64}$

order hash

status
string
Enum: "open" "expired" "error" "cancelled" "filled" "insufficient-funds"

Status of the order

offerer
string0x[a-fA-F0-9]{40}

Ethereum address of the offerer

filler
string0x[a-fA-F0-9]{40}

Ethereum address of the filler

object (TimeRange)

Decay start time

object (TimeRange)

Decay end time

object (TimeRange)

Order deadline

cursor
integer

Cursor for pagination

limit
integer
Default: 10

Limit the number of orders returned (default is 10)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Addresses

Operations related to Addresses

Get all addresses

All addresses knows to Zarban.

query Parameters
format
string

The type of addresses to return

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

LendingPool

Operations related to LendingPool

Deposit to lending pool

Deposit to lending pool

Request Body schema: application/json
required

Deposit transaction request, if amount is not provided, it will be calculated based on the token balance

user
required
string <address>

Ethereum address of the user

symbol
required
string
amount
string

The amount to deposit in native token units, if not provided, it will be calculated based on the token balance

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "symbol": "ETH",
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "response": {
    }
}

Withdraw from lending pool

Withdraw from lending pool

Request Body schema: application/json
required

Withdraw transaction request, if amount is not provided, it will be calculated based on the user account status

user
required
string <address>

Ethereum address of the user

symbol
required
string
amount
string

The amount to withdraw in native token units, if not provided, it will be calculated based on the deposit balance

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "symbol": "string",
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "response": {
    }
}

Borrow from lending pool

Borrow from lending pool

Request Body schema: application/json
required

Borrow transaction request, if amount is not provided, it will be calculated based on the token balance

user
required
string <address>

Ethereum address of the user

symbol
required
string
amount
string

The amount to borrow in native token units

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "symbol": "string",
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "response": {
    }
}

Repay to lending pool

Repay to lending pool

Request Body schema: application/json
required

Repay transaction request, if amount is not provided, it will repay the maximum possible amount

user
required
string <address>

Ethereum address of the user

symbol
required
string
amount
string

The amount to repay in native token units, if not provided, it will be calculated based on the borrow balance

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "symbol": "string",
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "response": {
    }
}

Enable/Disable asset as collateral

Allows to enable/disable a specific asset as collateral

Request Body schema: application/json
required

UseAssetAsCollateral transaction request

user
required
string <address>

Ethereum address of the user

symbol
required
string

Symbol of asset

enabled
required
boolean

Enable or disable the asset as collateral

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "symbol": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "response": {
    }
}

Fetch Reserve Data By Asset

Retrieve data of reserves

query Parameters
asset
string

The asset address in hexadecimal format.

Responses

Response samples

Content type
application/json
{
  • "id": "0x1234567890123456789012345678901234567890:0x1234567890123456789012345678901234567890",
  • "underlyingAsset": {
    },
  • "zTokenAddress": "0x1234567890123456789012345678901234567890",
  • "variableDebtTokenAddress": "0x1234567890123456789012345678901234567890",
  • "borrowingEnabled": true,
  • "isActive": true,
  • "isFrozen": false,
  • "usageAsCollateralEnabled": true,
  • "reserveFactor": "0.1",
  • "baseLTVasCollateral": "0.5",
  • "reserveLiquidationThreshold": "0.6",
  • "reserveLiquidationBonus": "0.1",
  • "utilizationRate": "0.5",
  • "totalDebt": {
    },
  • "totalLiquidity": {
    },
  • "availableLiquidity": {
    },
  • "supplyAPY": "0.1",
  • "supplyAPR": "0.1",
  • "variableBorrowAPY": "0.1",
  • "variableBorrowAPR": "0.1",
  • "price": {
    },
  • "borrowIncentives": {
    },
  • "depositIncentives": {
    }
}

Get user deposits of Lendingpool

Get user deposits of Lendingpool

query Parameters
user
string0x[a-fA-F0-9]{40}

Ethereum address of the user

reserve
string0x[a-fA-F0-9]{40}

Ethereum address of the reserve

cursor
integer

Cursor for pagination

limit
integer
Default: 50

Limit the number of deposits returned (default is 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get user borrows of lendingpool

Get user borrows of lendingpool

query Parameters
user
string0x[a-fA-F0-9]{40}

Ethereum address of the user

reserve
string0x[a-fA-F0-9]{40}

Ethereum address of the reserve

cursor
integer

Cursor for pagination

limit
integer
Default: 50

Limit the number of deposits returned (default is 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Collect lendingpool rewards

Collect lendingpool rewards

Request Body schema: application/json
required

Collect reward transaction request

user
required
string <address>

Ethereum address of the user

recipient
required
string <address>

Ethereum address of the recipient

assets
required
Array of strings <address> [ items <address > ]
amount
string

The amount to claim in native reward token units, if not provided, all rewards will be claimed

rewardToken
string <address>

Ethereum address of the reward token (if not provided, all reward tokens will be considered. In this case, do not provide amount)

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "recipient": "0x1234567890123456789012345678901234567890",
  • "assets": [
    ],
  • "amount": "10000000000000000000",
  • "rewardToken": "0x1234567890123456789012345678901234567890"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Uniswap

Operations related to Uniswap

Create Uniswap V3 position

Create Uniswap V3 position

Request Body schema: application/json
required

Create position transaction request

token0
required
string^(0x)?[0-9a-fA-F]{40}$

Ethereum address of the token0

token1
required
string^(0x)?[0-9a-fA-F]{40}$

Ethereum address of the token1

fee
required
integer <int64>

Pool fee

intent
required
string
Enum: "Preview" "Create"
priceLower
string <string>

Minimum price of one token0 in base of token1 (in token1 native token units)

priceUpper
string <string>

Maximum price of one token0 in base of token1 (in token1 native token units)

user
string <address>

Ethereum address of the user

amount0
string <string>

The amount of token0 in native token units

amount1
string <string>

The amount of token1 in native token units

Responses

Request samples

Content type
application/json
{
  • "token0": "0x1234567890123456789012345678901234567890",
  • "token1": "0x1234567890123456789012345678901234567890",
  • "fee": 500,
  • "intent": "Preview",
  • "priceLower": "1000000000000000000",
  • "priceUpper": "1000000000000000000",
  • "user": "0x1234567890123456789012345678901234567890",
  • "amount0": "10000000000000000000",
  • "amount1": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    },
  • "preview": {
    }
}

Collect Uniswap V3 position rewards

Collect Uniswap V3 position rewards

Request Body schema: application/json
required

Collect rewards transaction request

tokenId
required
string <string>

token id

user
required
string <address>

Ethereum address of the user

amount0Max
string <string>

The maximum amount of token0 rewards to be received in native token units

amount1Max
string <string>

The maximum amount of token1 rewards to be received in native token units

unwrap
boolean
Default: false

Whether to unwrap the ETH rewards or not

Responses

Request samples

Content type
application/json
{
  • "tokenId": "413245",
  • "user": "0x1234567890123456789012345678901234567890",
  • "amount0Max": "10000000000000000000",
  • "amount1Max": "10000000000000000000",
  • "unwrap": false
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Increase Uniswap V3 position liquidity

Increase Uniswap V3 position liquidity

Request Body schema: application/json
required

Increase liquidity transaction request

tokenId
required
string <string>

token id

user
required
string <address>

Ethereum address of the user

amount0
string <string>

The amount of token0 that user wants to deposit in native token units

amount1
string <string>

The amount of token1 that user wants to deposit in native token units

useNativeAsset
boolean
Default: false

Whether to use native asset or not (only for ETH)

Responses

Request samples

Content type
application/json
{
  • "tokenId": "413245",
  • "user": "0x1234567890123456789012345678901234567890",
  • "amount0": "10000000000000000000",
  • "amount1": "10000000000000000000",
  • "useNativeAsset": false
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Decrease Uniswap V3 position liquidity

Decrease Uniswap V3 position liquidity

Request Body schema: application/json
required

Decrease liquidity transaction request

tokenId
required
string <string>

token id

percentage
required
integer <int64>

The percentage of liquidity to be removed in bps (1/10000)

user
required
string <address>

Ethereum address of the user

unwrap
boolean
Default: false

Whether to unwrap or not (only for WETH)

burn
boolean
Default: false

Whether to burn position nft or not (only for when percentage is 10000)

Responses

Request samples

Content type
application/json
{
  • "tokenId": "413245",
  • "percentage": 1250,
  • "user": "0x1234567890123456789012345678901234567890",
  • "unwrap": false,
  • "burn": false
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Burn Uniswap V3 position nft

Burn Uniswap V3 position nft

Request Body schema: application/json
required

Burn position nft transaction request

tokenId
required
string <string>

token id

user
required
string <address>

Ethereum address of the user

Responses

Request samples

Content type
application/json
{
  • "tokenId": "413245",
  • "user": "0x1234567890123456789012345678901234567890"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Get the list of a user's uniswap v3 positions

Get the list of a user's uniswap v3 positions.

query Parameters
user
required
string0x[a-fA-F0-9]{40}

Ethereum address of the user

status
string
Enum: "InRange" "OutOfRange" "Closed"

The status of the position

Responses

Response samples

Content type
application/json
{
  • "positions": [
    ]
}

Get details of a specific uniswap v3 position

Get details of a specific uniswap v3 position.

path Parameters
tokenId
required
integer

The token id of the position

Responses

Response samples

Content type
application/json
{
  • "tokenId": "413245",
  • "token0": {
    },
  • "token1": {
    },
  • "fee": 500,
  • "tickLower": {
    },
  • "tickUpper": {
    },
  • "currentTick": {
    },
  • "liquidity": "4000",
  • "token0UncollectedFees": {
    },
  • "token1UncollectedFees": {
    },
  • "amount0": {
    },
  • "amount1": {
    },
  • "poolId": "0x1234567890123456789012345678901234567890",
  • "owner": "0x1234567890123456789012345678901234567890",
  • "status": "InRange",
  • "tokenURI": "string",
  • "staked": true,
  • "numberOfStakes": 0
}

Stake Uniswap V3 position nft

Stake Uniswap V3 position nft in UniswapV3Staker contract

Request Body schema: application/json
required

Stake UniswapV3 LP nft transaction request

tokenId
required
string <string>

token id

user
required
string <address>

Ethereum address of the user

required
Array of objects (UniswapV3StakerIncentiveKeyRequest)

Responses

Request samples

Content type
application/json
{
  • "tokenId": "413245",
  • "user": "0x1234567890123456789012345678901234567890",
  • "incentives": [
    ]
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Stake Uniswap V3 position nfts into a specific incentive

Stake Uniswap V3 position nfts into a specific incentive

Request Body schema: application/json
required

Stake UniswapV3 LP nft transaction request

tokenIds
required
Array of strings <string> [ items <string > ]
user
required
string <address>

Ethereum address of the user

required
object (UniswapV3StakerIncentiveKeyRequest)

Responses

Request samples

Content type
application/json
{
  • "tokenIds": [
    ],
  • "user": "0x1234567890123456789012345678901234567890",
  • "incentive": {
    }
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Unstake Uniswap V3 position nft

Unstake Uniswap V3 position nft in UniswapV3Staker contract

Request Body schema: application/json
required

Unstake UniswapV3 LP nft transaction request

tokenId
required
string <string>

token id

user
required
string <address>

Ethereum address of the user

required
Array of objects (UniswapV3StakerIncentiveKeyRequest)
withdraw
boolean
Default: false

Whether to withdraw nft or not

Responses

Request samples

Content type
application/json
{
  • "tokenId": "413245",
  • "user": "0x1234567890123456789012345678901234567890",
  • "incentives": [
    ],
  • "withdraw": false
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Unstake Uniswap V3 positions from a specific incentive

Unstake Uniswap V3 positions from a specific incentive

Request Body schema: application/json
required

Unstake UniswapV3 LP nft transaction request

tokenIds
Array of strings <string> [ items <string > ]
user
required
string <address>

Ethereum address of the user

required
object (UniswapV3StakerIncentiveKeyRequest)
collectReward
boolean
Default: false

Whether to collect reward or not

Responses

Request samples

Content type
application/json
{
  • "tokenIds": [
    ],
  • "user": "0x1234567890123456789012345678901234567890",
  • "incentive": {
    },
  • "collectReward": false
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Collect Uniswap V3 rewards from a specific incentive

Collect Uniswap V3 rewards from a specific incentive

Request Body schema: application/json
required

Collect UniswapV3 collect rewards from an incentive request

tokenIds
Array of strings <string> [ items <string > ]
user
required
string <address>

Ethereum address of the user

required
object (UniswapV3StakerIncentiveKeyRequest)

Responses

Request samples

Content type
application/json
{
  • "tokenIds": [
    ],
  • "user": "0x1234567890123456789012345678901234567890",
  • "incentive": {
    }
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Collect Uniswap V3 staking rewards

Collect Uniswap V3 staking rewards

Request Body schema: application/json
required

Collect staking rewards transaction request

user
required
string <address>

Ethereum address of the user

tokens
Array of strings <address> [ items <address >^(0x)?[0-9a-fA-F]{40}$ ]

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "tokens": [
    ]
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Get Uniswap V3 pool details

Get Uniswap V3 pool details by token0 and token1

query Parameters
token0
required
string0x[a-fA-F0-9]{40}

Ethereum address of the token0

token1
required
string0x[a-fA-F0-9]{40}

Ethereum address of the token1

fee
Array of integers
Items Enum: 100 500 3000 10000

Fee tiers

Responses

Response samples

Content type
application/json
{
  • "pools": [
    ]
}

Get Uniswap V3 ticks prices around a specific price

Get Uniswap V3 ticks prices around a specific price

query Parameters
token0
required
string0x[a-fA-F0-9]{40}

Ethereum address of the token0

token1
required
string0x[a-fA-F0-9]{40}

Ethereum address of the token1

fee
required
integer
Enum: 100 500 3000 10000

Fee tier

price
required
string
Example: price=1000000000000000000

Price of one unit of token0 in base of token1 (in token1 native token units)

Responses

Response samples

Content type
application/json
{
  • "previousTicks": [
    ],
  • "nextTicks": [
    ],
  • "currentTick": {
    }
}

Get active stakes in UniswapV3Staker

Get active stakes in UniswapV3Staker

path Parameters
address
required
string <address>
Example: 0x1234567890123456789012345678901234567890

Ethereum address of the account

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get all user active stakes by incentive id

Get all user active stakes by incentive id

query Parameters
user
required
string0x[a-fA-F0-9]{40}

Ethereum address of the user

incentiveId
string0x[a-fA-F0-9]{32}

incentive id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all available user poistions to stake in an incentive

Get all available user positions stake in an incentive

query Parameters
user
required
string0x[a-fA-F0-9]{40}

Ethereum address of the user

incentiveId
required
string0x[a-fA-F0-9]{32}

incentive id

Responses

Response samples

Content type
application/json
{
  • "positions": [
    ]
}

Get UniswapV3Staker incentives

Get UniswapV3Staker incentives

query Parameters
rewardTokens
Array of strings <address> [ items <address > ]
Example: rewardTokens=0x1234567890123456789012345678901234567890

Address of the reward token

status
string
Enum: "active" "inactive"

Status of incentives

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

StableCoinSystem

Operations related to Zarban Stable-Coin System

Create vault

Create vault

Request Body schema: application/json
required

Create vault transaction request

ilkName
required
string

The name of the ilk

user
required
string <address>

Ethereum address of the user

collateralAmount
string

The amount of collateral to deposit in native token units

mintAmount
required
string

The amount of stablecoin to mint in native token units

Responses

Request samples

Content type
application/json
{
  • "ilkName": "ETH-A",
  • "user": "0x1234567890123456789012345678901234567890",
  • "collateralAmount": "10000000000000000000",
  • "mintAmount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Deposit collateral

Deposit collateral

Request Body schema: application/json
required

Deposit collateral transaction request

user
required
string <address>

Ethereum address of the user

vaultId
required
integer

The ID of the vault

amount
string

The amount of collateral to deposit in native token units, if not provided, it will be calculated based on the wallet balance

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "vaultId": 1,
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Withdraw collateral

Withdraw collateral

Request Body schema: application/json
required

Withdraw collateral transaction request

user
required
string <address>

Ethereum address of the user

vaultId
required
integer

The ID of the vault

amount
string

The amount of collateral to withdraw in native token units, if not provided, it will be calculated based on the withdrawable balance

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "vaultId": 1,
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Mint ZAR

Mint ZAR

Request Body schema: application/json
required

Mint ZAR transaction request

user
required
string <address>

Ethereum address of the user

vaultId
required
integer

The ID of the vault

amount
string

The amount of stablecoin to mint in native token units, if not provided, it will be calculated based on the available to mint amount

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "vaultId": 1,
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Repay ZAR

Repay ZAR

Request Body schema: application/json
required

Repay ZAR transaction request

user
required
string <address>

Ethereum address of the user

vaultId
required
integer

The ID of the vault

amount
string

The amount of stablecoin to repay in native token units, if not provided, it will be calculated based on the borrow balance

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "vaultId": 1,
  • "amount": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

liquidate a vault

liquidate a vault

Request Body schema: application/json
required

Liquidate a Vault transaction request

user
required
string <address> 0x[a-fA-F0-9]{40}

Ethereum address of the user who is liquidating the vault and receiving incentives.

vaultId
required
integer

The ID of the vault

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "vaultId": 1
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Exit collateral Gem from Vat contract to user's wallet

Initiates a transaction to exit collateral (either an ERC20 token or ETH) from the Vat contract. This allows users to withdraw remaining collateral (after auctions or repayments) held in the vault's urn.

Request Body schema: application/json
required

exit Gem or ETH collateral from Vat contract transaction request

user
required
string <address> 0x[a-fA-F0-9]{40}

Ethereum address of the user who intends to exit Gem tokens or ETH from the Vat contract and receive them.

amount
string

The amount of Gem token or ETH to exit from the Vat contract.

vaultId
required
integer

The ID of the vault associated with the urn holding the Gem token or ETH.

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "amount": "10000000000000000000",
  • "vaultId": 1
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

reset a auction

reset a auction

Request Body schema: application/json
required

Reset a Auction transaction request

user
required
string <address> 0x[a-fA-F0-9]{40}

Ethereum address of the user resetting the auction and receiving incentives.

auctionId
required
integer

The ID of the auction

ilk
required
string

Name of the ILK

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "auctionId": 1,
  • "ilk": "ETHA"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

take a auction

take a auction

Request Body schema: application/json
required

Take a Auction transaction request

user
required
string <address> 0x[a-fA-F0-9]{40}

Ethereum address of the user taking the auction.

auctionId
required
integer

The ID of the auction

ilk
required
string

Name of the ILK

collateralAmountUpperLimit
required
string

upper limit on the amount of collateral to buy [wad]

maxAcceptablePrice
required
string

Maximum acceptable price (ZAR / collateral) [ray]

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "auctionId": 1,
  • "ilk": "ETHA",
  • "collateralAmountUpperLimit": "10000000000000000000",
  • "maxAcceptablePrice": "10000000000000000000"
}

Response samples

Content type
application/json
{
  • "stepNumber": 0,
  • "numberOfSteps": 0,
  • "steps": [
    ]
}

Get all Ilks

Retrieve a list of all available ilks.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Ilk by name

Retrieve an Ilk by providing its name.

path Parameters
name
required
string

Name of the ILK

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "symbol": "USD",
  • "minimumCollateralizationRatio": "string",
  • "maximumLoanToValue": "string",
  • "liquidationPenalty": "string",
  • "debtCeiling": {
    },
  • "debt": {
    },
  • "annualStabilityFee": "string",
  • "dustLimit": {
    },
  • "price": {
    },
  • "nextPrice": {
    },
  • "join": "string",
  • "median": "string",
  • "gem": "string",
  • "clipper": "string",
  • "pip": "string",
  • "hole": {
    },
  • "dirt": {
    },
  • "availableToBorrow": {
    },
  • "duty": "string"
}

Get collector data

Get collector data

Responses

Response samples

Content type
application/json
{
  • "stablecoinSystem": {
    },
  • "lendingpool": {
    }
}

Get a vault by ID

path Parameters
id
required
integer

Vault ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "owner": "0x1234567890123456789012345678901234567890",
  • "urn": "0x1234567890123456789012345678901234567890",
  • "liquidationPrice": {
    },
  • "collateralLocked": {
    },
  • "collateralizationRatio": "1.5",
  • "loanToValue": "0.5",
  • "debt": {
    },
  • "availableToWithdraw": {
    },
  • "availableToMint": {
    },
  • "ilk": {
    },
  • "liquidated": false,
  • "tokenBalance": {
    }
}

Get vault events by ID

path Parameters
id
required
integer

Vault ID

query Parameters
type
string
Enum: "repay" "deposit" "withdraw" "mint"

Event type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get vaults by owner query

query Parameters
owner
string

Ethereum address of the owner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Ilks

Operations related to Ilks

Get all Ilks

Retrieve a list of all available ilks.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get Ilk by name

Retrieve an Ilk by providing its name.

path Parameters
name
required
string

Name of the ILK

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "symbol": "USD",
  • "minimumCollateralizationRatio": "string",
  • "maximumLoanToValue": "string",
  • "liquidationPenalty": "string",
  • "debtCeiling": {
    },
  • "debt": {
    },
  • "annualStabilityFee": "string",
  • "dustLimit": {
    },
  • "price": {
    },
  • "nextPrice": {
    },
  • "join": "string",
  • "median": "string",
  • "gem": "string",
  • "clipper": "string",
  • "pip": "string",
  • "hole": {
    },
  • "dirt": {
    },
  • "availableToBorrow": {
    },
  • "duty": "string"
}

Collector

Operations related to Collector

Get collector data

Get collector data

Responses

Response samples

Content type
application/json
{
  • "stablecoinSystem": {
    },
  • "lendingpool": {
    }
}

Deposits

Operations related to Deposits of LendingPool

Get user deposits of Lendingpool

Get user deposits of Lendingpool

query Parameters
user
string0x[a-fA-F0-9]{40}

Ethereum address of the user

reserve
string0x[a-fA-F0-9]{40}

Ethereum address of the reserve

cursor
integer

Cursor for pagination

limit
integer
Default: 50

Limit the number of deposits returned (default is 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Borrows

Operations related to Borrows of LendingPool

Get user borrows of lendingpool

Get user borrows of lendingpool

query Parameters
user
string0x[a-fA-F0-9]{40}

Ethereum address of the user

reserve
string0x[a-fA-F0-9]{40}

Ethereum address of the reserve

cursor
integer

Cursor for pagination

limit
integer
Default: 50

Limit the number of deposits returned (default is 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Logs

Operations related to Logs

Get raw and decoded logs by transaction hash

Get raw and decoded logs by transaction hash

path Parameters
txHash
required
string0x[a-fA-F0-9]{64}

Transaction hash

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Prices

Operations related to Prices

List prices based on query parameters

Retrieve a list of price details based on specified query parameters

query Parameters
symbol
string

Symbol of the price

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Vaults

Operations related to Vaults

Get a vault by ID

path Parameters
id
required
integer

Vault ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "owner": "0x1234567890123456789012345678901234567890",
  • "urn": "0x1234567890123456789012345678901234567890",
  • "liquidationPrice": {
    },
  • "collateralLocked": {
    },
  • "collateralizationRatio": "1.5",
  • "loanToValue": "0.5",
  • "debt": {
    },
  • "availableToWithdraw": {
    },
  • "availableToMint": {
    },
  • "ilk": {
    },
  • "liquidated": false,
  • "tokenBalance": {
    }
}

Get vault events by ID

path Parameters
id
required
integer

Vault ID

query Parameters
type
string
Enum: "repay" "deposit" "withdraw" "mint"

Event type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get vaults by owner query

query Parameters
owner
string

Ethereum address of the owner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Accounts

Operations related to Accounts

Get account by address

Get account by address

path Parameters
address
required
string <address>
Example: 0x1234567890123456789012345678901234567890

Ethereum address of the account

Responses

Response samples

Content type
application/json
{
  • "points": 100,
  • "address": "0x1234567890123456789012345678901234567890",
  • "walletBalance": {
    },
  • "netWorth": {
    },
  • "totalDebt": {
    },
  • "totalDeposits": {
    },
  • "lendingpoolSummary": {
    },
  • "stabelcoinSystemSummary": {
    },
  • "stakingSummary": {
    }
}

Points

Operations related to Points

Get scoreboard

Get scoreboard

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Staking

Operations related to Staking

Stake to staking contract

Stake to staking contract

Request Body schema: application/json
required

Stake transaction request, if amount is not provided, then the whole wallet balance will be used

user
required
string <address>

Ethereum address of the user

contractAddress
required
string <address>

Ethereum address of the staking contract

amount
string

The amount of asset to stake in native token units

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "contractAddress": "0x1234567890123456789012345678901234567890",
  • "amount": "1000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    }
}

Withdraw staked asset

Withdraw staked asset

Request Body schema: application/json
required

Withdraw transaction request, if amount is not provided, then the whole staked amount will be withdrawn

user
required
string <address>

Ethereum address of the user

contractAddress
required
string <address>

Ethereum address of the staking contract

amount
string

The amount of asset to withdraw in native token units

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "contractAddress": "0x1234567890123456789012345678901234567890",
  • "amount": "1000000000000000000"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    }
}

Collect staking reward

Collect staking reward

Request Body schema: application/json
required

Collect reward transaction request

user
required
string <address>

Ethereum address of the user

contractAddress
required
string <address>

Ethereum address of the staking contract

Responses

Request samples

Content type
application/json
{
  • "user": "0x1234567890123456789012345678901234567890",
  • "contractAddress": "0x1234567890123456789012345678901234567890"
}

Response samples

Content type
application/json
{
  • "chainActivity": {
    }
}

Get user staking stats

Get user staking stats

query Parameters
user
string0x[a-fA-F0-9]{40}

Ethereum address of the user

address
string0x[a-fA-F0-9]{40}

Ethereum address of the staking contract

active
boolean

Filter by active stakes

cursor
integer

Cursor for pagination

limit
integer
Default: 50

Limit the number of stakes returned (default is 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get staking plans

Get staking plans

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}