> For the complete documentation index, see [llms.txt](https://noodles-finance.gitbook.io/docs.noodles.fi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://noodles-finance.gitbook.io/docs.noodles.fi/lending/lending-pool.md). # Lending Pools Retrieve lending pool summaries across supported lending protocols. *** ## Endpoint ``` GET /api/v1/partner/pool/lending ``` ## Request Parameters | Name | Type | Required | Description | | ------------ | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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_types` and `protocols` accept up to 20 comma-separated values. *** ## Headers | Header | Required | Description | | ----------- | -------- | -------------------------- | | `x-api-key` | No | API key for authorization. | *** ## cURL Example ```bash curl --location 'https://api.noodles.fi/api/v1/partner/pool/lending?coin_types=0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf%3A%3Aspring_sui%3A%3ASPRING_SUI%2C0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7%3A%3Ausdc%3A%3AUSDC&protocols=suilend&offset=0&limit=20&sort_by=deposit_usd&order=DESC' \ --header 'Accept: application/json' \ --header 'x-api-key: YOUR_API_KEY' ``` *** ## Response ### Fields | Field | Type | Nullable | Description | | --------- | ------ | -------- | ---------------------------------------- | | `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 | Field | Type | Description | | ----------------- | ------ | ------------------------------------------------- | | `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 | Field | Type | Description | | ----------- | ------- | ---------------------------- | | `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 | Field | Type | Description | | ------------------ | ------- | ---------------------------------------------- | | `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 ```json { "code": 200, "message": "OK", "data": [ { "protocol": "suilend", "coin": { "coin_type": "0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI", "symbol": "sSUI", "decimals": 9, "icon_url": "https://statics.noodles.fi/logo/7912714130489027328.png", "verified": true }, "deposit": 80562549.78233854, "deposit_usd": 117346327, "borrow": 0, "borrow_usd": 0, "available": 80562549.78233854, "available_usd": 117346327, "deposit_apr": 0, "borrow_apr": 0, "utilization": 0, "price": 1.421, "borrow_rewards": [], "deposit_rewards": [ { "coin_type": "0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI", "symbol": "sSUI", "decimals": 9, "icon_url": "https://statics.noodles.fi/logo/7912714130489027328.png", "verified": true, "daily_amount": 3951.454344285, "daily_amount_usd": 5756, "apr": 1.79 } ] }, { "protocol": "suilend", "coin": { "coin_type": "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC", "symbol": "USDC", "decimals": 6, "icon_url": "https://statics.noodles.fi/logo/723505508589032917.png", "verified": true }, "deposit": 43673859.038171, "deposit_usd": 43692907, "borrow": 37165455.834941, "borrow_usd": 37181665, "available": 6508403.20323, "available_usd": 6511242, "deposit_apr": 4.59, "borrow_apr": 6.75, "utilization": 85.1, "price": 1, "borrow_rewards": [ { "coin_type": "0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI", "symbol": "sSUI", "decimals": 9, "icon_url": "https://statics.noodles.fi/logo/7912714130489027328.png", "verified": true, "daily_amount": 1164.698629285, "daily_amount_usd": 1696, "apr": 1.66 } ], "deposit_rewards": [ { "coin_type": "0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI", "symbol": "sSUI", "decimals": 9, "icon_url": "https://statics.noodles.fi/logo/7912714130489027328.png", "verified": true, "daily_amount": 499.196400928, "daily_amount_usd": 727.12, "apr": 0.61 } ] } ] } ``` *** ## Validation and Limits The API enforces the following limits: * `coin_types` maximum 20 values. * `protocols` maximum 20 values. *** > **See also:** [Environment Setup](/docs.noodles.fi/environment-setup/environment.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://noodles-finance.gitbook.io/docs.noodles.fi/lending/lending-pool.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.