---
title: "Get a yield"
method: GET
path: "/v0/yields/{accountingPositionId}"
tags: ["Yields"]
---

# Get a yield

`GET /v0/yields/{accountingPositionId}`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/yields/{accountingPositionId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/yields/:accountingPositionId/get.ts> (a function with typed inputs; its response is checked against the schema)

**Return a single daily yield by its identifier.**

The identifier is the `id` delivered in the `yield.credited` webhook payload.

## Path parameters

- `accountingPositionId` string, uuid, required: a Universally Unique Identifier

## Response `200`

Success

- object
  - `day` string, required: a day formatted as "yyyy-MM-dd"
  - `shareClassId` string, uuid, required: a Universally Unique Identifier
  - `investorId` string, uuid, required: a Universally Unique Identifier
  - `accountId` string, uuid, required: a Universally Unique Identifier
  - `yield` Amount, required
    - `value` string, required: a string representation of a decimal number e.g. "10000", "0.00" or "-7432092.04"
    - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
  - `navId` string, uuid, required: a Universally Unique Identifier
  - `navUpdateDate` string, required: A valid date within the range 2020-2100

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `404`: NotFound
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/ad85137fd00b?raw)