Skip to main content
GET
/
v1
/
wildcat
/
market
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.wildcat.wildcat_market(chain=models.V1WildcatMarketChain.ETHEREUM, market_address="0xC9499006a149C553d18171747ED19Aa7C6Dd19E2", block=None, user_address="0xD804b4b6FEC79015a32E2D560E588726eE414Fd4")

    # Handle response
    print(res)
{
  "market_address": "<string>",
  "name": "<string>",
  "symbol": "<string>",
  "decimals": 123,
  "available_to_lend": "<string>",
  "loaned": "<string>",
  "max_borrowing_capacity": "<string>",
  "gross_interest_accrued": "<string>",
  "minimum_deposit": "<string>",
  "minimum_reserve_ratio": "<string>",
  "base_lender_apr": "<string>",
  "protocol_fee_apr": "<string>",
  "effective_lender_apr": "<string>",
  "penalty_apr": "<string>",
  "maximum_grace_period": 123,
  "available_grace_period": 123,
  "withdrawal_cycle_duration": 123,
  "underlying_token": {
    "address": "<string>",
    "name": "<string>",
    "symbol": "<string>",
    "decimals": 123
  },
  "user_position": {
    "market_token_balance": "<string>",
    "underlying_token_balance": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

​
chain
enum<string>
default:ethereum
required
Available options:
ethereum
​
block
integer | null

Optional block number (defaults to latest).

​
market_address
string
default:0xC9499006a149C553d18171747ED19Aa7C6Dd19E2
required

The market address of the desired market data.

​
user_address
string | null
default:0xD804b4b6FEC79015a32E2D560E588726eE414Fd4

The user address of the desired market position. Only include if you would like the user position included in the response. Defaults to None.

Response

Successful Response

​
market_address
string
required

The address of the market.

​
name
string
required

Name of the vault.

​
symbol
string
required

Symbol of the vault.

​
decimals
integer
required

Number of decimals used for the vault's share precision.

​
available_to_lend
string
required

The borrower's remaining available credit.

​
loaned
string
required

The total value of all funds supplied by lenders, including interest.

​
max_borrowing_capacity
string
required

The maximum limit of funds that borrowers can access in the market.

​
gross_interest_accrued
string
required

The total gross interest generated by the loan before being split between lenders, reserves, and protocol fees.

​
minimum_deposit
string
required

The minimum amount of underlying asset required for a single deposit transaction.

​
minimum_reserve_ratio
string
required

A required percentage of market funds that must remain liquid and unavailable for borrowing.

​
base_lender_apr
string
required

The fixed annual percentage rate (excluding any protocol fees) that borrowers pay to lenders for assets within the market.

​
protocol_fee_apr
string
required

An additional APR that accrues to the protocol by slowly increasing required reserves. Derived by the fee configuration of the protocol as a percentage of the current base APR.

​
effective_lender_apr
string
required

The current interest rate being paid to lenders: the base APR plus penalty APR if applicable.

​
penalty_apr
string
required

An additional interest rate charged if the market remains delinquent—failing to maintain required reserves—after the grace period has elapsed.

​
maximum_grace_period
integer
required

The number of seconds borrowers have to resolve reserve deficiencies or correct delinquency in the market before penalties take effect.

​
available_grace_period
integer
required

The portion of the grace period left for borrowers to fix non-compliance issues, such as restoring reserves.

​
withdrawal_cycle_duration
integer
required

The number of seconds for which withdrawal requests are grouped and processed.

​
underlying_token
object
required

Underlying token (asset) used by the market.

​
user_position
object | null

The user's position in the vault.