Lending Pools
Retrieve lending pool summaries across supported lending protocols.
Endpoint
GET /api/v1/partner/pool/lendingRequest Parameters
coin_types
string
No
Comma-separated list of coin type identifiers (e.g. 0x...::module::COIN). Maximum 20 values.
protocols
string
No
Comma-separated list of lending protocol identifiers (e.g. suilend,navi). Maximum 20 values. Supported values: suilend, navi, scallop, alphalend.
offset
int
No
Number of records to skip (default: 0).
limit
int
No
Number of records to return (default: 20).
sort_by
string
No
Sort field: deposit_usd, borrow_usd, deposit_apr, borrow_apr, utilization. Default: deposit_usd.
order
string
No
Sort order: ASC or DESC. Default: DESC.
Notes:
coin_typesandprotocolsaccept up to 20 comma-separated values.
Headers
x-api-key
No
API key for authorization.
cURL Example
Response
Fields
code
number
No
HTTP-like response code (200 = success).
message
string
No
Status message.
data
array
No
Array of lending pool summary objects.
Lending Pool Summary Object
protocol
string
Lending protocol identifier.
coin
object
Coin metadata object.
deposit
number
Total deposited amount (token units).
deposit_usd
number
Total deposited value in USD.
borrow
number
Total borrowed amount (token units).
borrow_usd
number
Total borrowed value in USD.
available
number
Amount available to deposit/borrow (token units).
available_usd
number
Amount available in USD.
deposit_apr
number
Deposit APR (percentage).
borrow_apr
number
Borrow APR (percentage).
utilization
number
Utilization rate (percentage).
price
number
Current price (USD).
borrow_rewards
array
Array of reward objects for borrowers.
deposit_rewards
array
Array of reward objects for depositors.
Coin Object
coin_type
string
Unique coin type identifier.
symbol
string
Token symbol.
decimals
number
Token decimals.
icon_url
string
Icon URL.
verified
boolean
Whether token is verified.
Reward Object
coin_type
string
Reward token type.
symbol
string
Reward token symbol.
decimals
number
Token decimals.
icon_url
string
Icon URL.
verified
boolean
Whether token is verified.
daily_amount
number
Reward amount distributed daily (token units).
daily_amount_usd
number
Daily reward value in USD.
apr
number
Reward APR (percentage).
Success Response Example
Validation and Limits
The API enforces the following limits:
coin_typesmaximum 20 values.protocolsmaximum 20 values.
See also: Environment Setup
Last updated