Get Margin Pools
Retrieve metadata for all available DeepBook Margin pools. This endpoint returns essential information about each margin pool including asset type, interest rate parameters, supply caps, and utilization settings.
Endpoint
GET /deepbook-margin/pools
Use Cases
- Pool Discovery — List all available margin pools for a lending interface
- Interest Rate Display — Fetch interest rate parameters to show current rates
- Configuration Lookup — Get pool parameters for client-side validation
- Market Overview — Display all active margin pools with their configurations
Parameters
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
assetType | string | No | Filter by asset type (e.g., 0x2::sui::SUI) |
deepbookPoolId | string | No | Filter by DeepBook pool ID |
api-key | string | Yes | Your Surflux API key for authentication |
Response
Returns an array of margin pool objects. Each pool contains:
| Field | Type | Description |
|---|---|---|
margin_pool_id | string | Unique identifier for the margin pool on-chain |
maintainer_cap_id | string | Maintainer capability ID for pool administration |
asset_type | string | Full type identifier of the pool's asset |
supply_cap | number | Maximum amount that can be supplied to the pool |
max_utilization_rate | number | Upper bound on utilization (e.g., 80%) |
protocol_spread | number | Percentage of interest that goes to protocol fees |
min_borrow | number | Minimum loan size to prevent spam |
rate_limit_capacity | number | Rate limiting capacity |
rate_limit_refill_rate_per_ms | number | Rate limit refill rate per millisecond |
rate_limit_enabled | boolean | Whether rate limiting is enabled |
base_rate | number | Base interest rate |
base_slope | number | Interest rate slope below optimal utilization |
optimal_utilization | number | Target utilization rate (kink point) |
excess_slope | number | Interest rate slope above optimal utilization |
deepbook_pool_ids | string[] | Associated DeepBook pool IDs |
pool_cap_id | string | null | Pool capability ID |
extra_fields | object | null | Additional pool metadata |
digest | string | Transaction digest of last update |
updated_checkpoint_id | number | null | Checkpoint of last update |
created_at | string | ISO timestamp of pool creation |
updated_at | string | ISO timestamp of last update |