---
title: "Staking Pools List"
method: GET
path: "/api/{portalId}/staking-pools"
tags: ["Staking"]
---

# Staking Pools List

`GET /api/{portalId}/staking-pools`

## Request

- Base URL: `https://portal-api.magna.so`
- URL: `https://portal-api.magna.so/api/{portalId}/staking-pools`
- Auth: none declared

Returns a list of staking pools

## Path parameters

- `portalId` string, uuid, required

## Response `200`

200

- object
  - `stakingPools` object[], required
    - `id` string, uuid, required: unique staking pool id
    - `name` string, required: name of the staking pool
    - `description` string, nullable, required: description of the staking pool
    - `tokenId` string, uuid, required: token id associated with the staking pool
    - `contractId` string, uuid, required: contract id associated with the staking pool
    - `status` string, required: current status of the staking pool
    - `totalStaked` string, required: total amount staked in the pool
    - `totalRewardsDeposited` string, required: total rewards deposited in the pool
    - `periodFinish` string, date-time, nullable, required: end date of the staking period
    - `minimumStakeAmount` string, required: minimum amount required to stake
    - `minimumStakeLength` object, required: minimum duration for staking
      - `value` integer, required: value
      - `period` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required: period
    - `maxApy` string, required: maximum APY
    - `averageApy` string, required: average APY
    - `stakeWithdrawalDelay` object, required: delay before stake can be withdrawn
      - `value` integer, required: value
      - `period` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required: period
    - `rewardWithdrawalDelay` object, required: delay before rewards can be withdrawn
      - `value` integer, required: value
      - `period` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required: period
    - `createdAt` string, date-time, required: creation timestamp
    - `updatedAt` string, date-time, required: last update timestamp
    - `contract` object, nullable, required
      - `id` string, uuid, required
      - `version` string, required
      - `address` string, required

## Other responses

- `400`: Client Error
- `500`: Server Error
- `502`: Upstream Error — the portal configuration service could not be reached. Safe to retry.

---

[API](https://skmtc.dev/magna/apis/magna-portal-api.md) - [All operations](https://skmtc.dev/magna/apis/magna-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/magna/apis/magna-portal-api/revisions/50f736d73198?raw)