Honeycluster Docs – Get rolling market state for a token

tokens

Get rolling market state for a token

get

/token/{tokenSlug}/metrics

operationId: token-getMetrics

Returns the fast-changing half of the token detail view: identity (currency, issuer, id, slug) plus the full metrics object — price, market_cap, fdv, supply, tvl, vesting, rolling price-change / volume / txn windows (5m / 1h / 6h / 24h / 7d), takers, buy/sell split, quality_score. Returns null when no token matches the supplied tokenSlug. Use the sibling /token/{tokenSlug}/meta endpoint for slow-changing curated metadata.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Path Parameters

Name	Type	Default	Description
`tokenSlug` required	string		Natural token identifier in `currency.issuer` form. Example: `USD.rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B`.

Responses

200

application/json

Successful response

Example

Json

{
  "currency": "string",
  "issuer": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "slug": "string",
  "metrics": {
    "trustlines": 0,
    "holders": 0,
    "supply": "string",
    "circulating_supply": "string",
    "price": "string",
    "market_cap": "string",
    "fdv": "string",
    "tvl": "string",
    "vesting": {
      "total": "string",
      "next_7d": "string",
      "next_30d": "string"
    },
    "price_change": {
      "last_5m": {
        "absolute": "string",
        "percent": "string"
      },
      "last_1h": {
        "absolute": "string",
        "percent": "string"
      },
      "last_6h": {
        "absolute": "string",
        "percent": "string"
      },
      "last_24h": {
        "absolute": "string",
        "percent": "string",
        "since_inception": false
      },
      "last_7d": {
        "absolute": "string",
        "percent": "string",
        "since_inception": false
      }
    },
    "volume": {
      "last_5m": {
        "value": "string",
        "change_absolute": "string",
        "change_percent": "string"
      },
      "last_1h": {
        "value": "string",
        "change_absolute": "string",
        "change_percent": "string"
      },
      "last_6h": {
        "value": "string",
        "change_absolute": "string",
        "change_percent": "string"
      },
      "last_24h": {
        "value": "string",
        "change_absolute": "string",
        "change_percent": "string"
      },
      "last_7d": "string",
      "total": "string",
      "dominance": {
        "last_24h": "string"
      }
    },
    "txn": {
      "last_5m": {
        "value": 0,
        "change_absolute": 0,
        "change_percent": "string"
      },
      "last_1h": {
        "value": 0,
        "change_absolute": 0,
        "change_percent": "string"
      },
      "last_6h": {
        "value": 0,
        "change_absolute": 0,
        "change_percent": "string"
      },
      "last_24h": {
        "value": 0,
        "change_absolute": 0,
        "change_percent": "string"
      },
      "last_7d": 0
    },
    "takers_24h": 0,
    "takers_7d": 0,
    "buy_sell_24h": {
      "buys": {
        "txns": 0,
        "traders": 0,
        "xrp": "string"
      },
      "sells": {
        "txns": 0,
        "traders": 0,
        "xrp": "string"
      }
    },
    "quality_score": "string"
  }
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

application/json

Not found

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}