---
title: "Balance of payments summary"
method: GET
path: "/api/v1/snb/bop"
tags: ["Central Banks & Monetary"]
---

# Balance of payments summary

`GET /api/v1/snb/bop`

Swiss balance of payments summary. Cube ID is best-guess (`zabopue`) and may return 502 until verified. For production use call `/api/v1/snb/cube/{cubeId}` with a confirmed BOP cube ID.

## Response `200`

Balance of payments observations, or 502 if the cube is not available.

- EnvelopeSnbBopResult
  - `data` SnbBopResult, required — Balance of payments summary (best-effort).
    - `cube_id` string, nullable — SNB cube identifier.
    - `latest_date` string, nullable — Newest observation date across all series in the cube.
    - `timeseries` SnbTimeseries[], nullable — Array of cube slices, one per dimension combination.
      - `header` SnbHeaderItem[], nullable — List of dimension-item pairs identifying this slice.
        - `dim` string, nullable — Dimension name (e.g. 'Currency', 'Overview').
        - `dimItem` string, nullable — Dimension item label identifying this slice of the cube.
      - `metadata` SnbMetadata
        - `key` string, nullable — SNB internal series key (e.g. 'EPB@SNB.devkum{M0,EUR1}').
        - `frequency` string, nullable — ISO 8601 duration code: P1D_L daily, P1M monthly, P1Q quarterly, P1Y annual.
        - `scale` string, nullable — Scale factor exponent (empty string means unscaled).
        - `unit` string, nullable — Unit of measure when supplied by the source (e.g. 'CHF').
      - `values` SnbObservation[], nullable — Chronological observations, oldest first.
        - `date` string, nullable — Observation date - 'YYYY-MM-DD' for daily cubes, 'YYYY-MM' for monthly cubes, 'YYYY' for annual cubes.
        - `value` union — Numeric observation value, or null when suppressed.
          - integer
          - number
  - `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.
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

## Changes

- **2026-08-28** `560e8847c7b3` — 6 breaking
  - the response property `data/cube_id` became optional for the status `200`
  - the response property `data/latest_date` became optional for the status `200`
  - the response property `data/timeseries` became optional for the status `200`
  - response property `data/cube_id` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …2 more
- **2026-08-08** `4c4530760ba1` — 12 info
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `429` status
  - added the optional property `code` to the response with the `503` status
  - added the optional property `hint` to the response with the `401` status
  - …8 more

[Change history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/snb/bop/get.md)

---

[API](https://skmtc.dev/sugra/apis/sugra-api.md) · [All operations](https://skmtc.dev/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sugra/sugra-api/revisions/87582f2e0110/schema)