API docs by Redocly

Zarban API (2.0.0)

Download OpenAPI specification:Download

API for Zarban services.

Permit

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

Get a quote for a swap

Get a quote for a swap

Request Body schema: application/json
required
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
required
string
recipient
required
string^(0x)?[0-9a-fA-F]{40}$
object (QuoteRequestOptions)

Responses

Request samples

Content type
application/json
{
  • "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": [
    ]
}

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
[
  • {
    }
]

LendingPool

Get lending pool overview

Get lending pool overview

Responses

Response samples

Content type
application/json
{
  • "totalMarketSize": {
    },
  • "totalAvailable": {
    },
  • "totalBorrows": {
    }
}

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": {
    }
}

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
[
  • {
    }
]

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
[
  • {
    }
]

Ilks

Get all Ilks

Retrieve a list of all available ilks.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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": {
    }
}

StableCoinSystem

Get all Ilks

Retrieve a list of all available ilks.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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": {
    }
}

Retrieves proxies owned by a specific owner

Returns a list of proxies filtered by the owner's address.

query Parameters
owner
required
string <string>

The Ethereum address of the owner.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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": {
    }
}

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
[
  • {
    }
]

Get vaults by owner query

query Parameters
owner
string

Ethereum address of the owner

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get authorization matrix

Responses

Response samples

Content type
application/json
{
  • "wheres": [
    ],
  • "whos": [
    ],
  • "values": [
    ]
}

Proxies

Retrieves proxies owned by a specific owner

Returns a list of proxies filtered by the owner's address.

query Parameters
owner
required
string <string>

The Ethereum address of the owner.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Collector

Get collector data

Get collector data

Responses

Response samples

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

Deposits

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
[
  • {
    }
]

Borrows

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
[
  • {
    }
]

Events

Ordered list events based on query parameters

Retrieve a list of events based on specified query parameters

query Parameters
id
integer

ID of the event

domain
required
string (EventDomain)
Enum: "stableCoinSystem" "lendingpool" "chainlink" "uniswapV3"
Example: domain=stableCoinSystem

The domain of the event.

type
required
string (EventType)
Enum: "executive" "oracle" "user"
Example: type=executive

Type of the event

name
required
string (EventName)
Enum: "VaultsRepay" "VaultsWithdraw" "VaultsDeposit" "VaultsMint" "VaultsKick" "VaultsTake" "VaultsRedo" "VaultsYank" "LendingpoolWithdraw" "LendingpoolRepay" "LendingpoolLiquidationCall" "LendingpoolBorrow" "File" "Permission" "Median" "Unknown"
Example: name=VaultRepay
cursor
integer

Cursor for pagination

limit
integer

Maximum number of records to retrieve. Defaults to 50 if not provided.

order
string
Enum: "asc" "desc"
Example: order=desc

Order of the events. Default is desc.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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
[
  • {
    }
]

Get price history for a symbol

Get price history for a symbol

path Parameters
symbol
required
string

Symbol of the price

query Parameters
from
string <date-time>

Start date

to
string <date-time>

End date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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": {
    }
}

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
[
  • {
    }
]

Get vaults by owner query

query Parameters
owner
string

Ethereum address of the owner

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Permissions

Get authorization matrix

Responses

Response samples

Content type
application/json
{
  • "wheres": [
    ],
  • "whos": [
    ],
  • "values": [
    ]
}

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
{
  • "address": "0x1234567890123456789012345678901234567890",
  • "walletBalance": {
    },
  • "netWorth": {
    },
  • "totalDebt": {
    },
  • "totalDeposits": {
    },
  • "lendingpoolSummary": {
    },
  • "stabelcoinSystemSummary": {
    }
}