---
title: "Get the YP protocol data"
method: GET
path: "/yp"
tags: ["Internal"]
---

# Get the YP protocol data

`GET /yp`

## Response `200`

The current YP protocol configuration

- YPDetails
  - `lastConnectTime` string
  - `name` string
  - `description` string
  - `streamTitle` string
  - `logo` string
  - `tags` string[]
  - `social` SocialHandle[]
    - `platform` string
    - `url` string
    - `icon` string
  - `viewerCount` integer
  - `overallMaxViewerCount` integer
  - `sessionMaxViewerCount` integer
  - `nsfw` boolean
  - `online` boolean

## Other responses

- `404` — Not found

## Changes

- **2024-07-02** `618b7ae59cc5` — 1 info
  - endpoint added
- **2021-09-23** `02fef72d775b` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/owncast/apis/owncast-apis/changes/yp/get.md)

---

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