---
title: "Euro area balance of payments"
method: GET
path: "/api/v1/ecb/balance-of-payments"
tags: ["Central Banks & Monetary"]
---

# Euro area balance of payments

`GET /api/v1/ecb/balance-of-payments`

Euro area balance of payments (ECB BPS dataflow, IMF BOP 2.0). Wide rows per period in billions of EUR. report_type: main, summary, services, investment_income, direct_investment, portfolio_investment, other_investment, country (requires country). main and summary honour frequency; every other report is quarterly-only. Defaults to a bounded recent window when no period range is given.

## Query parameters

- `report_type` string — BoP report type.
- `country` string, nullable — Counterpart country (required for report_type=country).
- `frequency` string — monthly or quarterly (only main/summary honour it).
- `start_period` string, nullable — Start period (YYYY-MM or YYYY-Q#).
- `end_period` string, nullable — End period (YYYY-MM or YYYY-Q#).

## Response `200`

Balance of payments rows per period for the report type.

- EnvelopeStubData
  - `data` StubData, required — Response shape not yet documented; fields are returned as-is.
  - `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/a0c7dc18e21b/schema)