---
title: "SOMA balance-sheet flows (week-over-week)"
method: GET
path: "/api/v1/fed/soma/flows"
tags: ["Central Banks & Monetary"]
---

# SOMA balance-sheet flows (week-over-week)

`GET /api/v1/fed/soma/flows`

Week-over-week change in the Fed's SOMA holdings by asset class - the QT (runoff) / QE (purchase) pace. Derived from consecutive weekly snapshots; negative total_change = balance sheet shrinking. The flow companion to /soma/history (levels).

## Query parameters

- `weeks` integer — Number of weekly flow periods (13 = ~1 quarter)

## Response `200`

Weekly SOMA balance-sheet changes by asset class.

- EnvelopeFedSomaFlowsData
  - `data` FedSomaFlowsData, required — Fed SOMA balance-sheet flows - week-over-week change by asset class (QT/QE pace).
    - `unit` string, required — Currency unit of all values (USD).
    - `weeks_available` integer, required — Total weekly snapshots available upstream.
    - `count` integer, required — Number of weekly flow records returned.
    - `attribution` string, required — FRBNY Terms of Use attribution string.
    - `caveats` string[] — Data-quality caveats.
    - `records` FedSomaFlowsRecord[], required
      - `date` string, required — As-of date of this snapshot (weekly, Wednesday).
      - `prior_date` string, nullable — As-of date of the prior snapshot.
      - `total` number, nullable — Total SOMA holdings level at date, $USD.
      - `total_change` number, nullable — Week-over-week change in total holdings, $USD (negative = QT runoff).
      - `changes` FedSomaFlowChanges, required — Week-over-week change per asset class, $USD (par/face). None if a class is absent on either side.
        - `bills` number, nullable
        - `notes_bonds` number, nullable
        - `tips` number, nullable
        - `frn` number, nullable
        - `tips_inflation_compensation` number, nullable
        - `mbs` number, nullable
        - `cmbs` number, nullable
        - `agencies` number, nullable
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/d3e3d9c28132/schema)