Public APIs
This section provides details on accessing the public APIs published by our platform.
Pools List
This endpoint retrieves the details of various pools configured in the system. It provides essential information about each pool, including its status, investment parameters, and management addresses.
๐งพ Endpoint
Method:
GET
URL:
https://edgeapi.csigma.finance/api/v1/external/pools/list
๐ Authentication
No authentication is required for this endpoint.
๐ฅ Request
Method: GET
URL: https://edgeapi.csigma.finance/api/v1/external/pools/list
No parameters required.
๐ค Response
Structure:
success
(boolean): Indicates whether the request was successful.data.pools
(array)A list of pool objects.
Each pool object includes:
address
string
The address of the pool
name
string
The name of the pool
ticker
string
The ticker symbol LP Token
projectedApr
number
The projected annual percentage rate
apr
number
The current annual percentage rate
poolSize
number
The size of the pool
networkId
number
The identifier for the network
tokenAddress
string
The address of the associated token
poolManagerAddress
string
The address of the pool manager
fundManagerAddress
string
The address of the fund manager
stakingContractAddress
string
The address of the staking contract
v1Pools
array
Array of V1 pool objects (see below)
status
string
The current status of the pool
isPaused
boolean
Indicates if the pool is paused
minimumInvestment
string
The minimum investment required
description
string
A description of the pool
withdrawalManager
string
The address of the withdrawal manager
stakingAPY
number
The annual percentage yield for staking
createdAt
string
The creation date of the pool
Each v1Pools
The object contains:
id
string
The identifier of the investment pool
apr
number
The annual percentage rate
name
string
The name of the investment pool
allocation
number
The allocation percentage
maturityDate
string
The maturity date of the investment pool
creditQuality
string | null
The credit quality of the pool
minimumInvestment
string
The minimum investment amount
โ
Example Response
{
"success": true,
"data": {
"pools": [
{
"address": "0x123...",
"name": "USDC Yield Pool",
"ticker": "USDC",
"projectedApr": 8.5,
"apr": 7.2,
"poolSize": 5000000,
"networkId": 1,
"tokenAddress": "0xabc...",
"poolManagerAddress": "0xdef...",
"fundManagerAddress": "0xghi...",
"stakingContractAddress": "0xjkl...",
"v1Pools": [
{
"id": "v1-001",
"apr": 5.5,
"name": "USDC Pool v1",
"allocation": 60,
"maturityDate": "2025-12-31",
"creditQuality": "AAA",
"minimumInvestment": "1000"
}
],
"status": "active",
"isPaused": false,
"minimumInvestment": "1000",
"description": "High-quality yield pool backed by stable assets.",
"withdrawalManager": "0xmno...",
"stakingAPY": 9.1,
"createdAt": "2024-06-15T12:00:00Z"
}
]
}
}
Last updated