---
title: "Get aggregated information about staking for specific user. Requires associated x-api-key."
method: GET
path: "/v1/partnership/staking/{master_address}/{address}"
tags: ["Partnership"]
---

# Get aggregated information about staking for specific user. Requires associated x-api-key.

`GET /v1/partnership/staking/{master_address}/{address}`

## Request

- Base URL: `https://backend.swap.coffee`
- URL: `https://backend.swap.coffee/v1/partnership/staking/{master_address}/{address}`
- Auth: one of:
  - none
  - API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/swap/apis/swap-coffee-api/docs/v1/partnership/staking/:master_address/:address/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `master_address` string, required
- `address` string, required

## Response `200`

Aggregated staking info

- ApiStakingUserInfo
  - `total_points` number, required
  - `locked_tokens` ApiStakingTokenInfo[], required
    - `token_address` string, required: Reward token address.
    - `asset_usd` number, double, required
    - `asset_raw` number, required
  - `paid_rewards` ApiStakingTokenInfo[], required
    - `token_address` string, required: Reward token address.
    - `asset_usd` number, double, required
    - `asset_raw` number, required
  - `positions` ApiStakingPositionInfo[], required
    - `id` integer, required
    - `locked_asset_address` string, required: Staked token
    - `locked_asset_amount_raw` number, required: Staked token amount in raw
    - `locked_native` number, required: Staked token volume converted to main staking token
    - `locked_usd` number, double, required
    - `start_lock_seconds_utc` integer, required
    - `end_lock_seconds_utc` integer, required
    - `points_amount` number, required
    - `period_id` integer, required
    - `available_periods` ApiStakingPositionPeriods[], required
      - `period_id` integer, required: Period id, to be passed into protocol.
      - `percentage` integer, required: How much additional points will be accrued.
      - `lock_duration` integer, required: How much wait till position unlock.
    - `earned_rewards` ApiStakingTokenInfo[], required
      - `token_address` string, required: Reward token address.
      - `asset_usd` number, double, required
      - `asset_raw` number, required

## Other responses

- `default`: Some error during request processing

---

[API](https://skmtc.dev/swap/apis/swap-coffee-api.md) - [All operations](https://skmtc.dev/swap/apis/swap-coffee-api/llms.txt) - [OpenAPI document](https://skmtc.dev/swap/apis/swap-coffee-api/revisions/88f42fef59b7?raw)
