---
title: "shields.io endpoint payload"
method: GET
path: "/api/badge"
tags: ["badges"]
---

# shields.io endpoint payload

`GET /api/badge`

## Request

- Base URL: `https://yield.trdefi.com`
- URL: `https://yield.trdefi.com/api/badge`
- Auth: none required

Returns the shields.io `endpoint` schema so a repository README can show a live metric. Consumed as `https://img.shields.io/endpoint?url=<encoded /api/badge?metric=...>`.

## Query parameters

- `metric` 'volume30' | 'volume7' | 'volume1' | 'strategies' | 'makers' | 'pairs' | 'chains'

## Response `200`

Badge payload

- Badge
  - `schemaVersion` 1, required
  - `label` string, required
  - `message` string, required
  - `color` string
  - `cacheSeconds` integer
  - `isError` boolean

---

[API](https://skmtc.dev/trdefi/apis/trdefi-liquidity-api.md) · [All operations](https://skmtc.dev/trdefi/apis/trdefi-liquidity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trdefi/apis/trdefi-liquidity-api/revisions/0175596aa1cb?raw)