---
title: "Read live protocol analytics for the selected time frame, including TVL token breakdowns and trade counts."
method: GET
path: "/v1/analytics/overview"
tags: ["Analytics"]
---

# Read live protocol analytics for the selected time frame, including TVL token breakdowns and trade counts.

`GET /v1/analytics/overview`

## Request

- Base URL: `https://api.galaxyswap.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.galaxyswap.io/v1/analytics/overview`
- Auth: none declared
- TypeScript: <https://skmtc.dev/galaxyswap/apis/galaxyswap-backend-api/docs/v1/analytics/overview/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `timeFrame` '24H' | '7D' | '30D'

## Response `200`

Default Response

- object
  - `networkId` string, required
  - `contractAddress` string, required
  - `asOf` string, date-time, required
  - `timeFrame` '24H' | '7D' | '30D', required
  - `currentTvl` object, required
    - `byPoolType` object, required
      - `shielded` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `unshielded` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `mixed` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `stableUnshielded` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
    - `byPoolFamily` object, required
      - `shielded` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `unshielded` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `mixed` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `total` object, required
        - `poolCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
  - `estimatedTvl` object, required
    - `quoteTokenType` string, required
    - `current` object, required
      - `shielded` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
      - `unshielded` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
      - `mixed` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
      - `total` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
    - `buckets` object[], required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `total` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
      - `shielded` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
      - `unshielded` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
      - `mixed` object, required
        - `amount` string, required
        - `pricedPoolCount` integer, required
        - `totalPoolCount` integer, required
  - `estimatedVolume` object, required
    - `quoteTokenType` string, required
    - `selectedTimeFrame` object, required
      - `total` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `shielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `unshielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `mixed` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
    - `last24h` object, required
      - `total` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `shielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `unshielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `mixed` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
    - `cumulative` object, required
      - `total` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `shielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `unshielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `mixed` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
    - `buckets` object[], required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `total` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `shielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `unshielded` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
      - `mixed` object, required
        - `amount` string, required
        - `pricedTradeCount` integer, required
        - `totalTradeCount` integer, required
  - `tradeVolume` object, required
    - `selectedTimeFrame` object, required
      - `total` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `shielded` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `unshielded` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `mixed` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
    - `last24h` object, required
      - `total` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `shielded` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `unshielded` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `mixed` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
    - `cumulative` object, required
      - `total` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `shielded` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `unshielded` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
      - `mixed` object, required
        - `tradeCount` integer, required
        - `tokenTotals` object[], required
          - `tokenType` string, required
          - `amount` string, required
    - `lastTradeAt` string, date-time, nullable, required
    - `buckets` object[], required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `tradeCount` integer, required
      - `shieldedTradeCount` integer, required
      - `unshieldedTradeCount` integer, required
      - `mixedTradeCount` integer, required
  - `limitations` object[], required
    - `title` string, required
    - `reason` string, required

---

[API](https://skmtc.dev/galaxyswap/apis/galaxyswap-backend-api.md) - [All operations](https://skmtc.dev/galaxyswap/apis/galaxyswap-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/galaxyswap/apis/galaxyswap-backend-api/revisions/92312969b6ef?raw)